- 06 May 2024
- 1 Minute to read
- Print
- DarkLight
Determining which API operation you need
- Updated on 06 May 2024
- 1 Minute to read
- Print
- DarkLight
The following table shows which ISO message and payment scheme combinations are available for different payment actions, and which API operations you can use for each.
Table: API operations matching different payment actions, ISO messages, and payment schemes.
ISO message | Payment scheme | API operation | Notes |
---|---|---|---|
Making a payment | |||
pain.001 | FP BACS | POST /pain001/v03 | Related documentation:
|
pacs.008 | FP CHAPS SWIFT SCT SCT Inst | POST /pacs008/v08 | Related documentation: |
Retrieving payment info | |||
pain.001 | FP | GET /pain001/v03/{phub_id} | Related documentation: |
pacs.003 | BACS | GET /pacs003/v07/{phub_id} |
|
pacs.008 | FP CHAPS SWIFT SCT SCT Inst | GET /pacs008/v08/{phub_id} | Related documentation: |
Returning a payment | |||
pacs.004 | FP SCT SCT Inst | POST /pacs004/v09 | Related documentation: |
Retrieving payment return info | |||
pacs.004 | FP SCT SCT Inst | GET /pacs004/v09/{phub_id} | Related documentation: |
Retrieving payment status | |||
pain.002 | FP BACS | GET /pain002/v03/{phub_id} |
|
pacs.002 | FP CHAPS SWIFT BACS SCT SCT Inst TARGET2 | GET /pacs002/v10/{phub_id} | Related documentation:
|
Refunding a payment | |||
pacs.007 | FP SCT | POST /pacs007/v08 | Related documentation: |
Retrieving payment refund info | |||
pacs.007 | FP SCT | GET /pacs007/v08/{phub_id} | Related documentation: |
Cancelling a payment | |||
camt.056 | SCT SCT Inst | POST /camt056/v08 | Related documentation: |
Retrieving payment cancellation info | |||
camt.056 | SCT SCT Inst | GET /camt056/v08/{phub_id} | Related documentation: |
Retrieving payment cancellation status | |||
camt.029 | SCT SCT Inst | GET /camt029/v09/{phub_id} | Related documentation: |
If you want to both make payments and retrieve payment statuses, use one of the following combinations:
pain.001 to make a payment and pain.002 to retrieve its status.
pacs.008 to make a payment and pacs.002 to retrieve its status.