Step 4 - Get the payment status
As you are aware, you can receive payments through webhooks too, so making an API call to obtain the same data isn't mandatory. However, it is highly recommended to implement both methods to ensure there is a fallback option should one of them fail.
API Call
There are two methods to retrieve the transaction status through an API call: by using the "Id" provided by the Remitee at the time of payment creation, or by using the "referenceId" generated by yourself.
Authorizations
Path parameters
idstring · uuidRequired
Identifier.
Responses
200
Returns the payment matching the Id
application/json
401
Unauthorized
403
Forbidden
404
If the id don't exists
get
GET /api/Payments/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "C2C",
"createdAt": "2025-06-27T02:59:49.575Z",
"quoteId": "123e4567-e89b-12d3-a456-426614174000",
"payerId": 1,
"debitAmount": 1,
"debitCurrency": "text",
"fxRate": 1,
"amount": 1,
"currency": "text",
"collectMethod": "CASH_PICKUP",
"referenceId": "text",
"userInfo": {
"Dbtr": {
"StrdNm": {
"FirstNm": "text",
"LastNm": "text"
},
"PstlAdr": {
"Ctry": "text",
"CtrySubDvsn": "text",
"TwnNm": "text",
"AdrLine": "text",
"PstCd": "text"
},
"Id": {
"PrvtId": {
"Othr": {
"Id": "text",
"Issr": "text",
"SchmeNm": {
"Cd": "ARNU",
"Prtry": "text"
}
},
"DtAndPlcOfBirth": {
"BirthDt": "text",
"CtryOfBirth": "text"
}
},
"OrgId": {
"Othr": {
"Id": "text",
"Issr": "text",
"SchmeNm": {
"Cd": "ARNU",
"Prtry": "text"
}
}
}
},
"CtctDtls": {
"EmailAdr": "text",
"PhneNb": "text",
"Othr": "text"
},
"Nm": "text"
},
"Cdtr": {
"StrdNm": {
"FirstNm": "text",
"LastNm": "text"
},
"PstlAdr": {
"Ctry": "text",
"CtrySubDvsn": "text",
"TwnNm": "text",
"AdrLine": "text",
"PstCd": "text"
},
"Id": {
"PrvtId": {
"Othr": {
"Id": "text",
"Issr": "text",
"SchmeNm": {
"Cd": "ARNU",
"Prtry": "text"
}
},
"DtAndPlcOfBirth": {
"BirthDt": "text",
"CtryOfBirth": "text"
}
}
},
"CtctDtls": {
"EmailAdr": "text",
"PhneNb": "text",
"Othr": "text"
}
},
"CdtrAgt": {
"FinInstnId": {
"BICFI": "text"
},
"BrnchId": {
"Id": "text"
}
},
"CdtrAcct": {
"Id": {
"Othr": {
"Id": "text"
}
},
"Tp": {
"Cd": "SVGS"
}
},
"Purp": {
"Prtry": "FAMILY_SUPPORT"
},
"InstForCdtrAgt": {
"InstrInf": "text"
},
"PmtId": {
"TxId": "text"
}
},
"status": "CREATED",
"subState": "FORWARDED",
"lockDeclineReason": "text",
"lockDeclineDescription": "text",
"reverseReason": "text",
"withholdingPercentages": {
"vatWithholdingPercentage": 1,
"incomeWithholdingPercentage": 1,
"vatWithholdingReceiptUrl": "text",
"incomeWithholdingReceiptUrl": "text"
},
"payerPaymentCode": "text",
"transactionId": 1,
"lockedAt": "2025-06-27T02:59:49.575Z",
"lockDeclinedAt": "2025-06-27T02:59:49.575Z",
"expiredAt": "2025-06-27T02:59:49.575Z",
"settledAt": "2025-06-27T02:59:49.575Z",
"forwardedAt": "2025-06-27T02:59:49.575Z",
"awaitingCollectionSince": "2025-06-27T02:59:49.575Z",
"completedAt": "2025-06-27T02:59:49.575Z",
"reversedAt": "2025-06-27T02:59:49.575Z",
"liquidityError": true,
"invoiceUrl": "text"
}Authorizations
Path parameters
referencestringRequired
reference.
Responses
200
Returns the payment matching the reference
application/json
401
Unauthorized
403
Forbidden
404
If the reference don't exists
get
GET /api/Payments/Find/{reference} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "C2C",
"createdAt": "2025-06-27T02:59:49.575Z",
"quoteId": "123e4567-e89b-12d3-a456-426614174000",
"payerId": 1,
"debitAmount": 1,
"debitCurrency": "text",
"fxRate": 1,
"amount": 1,
"currency": "text",
"collectMethod": "CASH_PICKUP",
"referenceId": "text",
"userInfo": {
"Dbtr": {
"StrdNm": {
"FirstNm": "text",
"LastNm": "text"
},
"PstlAdr": {
"Ctry": "text",
"CtrySubDvsn": "text",
"TwnNm": "text",
"AdrLine": "text",
"PstCd": "text"
},
"Id": {
"PrvtId": {
"Othr": {
"Id": "text",
"Issr": "text",
"SchmeNm": {
"Cd": "ARNU",
"Prtry": "text"
}
},
"DtAndPlcOfBirth": {
"BirthDt": "text",
"CtryOfBirth": "text"
}
},
"OrgId": {
"Othr": {
"Id": "text",
"Issr": "text",
"SchmeNm": {
"Cd": "ARNU",
"Prtry": "text"
}
}
}
},
"CtctDtls": {
"EmailAdr": "text",
"PhneNb": "text",
"Othr": "text"
},
"Nm": "text"
},
"Cdtr": {
"StrdNm": {
"FirstNm": "text",
"LastNm": "text"
},
"PstlAdr": {
"Ctry": "text",
"CtrySubDvsn": "text",
"TwnNm": "text",
"AdrLine": "text",
"PstCd": "text"
},
"Id": {
"PrvtId": {
"Othr": {
"Id": "text",
"Issr": "text",
"SchmeNm": {
"Cd": "ARNU",
"Prtry": "text"
}
},
"DtAndPlcOfBirth": {
"BirthDt": "text",
"CtryOfBirth": "text"
}
}
},
"CtctDtls": {
"EmailAdr": "text",
"PhneNb": "text",
"Othr": "text"
}
},
"CdtrAgt": {
"FinInstnId": {
"BICFI": "text"
},
"BrnchId": {
"Id": "text"
}
},
"CdtrAcct": {
"Id": {
"Othr": {
"Id": "text"
}
},
"Tp": {
"Cd": "SVGS"
}
},
"Purp": {
"Prtry": "FAMILY_SUPPORT"
},
"InstForCdtrAgt": {
"InstrInf": "text"
},
"PmtId": {
"TxId": "text"
}
},
"status": "CREATED",
"subState": "FORWARDED",
"lockDeclineReason": "text",
"lockDeclineDescription": "text",
"reverseReason": "text",
"withholdingPercentages": {
"vatWithholdingPercentage": 1,
"incomeWithholdingPercentage": 1,
"vatWithholdingReceiptUrl": "text",
"incomeWithholdingReceiptUrl": "text"
},
"payerPaymentCode": "text",
"transactionId": 1,
"lockedAt": "2025-06-27T02:59:49.575Z",
"lockDeclinedAt": "2025-06-27T02:59:49.575Z",
"expiredAt": "2025-06-27T02:59:49.575Z",
"settledAt": "2025-06-27T02:59:49.575Z",
"forwardedAt": "2025-06-27T02:59:49.575Z",
"awaitingCollectionSince": "2025-06-27T02:59:49.575Z",
"completedAt": "2025-06-27T02:59:49.575Z",
"reversedAt": "2025-06-27T02:59:49.575Z",
"liquidityError": true,
"invoiceUrl": "text"
}Last updated