Skip to main content

Inform about the payment

POST 
/notification
Inform about the payment stages and the final result of the payment
Responses
Redirect Link Created
Schema
    response object
    message string
    operations object[]
  • Array [
    • amount string

    Payment Amount

    currency Currency

    Possible values: [EUR, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF, XPD, XPF, XPT, YER, ZAR, ZMW, ZWL]

    Currency of the transaction.

    • ISO-4217.3 code (EUR, USD, GBP, etc.).
    merchantTransactionId string
    operationType string

    Possible values: [DEBIT, CREDIT]

    Operation Type

    transactionId string
    sorted-order string
    status string

    Possible values: [INITIATED, PENDING, TO_CAPTURE, SUCCESS, SUCCESS_WARNING, ERROR, VOIDED, REBATED, REJECTED, REDIRECTED, AWAITING_PAYSOL, SUCCESS3DS, ERROR3DS, FAIL, N/A (Not Applicable)]

    Status of the transaction after being managed by the payment solution or service

    authCode string

    Authorization code of the issuer for card payments.

    • Alphanumeric – 6 characters.
    details string

    Raw response from the payment solution.

    • Alphanumeric – Max. 1024 characters.
    mpi object
    3DSv2 response containing information about authentication in payments with card
    eci string

    Result of the authentication attempt

    paymentCode string

    Original response code of the payment solution.

    • The format and values depend on each payment solution.
    paymentDetails object
    Details of the customer's card or account
    account string

    Portfolio or customer account number

    cardHolderName string

    Card holder

    cardNumber string

    Masked card number

    • Numeric – Max. 19 digits
    • 4907270002222227 → 490727******2227
    cardNumberToken string

    Customer card reference generated by AP.

    • Alphanumeric – 16~20 characters.
    cardType string

    Possible values: [VISA, MASTERCARD, AMEX]

    Brand of the card.

    expDate string

    Expiration date of the card

    • Numeric – 4 digits.
    • Format: MMYY - MM the two digits of the month and YY the last two digits of the year.
    • For example: June 2023 → 0623
    extraDetails object[]
  • Array [
    • key string

    Data key

    value string

    Data value

  • ]
    • issuerBank string

    Name of the bank issuing the card.

    issuerCountry string

    Country of the bank issuing the card.

    paymentMessage string

    Original message of the response of the payment solution or service that has managed the transaction.

    paymentSolution string

    Name of the payment solution that has managed the transaction.

    • When this parameter is received, the “service” parameter will not be received.
    paySolTransactionId string

    Transaction identifier in the payment solution.

    • The format depends on each payment solution.
    rad string

    Additional data from the response.

    • Only available at some card issuers.
    radMessage string

    Message received together with the additional data of the response.

    • Only available at some card issuers.
    redirectionResponse string

    URL to which your e-commerce platform has to redirect the customer to complete the payment.

    respCode object
    AP response code. It maps the different response codes of the different payment services and solutions to a series of unified codes.
    message string

    AP response messages.

    uuid string

    AP internal UUID generated for the transaction.

    service string

    Name of the service that has managed the transaction.

    • When this parameter is received, the “paymentSolution” parameter will not be received
    subscriptionPlan string

    Identifier for recurring payments.

  • ]
    • status string
    workFlowResponse object
    Element that informs about the workflow that has managed the request
    id string

    Internal identifier of the workflow in AP.

    name string

    Name of the workflow.

    version string

    Version of the workflow.

Loading...