Skip to main content

createPaymentLink

POST 
/payment/link

createPaymentLink

Request​

Body

required

    amount numberrequired

    Default value: 0

    cardHolderEmail stringrequired
    cardHolderName stringrequired
    expiresAt date-time
    phone numberrequired
    productName number
    locale numberrequired

    Default value: en

    scopeId stringrequired
    productDescription stringrequired
    currencyCode number

    Default value: 0

    customFields1 string
    customFields2 string
    customFields3 string
    customFields4 string
    paymentAccount string

    Default value: default

    paymentMethod string

    Possible values: [alipay, bancontact, banktransfer, cc, web-cc, dc, dtac, fortumo, gpay, gcash, gopay, grab, ideal, homecredit, installment, konbini, linepay, link-aja, momo, online-banking, over-the-counter, ovo, pay-at-atm, paymaya, qrcode, sepa, worldpay-cc, truemoney, cash-installment, wechat, bnpl, zalopay, samsung-pay]

    preAuthorization number

    Default value: 0

    recurring number

    Default value: 0

    recurringSettings object
    status string

    Possible values: [PENDING, REQUESTED, CONFIRMED, FAILED, CANCELLED, REFUNDED, PRE_AUTHORIZED, PARTIAL_REFUND, SENT_FOR_REFUND, CHARGED_BACK]

    Default value: PENDING

    instance string
    enable3DS boolean
    cardType string
    selectedBank string
    bank string
    callbackBackendEndpoint string
    callbackFrontendEndpoint string

    callbacks

    object[]

  • Array [

    • key stringrequired
    url stringrequired
    method stringrequired

    Possible values: [GET, POST, PUT, PATCH, DELETE]

    Default value: POST

    notifyType stringrequired

    Possible values: [backend, frontend]

    Default value: backend

    authorization

    object

    key stringrequired

    Default value: 6ddcda53-7334-44de-8261-7f14d962bd7e

    url stringrequired
    method stringrequired

    Possible values: [GET, POST, PUT, PATCH, DELETE]

    Default value: POST

    headers object
    data object
    credentialType stringrequired
    credentialPath stringrequired
    mapper object

  • ]

    • iban string

    billingAddress

    object

    firstName string
    lastName string
    address1 stringrequired
    address2 string
    city stringrequired
    countryCode stringrequired
    postalCode stringrequired
    state string
    payment_details object
    metadata object

    Default value: [object Object]

    attempt numberrequired

    Default value: 0

    gateway booleanrequired
    host stringrequired
    token stringrequired

Responses​

Loading...