Create a payment

POST

Create and authorize a payment for a given customer order. You should provide a payment method token here to avoid PCI implications.

If only a payment method token is passed, the values passed with the Client Session is used to determine the amount, currency etc. Note: amount, currencyCode and orderId are required during payment creation. Make sure to pass these fields when creating a client session, or if not yet available, when creating a payment.

All fields provided on this request will take preference over any field on the order associated with the client session. E.g. if you pass amount on this request, it will override the amount on the order associated with the Client Session. Parameters that are not on this request will be fetched from previously created Client Session and merged. E.g. if you specify customer.billingAddress in Client Session and then pass customer.emailAddress data with this request, it will automatically merge the customer fields and use both billingAddress and emailAddress for later calculations.

Headers

X-Idempotency-KeystringOptional
Optional key to make the request idempotent. Enables a safe retry of a request without risking the user being charged or refunded multiple times. The idempotency key must be generated by the client and needs to be unique for every new request.

Request

This endpoint expects an object.
paymentMethodTokenstringRequired
The payment method token used to authorize the payment.
orderIdstringOptional
Your reference for the payment.
currencyCodeenumOptional

The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.

amountintegerOptional

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.

orderobjectOptional
More information associated with the order.
customerIdstringOptional

A unique identifier for your customer. This attribute is required if paymentMethod.vaultOnSuccess is set to True.

customerobjectOptional
More information associated with the customer.
metadatamap from strings to anyOptional

Additional data to be used throughout the payment lifecycle.

A dictionary of key-value pairs where the values can only be strings or integers.

e.g. {"productId": 1001, "merchantId": "a13bsd62s"}

paymentMethodobjectOptional
Enable certain options associated with the payment method.

Response

This endpoint returns an object.
idstringOptional

The unique payment ID.

You can use this ID to retrieve the payment details, or perform downstream operations.

datedatetimeOptional
The date and time at which the payment was created in UTC format.
dateUpdateddatetimeOptional
The date and time of the last payment update in UTC format.
statusenumOptional

See the payment status table for more information.

cardTokenTypeenumOptional
Allowed values: CARD_PANNETWORK_TOKENPROCESSOR_TOKEN

The type of card token used for the payment.

Only applies for card payments.

orderIdstringOptional
Your reference for the payment.
currencyCodeenumOptional

The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.

amountintegerOptional
The amount you charged the customer, in minor units.
orderobjectOptional
More information associated with the order.
customerIdstringOptional
The unique identifier for your customer.
customerobjectOptional
More information associated with the customer.
metadatamap from strings to anyOptional
Additional data to be used throughout the payment lifecycle.
paymentMethodobjectOptional
The payment method options provided in the request, as well as the token used to process the payment.
processorobjectOptional
More information associated with the payment processor, including the processor name.
requiredActionobjectOptional
Required action to perform in order to resume the payment workflow. This can be requiring a 3DS check from the customer for instance.
statusReasonobjectOptional

Check this field for more information regarding the payment’s status. This is especially useful when the status is DECLINED or FAILED.

transactionslist of objectsOptional

A list summarizing the transactions that occurred while processing the payment.

Note: a refund is a separate transaction and so will appear in this transactions list if a refund was performed.

riskDataobjectOptional
Risk data associated with this payment.

Errors

Built with