payment-links.write
scope.Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The ID of the merchant account to use for this request.
"default"
Body
The payment link to create
The amount for the payment link.
0 <= x <= 99999999
1299
The country code for the payment link.
"DE"
"GB"
"US"
The currency code for the payment link.
"EUR"
"GBP"
"USD"
The guest buyer for the payment link.
The expiration date and time for the payment link.
"2024-06-01T00:00:00.000Z"
Connection options for the payment link.
The merchant reference for the payment link.
1 - 200
"external-12345"
The statement descriptor for the payment link. Information to show the user on their payments statement
The locale for the payment link.
en
, en-GB
, pt
, pt-BR
, es
"en"
"en-GB"
"pt"
"pt-BR"
"es"
The merchant's display name.
1 - 100
"ACME Inc."
The merchant's website URL.
"https://merchant.example.com"
The merchant's banner image URL.
"https://merchant.example.com/banner.png"
The merchant's brand color.
"#FF5733"
A message from the merchant.
1 - 255
"Thank you for your purchase!"
URL to the merchant's terms and conditions.
"https://merchant.example.com/terms"
URL to the merchant's favicon.
"https://merchant.example.com/favicon.ico"
The transaction intent for the payment link.
authorize
, capture
"authorize"
"capture"
The return URL after payment completion.
"https://merchant.example.com/return"
The cart items for the payment link.
Arbitrary metadata for the payment link.
{ "order_id": "ORD-12345" }
The way payment method information made it to this transaction.
ecommerce
, moto
, recurring
, installment
, card_on_file
"ecommerce"
Response
Successful Response
The unique identifier for the payment link.
"a1b2c3d4-5678-90ab-cdef-1234567890ab"
The URL for the payment link.
"https://example.com/link/a1b2c3d4-5678-90ab-cdef-1234567890ab"
The amount for the payment link.
0 <= x <= 99999999
1299
The country code for the payment link.
"DE"
"GB"
"US"
The currency code for the payment link.
"EUR"
"GBP"
"USD"
The transaction intent for the payment link.
authorize
, capture
"authorize"
"capture"
The cart items for the payment link.
[
{
"amount": { "currency": "USD", "value": 500 },
"name": "Widget",
"quantity": 2
}
]
The way payment method information made it to this transaction.
ecommerce
, moto
, recurring
, installment
, card_on_file
"ecommerce"
The date and time the payment link was created.
"2024-05-30T12:34:56.000Z"
The date and time the payment link was last updated.
"2024-05-30T13:00:00.000Z"
The status of the payment link.
active
, completed
, expired
, processing
"active"
"expired"
"completed"
Always payment-link
.
"payment-link"
"payment-link"
The expiration date and time for the payment link.
"2024-06-01T00:00:00.000Z"
The merchant reference for the payment link.
1 - 200
"external-12345"
The statement descriptor for the payment link. Information to show the user on their payments statement
The locale for the payment link.
"en"
"en-GB"
"pt"
"pt-BR"
"es"
The merchant's display name.
1 - 100
"ACME Inc."
The merchant's website URL.
"https://merchant.example.com"
The merchant's banner image URL.
"https://merchant.example.com/banner.png"
The merchant's brand color.
1 - 100
"#FF5733"
A message from the merchant.
1 - 255
"Thank you for your purchase!"
URL to the merchant's terms and conditions.
"https://merchant.example.com/terms"
URL to the merchant's favicon.
"https://merchant.example.com/favicon.ico"
The return URL after payment completion.
"https://merchant.example.com/return"
Arbitrary metadata for the payment link.
{ "order_id": "ORD-12345" }
The buyer associated with the payment link.
The shipping details for the payment link.
The connection options for the payment link.