StatusInquiry
Get Payment Instruction for a Creditor Agent
This endpoint allows inquiry of a submitted payment instruction.
get/creditor-agents/{ica}/payment-acceptances/{instruction_identification}
Request
- Base URLhttps://api.mastercard.com/commercial/payments
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
icastring required
Interbank Card Association ID
instruction_identificationstring required
Unique Identification for each Payment Instruction
Response
Response object of Get Credit transfer information.
Example response
{
"paymentInformation": {
"paymentInformationIdentification": "ZWSeE2gq2qWIyLP3HYeDaSLoTb9r7zKS",
"paymentMethod": "CARD",
"requestedExecutionDate": "2025-02-02",
"debtor": {
"name": "Debtor Company",
"postalAddress": {
"streetName": "2200 Mastercard Blvd",
"postalCode": "63368",
"townName": "O'Fallon",
"countrySubDivision": "MO",
"country": "US"
},
"identification": {
"organisationIdentification": {
"anyBIC": "7OZBBAAX",
"lei": "81G1IF550C4PM62Z6075",
"other": [
{
"identification": "123456789",
"schemeName": {
"code": "TXID"
},
"issuer": "Issuer Name"
}
]
}
}
},
"debtorAccount": {
"identification": {
"other": [
{
"identification": "1234",
"schemeName": {
"code": "AIIN"
},
"issuer": "Issuer Name"
}
]
},
"type": {
"code": "CARD"
},
"currency": "USD",
"name": "Debtor Card"
},
"creditTransferTransactionInformation": {
"paymentIdentification": {
"instructionIdentification": "W4gemK5OLnyEtZbDN6x17ysPn3Ig2WB0",
"endToEndIdentification": "W4gemK5OLnyEtZbDN6x17ysPn3Ig2WB0",
"uetr": "019029c1-0ec6-7ebe-996b-5e0e274b766b"
},
"amount": {
"instructedAmount": {
"currency": "USD",
"amount": 576.83
}
},
"exchangeRateInformation": {
"unitCurrency": "USD",
"exchangeRate": 0.7,
"rateType": "SPOT",
"contractIdentification": "qwjhr-otpr-0012"
},
"chargeBearer": "DEBT",
"creditor": {
"name": "Creditor Name",
"postalAddress": {
"streetName": "2200 Townhall Blvd",
"postalCode": "63368",
"townName": "O'Fallon",
"countrySubDivision": "MO",
"country": "US"
},
"identification": {
"organisationIdentification": {
"anyBIC": "1N62MG41",
"lei": "0562S5G0LCO2W269S657",
"other": [
{
"identification": "matest.creditor6@stp",
"schemeName": {
"code": "PRID"
},
"issuer": "Issuer Name"
}
]
}
}
},
"tax": {
"totalTaxAmount": {
"currency": "USD",
"amount": 10
}
},
"relatedRemittanceInformation": [
{
"remittanceIdentification": "a61R80u9QmLcduhLQG4uogTTRUQIQi4k",
"remittanceLocationDetails": [
{
"method": "URID",
"electronicAddress": "https://www.buyer.com/remittancedetails",
"name": "Creditor Name",
"postalAddress": {
"streetName": "2200 Mastercard Blvd",
"postalCode": "63368",
"townName": "O'Fallon",
"countrySubDivision": "MO",
"country": "US"
}
}
]
}
],
"remittanceInformation": {
"unstructured": [
"email: testcreditor@hotmail.com",
"URL: https://exampleinvoice.com/GLCode:200"
],
"structured": [
{
"referredDocumentInformation": [
{
"type": {
"code": "CINV"
},
"number": "AB7894565235",
"relatedDate": [
{
"type": {
"code": "PADD"
},
"date": "2025-12-24"
}
],
"lineDetails": [
{
"identification": [
{
"type": {
"code": "MDNB",
"issuer": "eVCUtkC_cF0tQcp7fbLzbJRass4k"
},
"number": "Mi18v1ddVoaNIHNOh",
"relatedDate": "2025-06-24"
}
],
"description": "line detail identification code",
"amount": {
"remittanceAmountandType": [
{
"type": {
"code": "DUPA"
},
"currency": "USD",
"amount": 210.05
}
],
"adjustmentAmountAndReason": [
{
"currency": "USD",
"amount": 10,
"creditDebitIndicator": "CRDT",
"reason": "DAMAGED_GOODS",
"additionalInformation": "Damaged Goods"
}
]
}
}
]
}
],
"referredDocumentAmount": {
"remittanceAmountandType": [
{
"type": {
"code": "REMI"
},
"currency": "USD",
"amount": 200.05
}
],
"adjustmentAmountAndReason": [
{
"currency": "USD",
"amount": 10,
"creditDebitIndicator": "DBIT",
"reason": "DAMAGED_GOODS",
"additionalInformation": "Damaged Goods"
}
]
},
"creditorReferenceInformation": {
"type": {
"code": "DISP",
"issuer": "Issuer Name"
},
"reference": "RF18539007547034"
},
"invoicer": {
"name": "Invoicer Name",
"postalAddress": {
"streetName": "2200 Mastercard Blvd",
"postalCode": "63368",
"townName": "O'Fallon",
"countrySubDivision": "MO",
"country": "US"
},
"identification": {
"organisationIdentification": {
"anyBIC": "88B0GWVU",
"lei": "064QB7W3N1S0AW0QJG94",
"other": [
{
"identification": "pTL80r",
"schemeName": {
"code": "CUST"
},
"issuer": "Issuer Name"
}
]
}
}
},
"invoicee": {
"name": "Invoicee Name",
"postalAddress": {
"streetName": "2200 Mastercard Blvd",
"postalCode": "63368",
"townName": "O'Fallon",
"countrySubDivision": "MO",
"country": "US"
},
"identification": {
"organisationIdentification": {
"anyBIC": "88B0GWVU",
"lei": "064QB7W3N1S0AW0QJG94",
"other": [
{
"identification": "pTL80r",
"schemeName": {
"code": "CUST"
},
"issuer": "Issuer Name"
}
]
}
}
},
"additionalRemittanceInformation": [
"email: testcreditor@hotmail.com",
"URL: https://exampleinvoice.com/GLCode:200"
]
}
]
},
"supplementaryData": {
"envelope": {
"cardDetails": {
"pan": "5149612222222220",
"expiryDate": "2025-11",
"cvv": "100",
"cardholderName": "John Doe",
"currency": "USD",
"cardholderAddress": {
"streetName": "2200 Mastercard Blvd",
"postalCode": "63368",
"townName": "O'Fallon",
"countrySubDivision": "MO",
"country": "US"
},
"additionalCardDetails": {
"validFrom": "2017-07-21T17:32:28Z",
"validTo": "2017-07-21T17:32:28Z"
}
},
"chargesInformation": [
{
"currency": "USD",
"type": {
"code": "CARD_FEE"
},
"amount": 256.78
}
]
}
}
}
},
"paymentStatus": {
"status": "ACCEPTED",
"statusReasonInformation": [
{
"description": "This transaction is in transit.",
"reasonCode": "MIN_INSTRUCTED_AMT_WARNING"
}
]
},
"settlementTimeIndication": {
"creditDateTime": "2025-08-17T17:37:23.230Z",
"debitDateTime": "2025-08-17T17:37:23.231Z"
},
"transactionIdentification": {
"approvalCode": "214636",
"retrievalReferenceNumber": "54946469666",
"transactionReference": "4494944994949",
"transactionDateTime": "2025-02-13T11:32:28.028Z"
},
"createdDate": "2025-02-13T11:32:28.548Z",
"updatedDate": "2025-02-13T11:32:28.684Z"
}Changes
No recorded changes to this operation across all 1 revision of this API.