| Field | Type | Required | Description | Example |
|---|---|---|---|---|
buyer |
JsonNullable<GuestBuyer> | ➖ | The guest buyer for the payment link. | |
expiresAt |
OffsetDateTime | ➖ | The expiration date and time for the payment link. | 2024-06-01T00:00:00.000Z |
connectionOptions |
JsonNullable<TransactionConnectionOptions> | ➖ | Connection options for the payment link. | |
externalIdentifier |
JsonNullable<String> | ➖ | The merchant reference for the payment link. | external-12345 |
statementDescriptor |
JsonNullable<StatementDescriptor> | ➖ | The statement descriptor for the payment link. | |
locale |
JsonNullable<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 |
JsonNullable<String> | ➖ | The merchant's display name. | ACME Inc. |
merchantUrl |
JsonNullable<String> | ➖ | The merchant's website URL. | https://merchant.example.com |
merchantBannerUrl |
JsonNullable<String> | ➖ | The merchant's banner image URL. | https://merchant.example.com/banner.png |
merchantColor |
JsonNullable<String> | ➖ | The merchant's brand color. | #FF5733 |
merchantMessage |
JsonNullable<String> | ➖ | A message from the merchant. | Thank you for your purchase! |
merchantTermsAndConditionsUrl |
JsonNullable<String> | ➖ | URL to the merchant's terms and conditions. | https://merchant.example.com/terms |
merchantFaviconUrl |
JsonNullable<String> | ➖ | URL to the merchant's favicon. | https://merchant.example.com/favicon.ico |
amount |
long | ✔️ | 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 |
Optional<TransactionIntent> | ➖ | N/A | |
returnUrl |
JsonNullable<String> | ➖ | The return URL after payment completion. | https://merchant.example.com/return |
cartItems |
List<CartItem> | ➖ | The cart items for the payment link. | |
metadata |
Map<String, Object> | ➖ | Arbitrary metadata for the payment link. | { "order_id": "ORD-12345" } |
paymentSource |
Optional<TransactionPaymentSource> | ➖ | The way payment method information made it to this transaction. | |
store |
Optional<Boolean> | ➖ | Whether to store the payment method for future use. | true |
buyerId |
JsonNullable<String> | ➖ | The ID of the buyer to associate the payment method with. Note: When buyer_id is provided, the payment link should be treated as a secret as it will allow the user to manage payment methods for the associated buyer. |
a1b2c3d4-5678-90ab-cdef-1234567890ab |
installmentCount |
JsonNullable<Long> | ➖ | The number of installments a buyer is required to make. |
