| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
string | ✔️ | The unique identifier for the payment link. | a1b2c3d4-5678-90ab-cdef-1234567890ab |
type |
?string | ➖ | Always payment-link. |
payment-link |
url |
string | ✔️ | The URL for the payment link. | https://example.com/link/a1b2c3d4-5678-90ab-cdef-1234567890ab |
expiresAt |
\DateTime | ➖ | The expiration date and time for the payment link. | 2024-06-01T00:00:00.000Z |
externalIdentifier |
?string | ➖ | The merchant reference for the payment link. | external-12345 |
statementDescriptor |
?StatementDescriptor | ➖ | The statement descriptor for the payment link. | |
locale |
?string | ➖ | The locale for the payment link. | Example 1: en Example 2: en-GB Example 3: pt Example 4: pt-BR Example 5: es |
merchantName |
?string | ➖ | The merchant's display name. | ACME Inc. |
merchantUrl |
?string | ➖ | The merchant's website URL. | https://merchant.example.com |
merchantBannerUrl |
?string | ➖ | The merchant's banner image URL. | https://merchant.example.com/banner.png |
merchantColor |
?string | ➖ | The merchant's brand color. | #FF5733 |
merchantMessage |
?string | ➖ | A message from the merchant. | Thank you for your purchase! |
merchantTermsAndConditionsUrl |
?string | ➖ | URL to the merchant's terms and conditions. | https://merchant.example.com/terms |
merchantFaviconUrl |
?string | ➖ | URL to the merchant's favicon. | https://merchant.example.com/favicon.ico |
amount |
int | ✔️ | The amount for the payment link. | 1299 |
country |
string | ✔️ | The country code for the payment link. | Example 1: DE Example 2: GB Example 3: US |
currency |
string | ✔️ | The currency code for the payment link. | Example 1: EUR Example 2: GBP Example 3: USD |
intent |
string | ✔️ | N/A | |
returnUrl |
?string | ➖ | The return URL after payment completion. | https://merchant.example.com/return |
cartItems |
array<CartItem> | ✔️ | The cart items for the payment link. | [ { "amount": { "currency": "USD", "value": 500 }, "name": "Widget", "quantity": 2 } ] |
metadata |
array<string, mixed> | ➖ | Arbitrary metadata for the payment link. | { "order_id": "ORD-12345" } |
paymentSource |
string | ✔️ | The way payment method information made it to this transaction. | |
createdAt |
\DateTime | ✔️ | The date and time the payment link was created. | 2024-05-30T12:34:56.000Z |
updatedAt |
\DateTime | ✔️ | The date and time the payment link was last updated. | 2024-05-30T13:00:00.000Z |
status |
string | ✔️ | N/A | |
buyer |
?TransactionBuyer | ➖ | The buyer associated with the payment link. | |
shippingDetails |
?ShippingDetails | ➖ | The shipping details for the payment link. | |
connectionOptions |
array<string, array<string, mixed>> | ➖ | The connection options for the payment link. | |
store |
?bool | ➖ | Whether the payment method was stored. | |
buyerId |
?string | ➖ | The ID of the buyer to associate with the stored payment method. | a1b2c3d4-5678-90ab-cdef-1234567890ab |
installmentCount |
?int | ➖ | The number of installments a buyer is required to make. |
