Get Started

Example of GET Payments

Table - Examples - GET Payments for Batch

Request:
GET /customers/MPCTEST1/batches/B3/payments
GET /customers/MPCTEST1/batches/B3/payments?status=Created
Response:
200: OK
{
"payments":
[
{
"id":"P1","status":"Created","partnerReference":"B3 P1",
"createdOn":"2016-07-27T23:16:34Z",
"lastUpdatedOn":"2016-07-27T23:16:34Z"
},
{
"id":"P2","status":"Created","partnerReference":"B3 P2",
"createdOn":"2016-07-27T23:16:34Z",
"lastUpdatedOn":"2016-07-27T23:16:34Z"
}
]
}
Request:
GET /customers/MPCTEST1/batches/B3/payments?ids=1,p1,P1
Response:
200: OK
{
"payments":
[
{
"id":"P1","status":"Created",
"partnerReference":"B3 P1","createdOn":"2016-07-27T23:16:34Z",
"lastUpdatedOn":"2016-07-27T23:16:34Z"
},
{
"id":"1","errorCode":"1101"
},
{
"id":"p1","errorCode":"1101"
}
]
}
Request:
GET /customers/MPCTEST1/batches/B3/payments/P1
Response:
{
"id":"P1","customerId":"MP_DIPQA","status":"Created",
"partnerReference":"B3 P1","createdOn":"2016-07-27T23:16:34Z",
"lastUpdatedOn":"2016-07-27T23:16:34Z","paymentMethod":"Wire",
"amount":250,"currencyCode":"USD","settlementCurrencyCode":"USD",
"isFixedAmountInSettlementCurrency":false,
"beneficiary":
{
"id":"D5QR0","versionedOn":"2015-10-07T12:36:31Z",
"email":"sve2qg0fkr@ah3su.com","type":"Individual","taxId":"",
"firstName":"John","lastName":"Doe","phoneNumber":"+442-176-1638",
"cellNumber":"+572-774-4319","dateOfBirth":"1950-05-21",
"gender":"Male","businessName":"",
"businessRegistrationNumber":"",
"businessRegistrationCountry":"",
"businessRegistrationStateProv":"","industry":"",
"address":{"line1":"Ap #418-1968 Mauris Av.","line2":"","line3":"",
"city":"Grand Falls","stateOrProv":"CA","zipOrPostal":"12345",
"countryCode":"US"
}
},
"bankAccount":
{
"id":"RZIVCYP7ZH","versionedOn":"2015-06-17T12:36:31Z",
"accountNumber":"80722","accountType":"SAVINGS",
"bankName":"Humungous Bank Inc.",
"bankBranchName":"24618","bankCode":"BOFAHKHXXXX",
"bankBranchCode":"96125","address":
{
"line1":"2375 Velit. Rd.","line2":"",
"line3":"","city":"Strongoli","stateOrProv":"CA",
"zipOrPostal":"12345","countryCode":"US"
},
"intermediaryBank":
{
"bankName":"Humungous Velit. Rd.","line2":"",
"line3":"","city":"Strongoli","stateOrProv":"CA",
"zipOrPostal":"12345","countryCode":"US"
},
"intermediaryBank":
{
"bankName":"Humungous Bank","bankCode":"BOFAHKHXXXX",
"accountNumber":"81934","address":
{
"line1":"2375 Velit. Rd.","line2":"","line3":"",
"city":"Strongoli","stateOrProv":"CA",
"zipOrPostal":"12345","countryCode":"US"
}
}
},
"purposeOfPayment":"GPP0XAF4HL","instructionForBank":"3GT0JYDGXS",
"instructionCodeForBank":"7GLC6E3MDD"
}