Authorizations
Path Parameters
Body
The payment ID.
The payment ID must be unique. You can use this unique payment ID to update payment details.
250The 3-letter currency code in ISO 4217 format.
e.g. use USD for US dollars.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, 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, SOS, SRD, SSP, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XSU, XTS, XUA, YER, ZAR, ZMW, ZWL The amount you would like to charge the customer,
in minor units. e.g. for $7, use 700.
Some currencies, such as Japanese Yen, do not have minor units.
In this case you should use the value as it is, without any formatting.
For example for ¥100, use 100.
The minimum amount is 0.
x >= 0The payment creation date and time (UTC) in ISO 8601 format.
Cannot be updated in partial updates PATCH.
Pass more information regarding the payment's status in this field.
This is especially useful when the status is DECLINED or FAILED.
Additional data to be used throughout the payment lifecycle.
Ad dictionary of key-value pairs where the values can only be strings or integers.
e.g. {"productId": 1001, "merchantId": "88278a"}
Payment types, primarily to be used for recurring payments.
Note: If you successfully vault a SINGLE_USE token on payment
creation, then there's no need to set a value for this field and it will
be flagged as FIRST_PAYMENT. Otherwise, see the table below for all
possible values.
| paymentType | Use case |
|---|---|
FIRST_PAYMENT | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |
ECOMMERCE | a customer-initiated payment using stored payment details where the cardholder is present. |
SUBSCRIPTION | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |
UNSCHEDULED | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |
MOTO | a merchant-initiated mail order or telephone order payment. |
IN_STORE | a customer-initiated payment where the customer is physically present in a shop. |
FIRST_PAYMENT, ECOMMERCE, SUBSCRIPTION, UNSCHEDULED, MOTO, IN_STORE A description of the payment, as it would typically appear on a bank statement.
250Response
The payment ID.
The payment ID must be unique. You can use this unique payment ID to update payment details.
250The 3-letter currency code in ISO 4217 format.
e.g. use USD for US dollars.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, 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, SOS, SRD, SSP, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XSU, XTS, XUA, YER, ZAR, ZMW, ZWL The amount you would like to charge the customer,
in minor units. e.g. for $7, use 700.
Some currencies, such as Japanese Yen, do not have minor units.
In this case you should use the value as it is, without any formatting.
For example for ¥100, use 100.
The minimum amount is 0. The maximum amount is the limit of int64.
x >= 0The payment creation date and time (UTC) in ISO 8601 format.
Cannot be updated in partial updates PATCH.
Pass more information regarding the payment's status in this field.
This is especially useful when the status is DECLINED or FAILED.
Additional data to be used throughout the payment lifecycle.
Ad dictionary of key-value pairs where the values can only be strings or integers.
e.g. {"productId": 1001, "merchantId": "88278a"}
Payment types, primarily to be used for recurring payments.
Note: If you successfully vault a SINGLE_USE token on payment
creation, then there's no need to set a value for this field and it will
be flagged as FIRST_PAYMENT. Otherwise, see the table below for all
possible values.
| paymentType | Use case |
|---|---|
FIRST_PAYMENT | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |
ECOMMERCE | a customer-initiated payment using stored payment details where the cardholder is present. |
SUBSCRIPTION | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |
UNSCHEDULED | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |
MOTO | a merchant-initiated mail order or telephone order payment. |
IN_STORE | a customer-initiated payment where the customer is physically present in a shop. |
FIRST_PAYMENT, ECOMMERCE, SUBSCRIPTION, UNSCHEDULED, MOTO, IN_STORE A description of the payment, as it would typically appear on a bank statement.
250