Skip to main content

Fetch payment data

GET 
/v1/payment-service/payment-product/paymentId

Description​

Retrieve detailed payment information, including creditor and debtor account details, transaction status and remittance information.

tip

Gather essential data related to a specific payment transaction without the need for manual data retrieval or processing.

Request​

Path Parameters

    payment-service stringrequired

    The payment service that is used to initiate the payment.
    Available options: payments.

    payment-product stringrequired

    The addressed payment product endpoint, e.g., for SEPA Credit Transfers (SCT).
    Available options: internal-transfers, sepa-credit-transfers.

    paymentId stringrequired

    The unique ID of the payment to be retrieved.

Header Parameters

    X-Request-ID uuidrequired

    ID of the request, unique to the call, as determined by the initiating party.

    Certificate stringrequired

    The certificate used for signature verification.

    ClientId stringrequired

    The client ID associated with the request.

    Ocp-Apim-Subscription-Key stringrequired

    A unique identifier related to the registered merchant in the corresponding API environment, available within the application's details.

Responses​

OK
Schema
    endToEndIdentification stringA unique identifier assigned by the initiating party to unambiguously identify the transaction. This identifier will be passed unaltered through the entire chain of the payment.
    debtorAccount objectAn object containing information about the debtor's account.
    iban stringThe International Bank Account Number (IBAN) of the debtor's account.
    bban stringThe Basic Bank Account Number (BBAN) of the debtor's account.
    pan stringThe Primary Account Number (PAN) of the debtor's account.
    maskedPan stringThe masked PAN of the debtor's account.
    msisdn stringThe Mobile Station International Subscriber Directory Number (MSISDN) of the debtor's account, which is a number uniquely identifying a subscription in a GSM or a UMTS mobile network.
    currency stringThe currency of the account.
    instructedAmount objectAn object specifying the amount of the payment.
    currency stringThe currency of the payment amount.
    Amount stringThe amount of the payment.
    creditorAccount objectAn object containing information about the creditor's account.
    iban stringThe International Bank Account Number (IBAN) of the creditor's account.
    bban stringThe Basic Bank Account Number (BBAN) of the creditor's account.
    pan stringThe Primary Account Number (PAN) of the creditor's account.
    maskedPan stringThe masked PAN of the creditor's account.
    msisdn stringThe Mobile Station International Subscriber Directory Number (MSISDN) of the creditor's account, which is a number uniquely identifying a subscription in a GSM or a UMTS mobile network.
    currency stringThe currency of the account.
    creditorAgent stringThe financial institution servicing an account for the creditor.
    creditorName stringThe name of the creditor.
    creditorAddress objectAn object containing the address of the creditor.
    street stringThe street name in the creditor's address.
    buildingNumber stringThe building number in the creditor's address.
    city stringThe city in the creditor's address.
    postalCode stringThe postal code in the creditor's address.
    country stringThe country in the creditor's address.
    remittanceInformationUnstructured stringUnstructured remittance information for the creditor to identify the transaction.
    transactionStatus int32

    The status of the transaction.
    Available options: 0 = "ACCC", 1 = "ACCP", 2 = "ACSC", 3 = "ACSP", 4 = "ACTC", 5 = "ACWC", 6 = "ACWP", 7 = "RCVD", 8 = "PDNG", 9 = "RJCT", 10 = "CANC", 11 = "ACFC", 12 = "PATC", 13 = "PART".

Loading...