Create a new payment link

post

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

Required permissions for this API:

WRITE:FINANCE

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

number

The payment amount. For Fixed pricing only.

collectableShopperInfo

object

Every payment link requires the shopper to enter their name and email address. Additionally, you can request information for the following fields on each payment link.

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 used with x-on-behalf-of header together.

currency

string

The payment currency. For Fixed pricing only.

customerId

string

The Customer who is paying for this PaymentLink. Only applicable for links with reusable equals to false. This field is required if you want the payer to see the payment methods saved in the previous checkouts.

defaultCurrency

string

The default payment currency from the list of supported_currencies. The shopper can change the payment currency during checkout. For Flexible pricing only.

description

string

The additional description text that appears under the title in the payment checkout page.

expiresAt

string

Payment link expiry timestamp in ISO 8601 format.

metadata

object

A set of key-value pairs that you can attach to the PaymentLink for storing additional information.

reference

string

A reference only visible to the merchant.

reusable

boolean

required

Specifies whether the payment link can be used once or multiple times.

supportedCurrencies

array of strings

List of supported currencies the shopper may choose from. For Flexible pricing only.

supportedCurrencies

title

string

required

The title of the payment link that is displayed in the payment checkout page.

Responses

201

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