--- title: "Get Payment Instruction for a Creditor Agent" method: GET path: "/creditor-agents/{ica}/payment-acceptances/{instruction_identification}" tags: ["StatusInquiry"] --- # Get Payment Instruction for a Creditor Agent `GET /creditor-agents/{ica}/payment-acceptances/{instruction_identification}` ## Request - Base URL: `https://api.mastercard.com/commercial/payments` - URL: `https://api.mastercard.com/commercial/payments/creditor-agents/{ica}/payment-acceptances/{instruction_identification}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint allows inquiry of a submitted payment instruction. ## Path parameters - `ica` string, required - `instruction_identification` string, required ## Response `200` Response object of Get Credit transfer information. - PICustomerCreditTransferInitiation: Object for returning the status of the instruction identification - `paymentInformation` PaymentInformation - `paymentInformationIdentification` string, required: Unique identification, as assigned by a sending party, to unambiguously identify the payment information group within the message. - `paymentMethod` 'CARD', required: Fixed code - CARD - `requestedExecutionDate` string, required: A particular point in the progression of time is defined by a mandatory date and a mandatory time component, expressed in UTC time format. This date can be in future if the Creditor Agent accepts it. - `debtor` Debtor, required: A party that owes an amount of money to the (ultimate) Creditor name, postal address are mandatory along with at least one identification if the debtor is not registered with Commercial Direct Payments (CDP) before hand. Optionally, PRID can be sent as the identification by registering debtors before hand, in which case name and postal addresses are optional. List of supported organization identifications for debtor are as follows- PRID - Debtor profile ID generated by registering debtor with CDP CUST - Customer Number TXID - Tax Identification Number BANK - Bank Party Identification CBID - Central BankIdentification Number COID - Country Identification Code DUNS - Data Universal Numbering System - `name` string: Name of the ultimate debtor - `postalAddress` DebtorPostalAddress: Information that locates and identifies a specific address, as defined by postal services. - `streetName` string: Name of a street or thoroughfare - `postalCode` string: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `townName` string: Name of a built-up area, with defined boundaries, and a local government - `countrySubDivision` string: Country Sub Division - `country` string: The code is checked against the list of country names obtained from the United Nations (ISO 3166, Alpha-2 code). Refer Alpha-2 codes from External Code Set excel. - `identification` DebtorIdentification: Any one of the identifications - BIC / LEI / CUST should be sent by the issuer if the issuer is not sending Debtor ID. - `organisationIdentification` DebtorOrganisationIdentification - `anyBIC` string: Only a valid Business Identifier Code is allowed. Consists of eight (8) or eleven (11) contiguous characters. Format pattern [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1} - `lei` string: Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". Format pattern [A-Z0-9]{18,18}[0-9]{2,2} - `other` DebtorOrganisationIdentificationArr[]: Unique identification of an organization, as assigned by an institution, using an identification scheme - `identification` string: This field carries identification of Debtor. The type of Debtor IDs supported are- PRID - Mastercard registered buyer/debtor ID TXID - Tax ID BANK - Bank party identification CBID - Central bank identification number COID - Country identification code DUNS - Data universal numbering system - `issuer` string: Entity that assigns the identification. - `schemeName` DebtorOrganisationSchemeName: Name of the identification scheme - … - `debtorAccount` DebtorAccount, required - `identification` DebtorAccountIdentification, required: The payment method information - virtual card or real card payment method - `other` DebtorAccountIdentificationArr[]: Identification of the payment method. - `identification` string: The last four digits of the payment card number should be sent in this field. - `schemeName` DebtorAccountSchemeName: Name of the identification scheme - `code` string: Name of the identification scheme, in a coded form - `issuer` string: Identification of the issuer of the reference document type - `type` DebtorAccountType - `code` string, required: Defines the fixed type code CARD - `currency` string: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds" - `name` string: Name of Cardholder - `creditTransferTransactionInformation` CreditTransferTransactionInformation, required - `paymentIdentification` PaymentIdentification - `instructionIdentification` string: The instruction identification will be set by Mastercard Commercial Direct Payments as the transaction ID generated by our CDP service. Debtor Agents and Creditor Agents are not supposed to use this field to set any value. In case used, the payment initiation will be rejected. - `endToEndIdentification` string, required: Unique identification assigned by the initiating party to unambiguously identify the payment instruction. This identification is passed on, unchanged, throughout the entire end-to-end chain. The end-to-end identification can be used for reconciliation or to link tasks relating to the payment instruction. It can be included in several messages related to the payment instruction. - `uetr` string, uuid: A universally unique identifier to provide an end-to-end reference of a payment instruction. UUIDv4Identifier- Universally Unique Identifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique Identifier (UUID) URN Namespace". - `amount` Amount, required - `instructedAmount` InstructedAmount: The amount of money to be moved between the Debtor and Creditor, expressed in the currency as ordered by the initiating party. - `currency` string: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". - `amount` number: The number of fractional digits (or minor unit of currency) must comply with ISO 4217. Note- The decimal separator is a dot. Amount Format minInclusive 0 totalDigits 18 fractionDigits 5 - `exchangeRateInformation` ExchangeRateInformation: Provides details on the currency exchange rate and contract. - `unitCurrency` string: Currency in which the rate of exchange is expressed in a currency exchange. For example, 1GBP = xxxCUR, the unit currency is GBP A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". - `exchangeRate` number: The factor used for the conversion of an amount from one currency to another. This reflects the price at which one currency is bought with another currency. Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. - `rateType` string: Specifies the type used to complete the currency exchange. Following are the allowed codes- SPOT - Exchange rate applied is the spot rate. SALE - Exchange rate applied is the market rate at the time of the sale. AGRD - Agreed Exchange rate applied is the rate agreed between the parties. - `contractIdentification` string: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/Creditor and the Debtor Agent. - `chargeBearer` string: We will support only DEBT code for the chargeBearer field. Which means all transaction charges are to be borne by the Debtor. - `creditor` Creditor, required - `name` string: The name by which a party is known and which is used to identify that party. - `postalAddress` CreditorPostalAddress: Information that locates and identifies a specific address, as defined by postal services. - `streetName` string: Name of a street or thoroughfare - `postalCode` string: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `townName` string: Name of a built-up area, with defined boundaries, and a local government - `countrySubDivision` string: Country Sub Division - `country` string: The code is checked against the list of country names obtained from the United Nations (ISO 3166, Alpha-2 code). Refer Alpha-2 codes from External Code Set excel. - `identification` CreditorIdentification: Unique identification of (ultimate) Creditor - `organisationIdentification` CreditorOrganisationIdentification - `anyBIC` string: Only a valid Business Identifier Code is allowed. Consists of eight (8) or eleven (11) contiguous characters. Format pattern [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1} - `lei` string: Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". Format pattern [A-Z0-9]{18,18}[0-9]{2,2} - `other` CreditorOrganisationIdentificationArr[]: Unique identification of an organization, as assigned by an institution, using an identification scheme - … - `tax` Tax - `totalTaxAmount` TotalTaxAmount - `currency` string: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". - `amount` number: Amount of money to be moved between the debtor and Creditor, before deduction of charges, expressed in the currency as ordered by the initiating party minInclusive 0 totalDigits 18 fractionDigits 5 - `relatedRemittanceInformation` RelatedRemittanceInformation[]: Related Remittance Information is to be used when the Debtor Agent wants to send Creditor the location of remittance data when remittance data is delivered outside CDP. - `remittanceIdentification` string: Unique identification, as assigned by the initiating party, to unambiguously identify the remittance information sent separately from the payment instruction, such as a remittance advice. - `remittanceLocationDetails` RemittanceLocationDetails[]: Additional Information - `method` 'FAXI' | 'EDIC' | 'URID' | 'EMAL' | 'POST' | 'SMSM', required: Method used to deliver the remittance advice information. Supported method codes are- FAXI - FAX EDIC - Electronic Data Interchange URID - Uniform Resource Identifier EMAL - Email POST - Post SMSM - SMS - `electronicAddress` string: The electronic address at which the Creditor Agent is to send the remittance information. - `name` string, required: Remittance Location Name - `postalAddress` RelatedRemittancePostalAddress, required: Information that locates and identifies a specific address, as defined by postal services. - `streetName` string: Name of a street or thoroughfare - `postalCode` string: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `townName` string: Name of a built-up area, with defined boundaries, and a local government - `countrySubDivision` string: Country Sub Division - `country` string: The code is checked against the list of country names obtained from the United Nations (ISO 3166, Alpha-2 code). Refer Alpha-2 codes from External Code Set excel - `remittanceInformation` RemittanceInformation - `unstructured` string[]: The unstructured remittance information array supports 30 free text fields of key-value pair format at the payment request level. - `structured` Structured[]: Structured remittance information with attached reference documents and other reconciliation data that might be needed by the Creditor (Supplier). The structured remittance data is mandatory only when the Creditor has asked for remittance data from CDP. If the Creditor does not requires remittance data from CDP, the entire structured array is optional. - `referredDocumentInformation` ReferredDocumentInformation[]: Provides the identification and the content of the referred document. Following are the supported document types- CINV - Commercial Invoice PUOR - Purchase Order (this is a supporting document and can be only added as an attachment to the commercial invoice) CREN - Credit Note BREF - Booking Reference CLAM - Claim Document Note - There can be either CINV or CREN type of document as part of one single referredDocumentInformation array. As mentioned above, PUOR can be added optionally along with CINV. - `number` string: Provides the identification and the content of the referred document. Following are the supported document types- CINV - Commercial Invoice PUOR - Purchase Order (this is a supporting document and can be only added as an attachment to the commercial invoice) CREN - Credit Note BREF - Booking Reference CLAM - Claim Document Note - There can be either CINV or CREN type of document as part of one single referredDocumentInformation array. As mentioned above, PUOR can be added optionally along with CINV. - `type` ReferredDocumentType - … - `relatedDate` RelatedDate[]: Date associated with the referred document. There are two dates supported as follows. - … - `lineDetails` LineDetails[]: Set of elements used to provide the content of the referred document line items (ex. Commercial Invoice line details) - … - `referredDocumentAmount` ReferredDocumentAmount - `remittanceAmountandType` RemittanceAmountandType[] - … - `adjustmentAmountAndReason` AdjustmentAmountAndReason[] - … - `creditorReferenceInformation` CreditorReferenceInformation - `reference` string: A unique reference, as assigned by the Creditor, to unambiguously refer to the payment instruction. If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the Creditor upon receipt of the amount of money. - `type` CreditorReferenceInformationType: Specifies the type of creditor reference. - … - `invoicer` Invoicer: Identification of the organisation issuing the invoice, when it is different from the Creditor or ultimate Creditor, this object can be used. - `name` string: The name by which a party is known and which is used to identify that party. - `postalAddress` InvoicerPostalAddress: Information that locates and identifies a specific address, as defined by postal services. - … - `identification` InvoicerIdentification - … - `invoicee` Invoicee: Identification of the party to whom an invoice is issued, when it is different from the Debtor or ultimate Debtor, this object can be used. - `name` string: Name by which a party is known and which is usually used to identify that party - `postalAddress` InvoiceePostalAddress: Information that locates and identifies a specific address, as defined by postal services. - … - `identification` InvoiceeIdentification - … - `additionalRemittanceInformation` string[]: Additional Remittance Information - `supplementaryData` SupplementaryData, required - `envelope` Envelope, required - `cardDetails` CardDetails, required: Specifies card details of the card holder - `pan` string: Card Number (Permant Account Number of Card) - `expiryDate` string: Expiry date of Card - `cvv` string: Verification of Card - `cardholderName` string: Card Holder Name - `currency` string: Currency of the Card - `cardholderAddress` CardHolderAddress - … - `additionalCardDetails` AdditionalCardDetails - … - `chargesInformation` ChargesInformation[] - `currency` string: Identification of the currency in which the account is held. - `type` ChargesType - … - `amount` number: Transaction charges to be paid by the charge bearer (DEBT) - `paymentStatus` PICustomerCreditTransferInitiationPaymentStatus: Specifies the status of the payment information. - `status` 'RECEIVED' | 'ACCEPTED' | 'PENDING' | 'SUBMITTED' | 'APPROVED' | 'DECLINED' | 'REJECTED' | 'CANCELLATION_REQUESTED' | 'CANCELLATION_ACCEPTED' | 'CANCELLATION_REJECTED' | 'CANCELLED' | 'SETTLED': Possible statuses returned in the status inquiry- RECEIVED ACCEPTED PENDING SUBMITTED APPROVED DECLINED REJECTED CANCELLATION_REQUESTED CANCELLATION_ACCEPTED CANCELLATION_REJECTED CANCELLED SETTLED - `statusReasonInformation` StatusReasonInformation[]: Status Reason Information - `description` string: Specifies the reason for the status report. Refer to the developer portal for the full list. - `reasonCode` string: Specifies the reason code for the status report. Refer to the developer portal for the full list. - `settlementTimeIndication` SettlementTimeIndication - `creditDateTime` string: Date and time at which a payment has been credited. - `debitDateTime` string: Reserved for Future Use - `transactionIdentification` TransactionIdentification - `approvalCode` string: The value assigned by the approval entity indicating approval. - `retrievalReferenceNumber` string: Reference supplied by the system retaining the original source information and used to assist in locating that information or a copy thereof. - `transactionReference` string: Identification of the transaction by the card acceptor. It may appear on the receipt of the cardholder. It remains unchanged throughout the lifetime of the transaction. - `transactionDateTime` string: Local date and time of the transaction assigned by the POI (Point Of Interaction) - `createdDate` string: The date of creating a payment - `updatedDate` string: The date of updating a payment ## Other responses - `401`: Unauthorized - `403`: Access Denied - `404`: Not found --- [API](https://skmtc.dev/mastercard/apis/payment-acceptance-api.md) - [All operations](https://skmtc.dev/mastercard/apis/payment-acceptance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mastercard/apis/payment-acceptance-api/revisions/baa0a0739572?raw)