Skip to main content

Initiate payment

POST 
/v1/payment-service/payment-product

Description​

Initiate a secure payment transaction.

tip

Provide essential transaction details such as debtor / creditor information, instructed amounts and remittance information to successfully process payments.

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.

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.

    pSUIPAddress stringrequired

    The IP address of the Payment Service User (PSU).

    PSU_ID stringrequired

    The unique PSU's ID, as determined by the PSU. It is the identification of the PSU within the ASPSP and contains the username that requests the consent or initiates the payment.

    consentID string

    The unique identifier of the payment's consent.

    Ocp-Apim-Subscription-Key stringrequired

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

Body parameters

    endToEndIdentification stringrequiredUnique identifier for the end-to-end transaction.
    debtorAccount objectInformation about the debtor's account.
    iban stringrequiredThe International Bank Account Number (IBAN) of the creditor.
    bban stringrequiredThe Basic Bank Account Number (BBAN) of the creditor.
    pan stringrequiredThe Primary Account Number (PAN) of the payer's card.
    maskedPan stringrequiredThe masked Primary Account Number (PAN) of the payer's card.
    msisdn stringrequiredThe mobile phone number of the payer.
    currency stringrequiredThe currency in which the payment is to be made.
    instructedAmount objectrequiredThe instructed amount for the payment.
    currency stringrequiredThe currency in which the payment is to be made.
    Amount stringrequiredPlaceholder for the amount to be paid.
    creditorAccount objectrequiredThe account number of the creditor.
    iban stringrequiredThe International Bank Account Number (IBAN) of the creditor.
    bban stringrequiredThe Basic Bank Account Number (BBAN) of the creditor.
    pan stringrequiredThe Primary Account Number (PAN) of the payer's card.
    maskedPan stringrequiredThe masked PAN of the creditor account.
    msisdn stringrequiredThe mobile phone number of the payer.
    currency stringrequiredThe currency in which the payment is to be made.
    creditorAgent stringrequiredThe clearing agent or institution of the creditor.
    creditorAgentName stringrequiredThe name of the clearing agent or institution of the creditor.
    creditorName stringrequiredThe name of the creditor.
    creditorAddress objectThe address of the creditor.
    street stringrequiredThe street name of the creditor address.
    buildingNumber stringrequiredThe building number of the creditor address.
    city stringrequiredThe city of the creditor address.
    postalCode stringrequiredThe postal code of the credited address.
    country stringrequiredThe country of the creditor address.
    remittanceInformationUnstructured stringrequiredThe unstructured remittance information for the payment.

Responses​

CREATED
Schema
    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".

    paymentId stringThe unique identifier assigned to the payment.
    transactionFees objectThe details regarding any fees associated with the transaction.
    currency stringThe currency of the fees.
    Amount stringPlaceholder for the amount paramter.
    transactionFeeIndicator booleanBoolean parametter,indicating if transaction fees apply to the payment.
    scaMethods object[]The list of Strong Customer Authentication (SCA) methods available for the payment.
  • Array [
    • authenticationType int32

    The type of authentication used, such as SMS OTP or push notification, etc.
    Available options: 0 = "SMSOTP", 1 = "CHIPOTP", 2 = "PHOTOOTP", 3 = "PUSHOTP".

    authenticationVersion stringThe version of the authentication method implemented.
    authenticationMethodId stringThe ID of the authentication method.
    name stringA human-readable name for the authentication method.
    explanation stringA brief explanation or description of the authentication method.
  • ]
    • chosenScaMethod objectThe chosen SCA method for authentication during the payment process.
    authenticationType int32

    The type of authentication used, such as SMS OTP or push notification.
    Available options: 0 = "SMSOTP", 1 = "CHIPOTP", 2 = "PHOTOOTP", 3 = "PUSHOTP".

    authenticationVersion stringThe version of the authentication method implemented.
    authenticationMethodId stringThe ID of the authentication method implemented.
    name stringA human-readable name for the authentication method.
    explanation stringA brief explanation or description of the authentication method.
    challengeData objectData related to the payment initiation challenge.
    image byteAn image associated with the payment transaction.
    data string[]Data relevant to the payment transaction.
    imageLink stringA link to the imae associated with the payment transaction.
    otpMaxLength int32The maximum length of the One-Time Password (OTP), if OTP is used for the challenge.
    otpFormat int32

    The format of the OTP (e.g., numeric, alphanumeric).
    Available options: 0 = "CHARACTERS", 1 = "INTEGER".

    additionalInformation stringAny additional information related to the payment.
    links objectLinks to other resources related to the payment.
    psuMessage stringMessage for the payment service user (PSU).
    tppMessages object[]Messages from the Third-Party Provider (TPP) related to the payment.
  • Array [
    • category int32

    Categorizes the payment transaction.
    Possible options: 0 = "ERROR", 1 = "WARNING".

    code int32

    A unique warning code associated with the payment transaction.
    Description: 0 = "WARNING".

    path stringThe path followed during the payment process.
    text stringThe text response as returned by the API call.
  • ]
    • paymentService stringThe service that is used for the payment process.
    paymentProduct stringThe product for which a payment is initiated.
    customerPhone stringThe phone number of the customer.
Loading...