Determining which API operation you need

Updated on 06 May 2024
1 Minute to read

Print
Share
Dark
Light

Article Summary

Share feedback

Thanks for sharing your feedback!

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 POST /pain001/v09	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling Note BACS is supported for Credit Transfers (CT) only.
pacs.008	FP CHAPS SWIFT SCT SCT Inst	POST /pacs008/v08	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling
Retrieving payment info
pain.001	FP	GET /pain001/v03/{phub_id} GET /pain001/v09/{phub_id}	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling
pacs.003	BACS	GET /pacs003/v07/{phub_id}	Note BACS is supported for Direct Debits (DD) only.
pacs.008	FP CHAPS SWIFT SCT SCT Inst	GET /pacs008/v08/{phub_id}	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling
Returning a payment
pacs.004	FP SCT SCT Inst	POST /pacs004/v09	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling
Retrieving payment return info
pacs.004	FP SCT SCT Inst	GET /pacs004/v09/{phub_id}	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling
Retrieving payment status
pain.002	FP BACS	GET /pain002/v03/{phub_id}	Note BACS is supported for CT only.
pacs.002	FP CHAPS SWIFT BACS SCT SCT Inst TARGET2	GET /pacs002/v10/{phub_id}	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling Note BACS is supported for DD only. When enabled, notifications inform you of payment status changes so you can then send a pacs.002 request to retrieve the full status.
Refunding a payment
pacs.007	FP SCT	POST /pacs007/v08	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling
Retrieving payment refund info
pacs.007	FP SCT	GET /pacs007/v08/{phub_id}	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling
Cancelling a payment
camt.056	SCT SCT Inst	POST /camt056/v08	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling
Retrieving payment cancellation info
camt.056	SCT SCT Inst	GET /camt056/v08/{phub_id}	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling
Retrieving payment cancellation status
camt.029	SCT SCT Inst	GET /camt029/v09/{phub_id}	Related documentation: Tutorials Message field definition Postman collection HTTP codes and request error handling

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.

Was this article helpful?

What's Next

Security