Create a Payment Intent

post

https://api.stage.payouts.com/payment-intent/create

Required permissions for this API:

WRITE:FINANCE

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

additional_info

object

Additional info for the transaction.

amount

number

required

Payment amount. This is the order amount you would like to charge your customer.

connectedAccountId

string

Airwallex assigned account identifier of the connected entity(another account which is linked with platform). It is to be used by the platform to indicate the connected entity in the transaction where platform is the owner of transaction. Notice: This can not be.

currency

string

required

Payment currency in 3-letter ISO 4217 currency code.

customer

object

required

The details of the customer who is making a business payment for this PaymentIntent, in which case it's not desired to create a Customer API resource. This field should not appear together with the customer_id.

customerId

string

The Customer who is paying for this PaymentIntent. This field is not required if the Customer is unknown (guest checkout). But it is required if the PaymentIntent is created for recurring payment.

descriptor

string

Descriptor that will display to the customer. For example, in customer's credit card statement.

deviceData

object

Client device information applicable when payment_method is set. It is recommended to provide this data for risk analysis.

externalRecurringData

object

External recurring data for the PaymentIntent.

fundsSplitData

array of objects

The funds split data for this PaymentIntent.

fundsSplitData

merchantOrderId

string

required

The order ID created in merchant's order system that corresponds to this PaymentIntent.

metadata

object

A set of key-value pairs that you can attach to the PaymentIntent.

order

object

Purchase order related to this PaymentIntent.

paymentMethod

object

The payment method details to confirm the PaymentIntent. The PaymentIntent will be confirmed automatically when payment_method is set

paymentMethodOptions

object

Options for PaymentMethod.

requestId

string

required

Client-generated idempotency key. Must be unique per request attempt. Conversion requests with the same request_id will be rejected. Parameter supports a maximum of 64 characters.

returnUrl

string

The URL to redirect your customer back to after they authenticate their payment on the PaymentMethod’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.

riskControlOptions

object

Risk Control Options.

Responses

201

401A response indicating that the provided api token is invalid or has already expired