- 18 Sep 2024
- 14 Minutes to read
- Print
- DarkLight
Making domestic payments with Faster Payments (pacs.008 and pacs.002).
- Updated on 18 Sep 2024
- 14 Minutes to read
- Print
- DarkLight
This tutorial describes how you can make domestic Faster Payments (FP) payments with the Payments Hub API.
For this tutorial, consider a scenario where a customer wants to make an FP payment - send money from their UK bank account to another UK bank account. If the customer has enough funds in their account, the Payments Hub API can be used to transfer the money to the other account. This tutorial describes, in 2 separate sections, how you can first submit the FP payment using the ISO pacs.008 message and then receive a notification whenever the payment status changes, allowing you to retrieve its status using the ISO pacs.002 message.
Note
The instructions in this tutorial apply to the sandbox environment.
Prerequisites
Before obtaining the access token, make sure you have a public-private key pair that you can use to sign JWT Bearer tokens.
Click here to email your public key, along with the kid and iss claim values you will use in your JWT Bearer tokens.
Note
The public key must be created with RSA and sent in PEM format, without password encryption, and must have a length of at least 2048 bits. If these criteria are not met, the token will be rejected.
If you don't have a public-private key pair yet, you can use a predefined JWT Bearer token in the sandbox with no need to create or sign your own tokens for authentication:
eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6InByb1BheW1lbnRzSHViU2IifQ.eyJzdWIiOiJxTWtaOTBxb0hBTjVJbkE2V2xNYVZBaE41dDhBQWVPeCIsImlzcyI6IlNhbnRhbmRlciIsImlhdCI6MTcxMDg0MjgwNCwibmJmIjoxNzEwODQyODA0LCJleHAiOjE3NDIzNzg4MDQsImp0aSI6ImM3YWY0Yzg0LTRkYzQtNDM2Mi05OTA2LWM5ZTg5N2YyNzUzOCJ9.LOaGmVUnQ6I0HYUQWA1y2vUhREaJrAasAxDlqAnxKbEYGmjP6AKeIViLdkBVVPTUWRETxmnlU6fBQRYU0BN8NEJ9dd_uJ20uiPGWp1ieTFvee27LbqqqS-4AbwD_oJluBUzb77cx4P_1o35gFskcFjbzdl5ert4xJvpbXNOQYa0C7f4YQ6wMLjCGkbdhimwRxeOEGVdYiRoVEizkPpNgUZi_H3o58gATIJ4rSSWqLmKvy9aBlK_YAT947klkJI-ej22KU8qgLCInBbBGdoW9gjg8Zpmizs7Xc7eAvNm7QRiAzd1NT6dgX3hAYDJz2m2dnZYS6zE_UPWOi5cbAyQggw
In the sandbox environment, you can use a predefined test SCA JWT Bearer token:
eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6InByb1BheW1lbnRzSHViU2IifQ.eyJoZCI6IjdoYldtZGcyNE5LQlI4c1VDK2EwamVQdmtXOG1hY0RoZnRXWGViYkRQd0k9Iiwibm9uY2UiOiIzNzZmYjMwNDJjN2YyMWNmY2M0ZSIsImFsZyI6IlNIQTI1NiIsImlzcyI6IlNhbnRhbmRlciIsImlhdCI6MTcxMjA1MTQwNiwibmJmIjoxNzEyMDUxNDA2LCJleHAiOjE3NDM1ODc0MDYsImp0aSI6IjY0ZGYyYWRmLWY2MmEtNDgxYi1iNTNkLWVhYzdiNTQ0NGFhZCJ9.KZDlWYSBHiOgRWQk6DrYy-9duMRrRCWydOVV2fssbEeq5Y4nYd9s0K9B-2qZS9qkqIAvWiKSeWf9rfz0BlvmeWQ_VI48XV2yWRmAj3RueOIV6VU57kuBEFIULgdQow5RFoPPPhOqMlx8IHqQf9axNhZYZjzAJ7Ko05bfNM1RLU3aor18zmHr0Yxnv6_4XyWwE1Nd92zDN6YpRDYNYvZol1MZahIYov8FQZetvOnf3Rj_qZZ1QkCkIhcVfTeJH5J7-_5w6RJZDjBsQnksWenlDwU7nGEzp4woO5TcfuDp3JeCQkYW2dHCJjYgBOs3ghB7-w8CE-vqONCWly62Jug0Sg
Authenticate to get an access token
The Payments Hub API endpoints are protected with OAUTH 2.0 JWT Bearer grant. To use the API, you must create a JWT Bearer token and use it to get an access token:
To create a JWT Bearer token, see the Appendix in Authentication guide . For a predefined token that you can use in the sandbox for testing purposes, see the Prerequisites in Authentication guide .
For detailed instructions on how to get the access token, see Authentication guide .
Submit the payment
This section describes how to submit a payment via a pacs.008 HTTP request to the Payments Hub API. It also illustrates a successful response.
Request
Create and send a request using the following operation:
url
POST https://sandbox.api.pagonxt.com/payments/pacs008/v10
Headers
The request must contain the headers shown in the following table.
Table: Submit the payment - Required request headers.
Header name | Description | Required/Optional | Values |
---|---|---|---|
Authorization | Authorization security header | Required | Bearer <Access token> |
X-Client-Id | Client ID | Required | <Client ID> |
Content-Type | Format of the request body | Required | application/json |
sca-token |
| Required | <SCA token> |
Accept | Format of the response body | Required | application/json |
Request body
The request must include a JSON payload object in the request body. The JSON payload is a pacs.008 ISO message with the fitoFICstmrCdtTrf root element, and it contains the request details for submitting a payment.
The following table only provides information about some especially important fields. For details on all the required and optional message fields, see Message field definition for pacs.008 .
Table: Submit the payment - Relevant request body elements.
Message field | Description | Data type | Required/Optional |
---|---|---|---|
grpHdr.msgId | Message ID, which must uniquely identify each request you send. This ID is used internally for idempotency of the API. | String | Required |
grpHdr.creDtTm | Date and time of the payment request | String | Required |
grpHdr.nbOfTxs | Number of transactions within the message. Value: 1 | Number | Required |
grpHdr.ttlIntrBkSttlmAmt | Data structure containing the payment currency and the amount for the total interbank settlement. The currency must be GBP and the amount must be a positive value. If these fields are used, the amount must be equal to the sum of all the transactions in the message. | Object | Optional |
grpHdr.sttlmInf.sttlmMtd | Settlement method. Value: CLRG | String | Required |
cdtTrfTxInf.pmtId.endToEndId | End-to-end ID, which can be used to track the transaction between payment systems | String | Required |
cdtTrfTxInf.pmtId.txId | Transaction ID, which must uniquely identify each transaction within the message | String | Required |
cdtTrfTxInf.pmtTpInf.svcLvl.prtry | Payment scheme type. Value: FP | String | Optional |
cdtTrfTxInf.pmtTpInf.lclInstrm.prtry | Faster Payments Scheme (FPS) processing code | String | Optional |
cdtTrfTxInf.pmtTpInf.ctgyPurp.prtry | Payment channel | String | Optional |
cdtTrfTxInf.intrBkSttlmAmt | Data structure containing the payment currency and the amount to be transferred. The currency must be GBP and the amount must be a positive value. | Object | Required |
cdtTrfTxInf.chrgBr | Charge bearer type. The possible values are:
| String | Required |
cdtTrfTxInf ► .dbtr ► .dbtrAcct ► .dbtrAgt | Data structures containing the details for the debtor, the debtor’s account, and the debtor agent | Object | Required |
cdtTrfTxInf ► .cdtrAgt ► .cdtr ► .cdtrAcct | Data structures containing the details for the creditor agent, the creditor, and the creditor’s account | Object | Required |
cdtTrfTxInf.rmtInf | Data structure containing remittance details | Object | Optional |
Example request body:
{
"fitoFICstmrCdtTrf": {
"grpHdr": {
"msgId": "599302431952709700000000000",
"creDtTm": "2023-11-17T04:30:31.111Z",
"nbOfTxs": "1",
"sttlmInf": {
"sttlmMtd": "CLRG"
}
},
"cdtTrfTxInf": [
{
"pmtId": {
"endToEndId": "599302431952709700000000000",
"txId": "599302431952709700000000000",
"uetr": "14973c74-b91a-42fd-9b39-6435a7d6e1f4"
},
"pmtTpInf": {
"svcLvl": [
{
"prtry": "FP"
}
],
"lclInstrm": {
"prtry": "10"
}
},
"intrBkSttlmAmt": {
"value": 5.18,
"ccy": "GBP"
},
"chrgBr": "SLEV",
"dbtr": {
"nm": "MISS LARA NOBLES",
"pstlAdr": {
"adrLine": [
"119",
"FUNNY ROAD",
"BOURNEMOUTH",
"BH8 10QT",
"GBR"
]
}
},
"dbtrAcct": {
"id": {
"othr": {
"id": "00000000"
}
},
"nm": "MISS LARA NOBLES"
},
"dbtrAgt": {
"finInstnId": {
"clrSysMmbId": {
"mmbId": "000000"
}
}
},
"cdtrAgt": {
"finInstnId": {
"clrSysMmbId": {
"mmbId": "000000"
}
}
},
"cdtr": {
"nm": "Jessica Gale",
"pstlAdr": {
"adrLine": [
"17",
"Very Bright Street",
"Golden Sand road",
"Birmingham",
"C1 1BN",
"UK"
]
}
},
"cdtrAcct": {
"id": {
"othr": {
"id": "00000000"
}
},
"nm": "Jessica Gale"
},
"rmtInf": {
"ustrd": [
"debtor-reference1"
],
"strd": [
{
"cdtrRefInf": {
"ref": "creditor-ref1"
},
"addtlRmtInf": [
"P11607098610056"
]
}
]
}
}
]
}
}
Request example
The following example illustrates the request using raw HTTP code:
POST /payments/pacs008/v10 HTTP/1.1
Host: sandbox.api.pagonxt.com
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
X-Client-Id: YOUR_CLIENT_ID
sca-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6InByb1BheW1lbnRzSHViU2IifQ.eyJoZCI6IjdoYldtZGcyNE5LQlI4c1VDK2EwamVQdmtXOG1hY0RoZnRXWGViYkRQd0k9Iiwibm9uY2UiOiIzNzZmYjMwNDJjN2YyMWNmY2M0ZSIsImFsZyI6IlNIQTI1NiIsImlzcyI6IlNhbnRhbmRlciIsImlhdCI6MTcxMjA1MTQwNiwibmJmIjoxNzEyMDUxNDA2LCJleHAiOjE3NDM1ODc0MDYsImp0aSI6IjY0ZGYyYWRmLWY2MmEtNDgxYi1iNTNkLWVhYzdiNTQ0NGFhZCJ9.KZDlWYSBHiOgRWQk6DrYy-9duMRrRCWydOVV2fssbEeq5Y4nYd9s0K9B-2qZS9qkqIAvWiKSeWf9rfz0BlvmeWQ_VI48XV2yWRmAj3RueOIV6VU57kuBEFIULgdQow5RFoPPPhOqMlx8IHqQf9axNhZYZjzAJ7Ko05bfNM1RLU3aor18zmHr0Yxnv6_4XyWwE1Nd92zDN6YpRDYNYvZol1MZahIYov8FQZetvOnf3Rj_qZZ1QkCkIhcVfTeJH5J7-_5w6RJZDjBsQnksWenlDwU7nGEzp4woO5TcfuDp3JeCQkYW2dHCJjYgBOs3ghB7-w8CE-vqONCWly62Jug0Sg
Content-Length: 3313
{
"fitoFICstmrCdtTrf": {
"grpHdr": {
"msgId": "599302431952709700000000000",
"creDtTm": "2023-11-17T04:30:31.111Z",
"nbOfTxs": "1",
"sttlmInf": {
"sttlmMtd": "CLRG"
}
},
"cdtTrfTxInf": [
{
"pmtId": {
"endToEndId": "599302431952709700000000000",
"txId": "599302431952709700000000000",
"uetr": "14973c74-b91a-42fd-9b39-6435a7d6e1f4"
},
"pmtTpInf": {
"svcLvl": [
{
"prtry": "FP"
}
],
"lclInstrm": {
"prtry": "10"
}
},
"intrBkSttlmAmt": {
"value": 5.18,
"ccy": "GBP"
},
"chrgBr": "SLEV",
"dbtr": {
"nm": "MISS LARA NOBLES",
"pstlAdr": {
"adrLine": [
"119",
"FUNNY ROAD",
"BOURNEMOUTH",
"BH8 10QT",
"GBR"
]
}
},
"dbtrAcct": {
"id": {
"othr": {
"id": "00000000"
}
},
"nm": "MISS LARA NOBLES"
},
"dbtrAgt": {
"finInstnId": {
"clrSysMmbId": {
"mmbId": "000000"
}
}
},
"cdtrAgt": {
"finInstnId": {
"clrSysMmbId": {
"mmbId": "000000"
}
}
},
"cdtr": {
"nm": "Jessica Gale",
"pstlAdr": {
"adrLine": [
"17",
"Very Bright Street",
"Golden Sand road",
"Birmingham",
"C1 1BN",
"UK"
]
}
},
"cdtrAcct": {
"id": {
"othr": {
"id": "00000000"
}
},
"nm": "Jessica Gale"
},
"rmtInf": {
"ustrd": [
"debtor-reference1"
],
"strd": [
{
"cdtrRefInf": {
"ref": "creditor-ref1"
},
"addtlRmtInf": [
"P11607098610056"
]
}
]
}
}
]
}
}
Response
If the request is valid, you receive an HTTP 201 Created response, which means that the payment was successfully submitted. In addition, the response body returns the data JSON object, which contains details of the submitted payment. If the request is submitted again with the same message ID, you receive an HTTP 200 OK response. For further details of HTTP response codes and instructions on how to handle errors, see HTTP codes and request error handling. The following table shows the response body elements that are relevant for the current use case. For details on all the response body elements, see Message field definition for pacs.008 .
Extract the value of the paymentsHubId key, as you'll need it in the next section.
Table: Submit the payment - Relevant response body elements.
Element | Description | Data type |
---|---|---|
paymentsHubId | Payments Hub ID, which uniquely identifies your payment request in Payments Hub. You can use it to verify the status of the requested payment. | String |
paymentsId | Message ID you defined in the request as the grpHdr.msgId field value | String |
status | Current status of the payment. Since Payments Hub stores all requests for a while before performing the transaction settlement, this value is returned as PENDING. | String |
Example response body:
{
"data": {
"paymentsHubId": "8b8464bf-9a53-3d3e-916e-3793f84c4ae7",
"paymentId": "MsgId-44458394999944",
"status": "PENDING",
"creationDateTime": "2022-04-21T07:21:27.243844"
}
}
3. Check the payment status
This section describes how to check the payment status after submitting a payment, via a pacs.002 HTTP request to the Payments Hub API. To send this request, you need to provide the Payments Hub ID that you received in the response to the pacs.008 request sent in the previous section, or that was provided in the notification. For information, see Notifications . This section also illustrates a successful response.
Note
Notifications are not used in the sandbox environment.
Request
Create and send a request using the following operation:
GET https://sandbox.api.pagonxt.com/payments/pacs002/v12/{paymentsHubId}
Headers
The request must contain the headers shown in the following table.
Table: Check the payment status - Required request headers.
Header name | Description | Required/Optional | Values |
---|---|---|---|
Authorization | Authorization security header | Required | Bearer <Access token> |
X-Client-Id | Client ID | Required | <Client ID> |
Accept | Format of the response body | Required | application/json |
Parameters
The request must contain the path parameters shown in the following table.
Table: Check the payment status - Request parameters.
Parameter type | Parameter name | Description | Data format | Required/Optional |
---|---|---|---|---|
Path | paymentsHubId | Payments Hub ID related to the payment whose status you want. This is the value you received in the response to your payment request. | String | Required |
Request example
The following example illustrates the request using raw HTTP code:
GET /payments/pacs002/v12/YOUR_PAYMENTS_HUB_ID HTTP/1.1
Host: sandbox.api.pagonxt.com
Authorization: Bearer YOUR_ACCESS_TOKEN
X-Client-Id: YOUR_CLIENT_ID
Response
If the request is valid, you receive an HTTP 200 OK response, which means that the payment status was successfully retrieved. For further details of HTTP response codes and instructions on how to handle errors, see HTTP codes and request error handling .
In addition to the response code, the response body returns the fitoFIPmtStsRpt JSON object, which contains a pacs.002 ISO message.
The following table shows the response body elements that are relevant for the current use case. For details on all the response body elements, see Message field definition for pacs.002 .
Extract the value of the txInfAndSts.txSts key to see the current status of the payment.
Table: Check the payment status - Relevant response body elements.
Element | Description | Data type |
---|---|---|
txInfAndSts.orgnlGrpInf.orgnlMsdId | Message ID you defined in the payment request message as the grpHdr.msgId field value | String |
txInfAndSts.orgnlEndToEndId | End-to-end ID you defined in the payment request message as the cdtTrfTxInf.pmtId.endToEndId field value | String |
txInfAndSts.orgnlTxId | Transaction ID you defined in the payment request message as the cdtTrfTxInf.pmtId.txId field value | String |
txInfAndSts.txSts | Current status you wanted to check. The possible status values are based on the ISO standard. For example: ACCC (accepted) or RJTC (rejected) For more information on the status and the related codes that provide the reason for the payment acceptance or rejection, see Payment status and codes. | String |
Example response body:
{
"fitoFIPmtStsRpt": {
"grpHdr": {
"msgId": "90f7bdb5b2814aa6a5e2ec20cb38030b",
"creDtTm": "2023-11-17T15:02:58.662Z"
},
"txInfAndSts": [
{
"orgnlGrpInf": {
"orgnlMsgId": "599302431952709700000000000",
"orgnlMsgNmId": "pacs.008.001.10"
},
"orgnlEndToEndId": "599302431952709700000000000",
"orgnlTxId": "599302431952709700000000000",
"txSts": "ACCC",
"stsRsnInf": [
{
"rsn": {
"cd": "G000"
},
"addtlInf": [
"0000",
"Accepted without qualification",
"FPID:HUBXEACE748EF18F891020231117826090222",
null
]
}
],
"accptncDtTm": "2023-11-17T04:30:31.521Z ",
"orgnlTxRef": {
"intrBkSttlmDt": "2023-11-17",
"sttlmInf": {
"sttlmMtd": "CLRG",
"clrSys": {
"prtry": "001"
}
},
"pmtTpInf": {
"svcLvl": [
{
"prtry": "FP"
}
]
},
"rmtInf": {
"strd": [
{
"addtlRmtInf": [
"HUBXEACE748EF18F891020231117826090222"
]
}
]
}
}
}
]
}
}