Get Started

Check your Payments

This action returns a payment resource with status information for the batch model.

Table - Get single payment resource representation

Resource Template
/customers{id}/batches/{id}/payments/{id}?
fields=<paymentField[,paymentField]>
Http Method GET
Description Returns requested payment representation.
Input
{
}
Output - for successfully accepted and created payments
200 OK 
{
"id":"<paymentId>","partnerReference":"<partner generated reference>", 
"status":"paymentStatus","errorCode":
<"supplied for payments in Rejected or Returned status">,
"createdOn":"<timestamp>","lastUpdatedOn":"<timestamp>",
"updateErrorCode":"<defined_errorCode>",
"updateErrorOn" : "<timestamp>"
"customerId" : "","paymentMethod":"","paymentReference":"",
"amount":"","currencyCode":"","settlementAmount":"",
"settlementCurrencyCode":"","isFixedAmountInSettlementCurrency":"",
"amountReturned":
"<supplied for payment in Returned status>","amountReturnedCurrency":
"<supplied for payment in Returned status>",
"beneficiary":
{
"id":"","versionedOn":"","email":"","type":"","firstName":"","middleName":"",
"lastName":"","phoneNumber":"","cellNumber":"","dateOfBirth":"","gender":"",
"businessName":"","businessRegistrationNumber":"","businessRegistrationCountry":"",
"businessRegistrationStateProv":"","industry":"",
"address": 
{
"line1":"","line2":"","line3":"","city":"","stateOrProv":"","zipOrPostal":"",
"countryCode":""
},
},
"bankAccount":"id":"","versionedOn": "","accountNumber":"", 
"accountType":"",
"bankName":"","bankBranchName":"","bankCode":"","bankBranchCode":"", 
"address": 
{
"line1":"","line2":"","line3":"","city":"","stateOrProv":"","zipOrPostal":"","countryCode"
},
"intermediaryBank": 
{
"bankName":"","bankCode":"","accountNumber":"","bankBranchCode":"", 
"address":
{
"line1":"","line2":"","line3":"","city":"","stateOrProv":"", 
"zipOrPostal": ","countryCode"
},  
}, 
},
"purposeOfPayment":"","instructionForBank":"","instructionCodeForBank":"", 
"remittanceData":
[
{
"ref":""
}
]
"thirdPartyRemitter": 
{
"id":"","versionedOn":"","type":"","businessName":"",
"address": 
{
"line1":"","line2":"","line3":"","city":"","stateOrProv":"","zipOrPostal":"","countryCode":""
},
"email":"","phoneNumber":"","identificationType":"","identification":"","industry":""
} 
}
Output - for not accepted payments. errorCode value will specify validation error code and a field which failed validation
200 OK
{ 
{
“id”:”<paymentId>”,“status”:“NotAccepted”,
"errorCode":"<errorCode>:<failed validation field>"
}
}
Output - in case requested payment was not found
404 Not Found - if a submitted resource location is not found