| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
str | ✔️ | The unique identifier for the payment link. | a1b2c3d4-5678-90ab-cdef-1234567890ab |
type |
Optional[Literal["payment-link"]] | ➖ | Always payment-link. |
payment-link |
url |
str | ✔️ | The URL for the payment link. | https://example.com/link/a1b2c3d4-5678-90ab-cdef-1234567890ab |
expires_at |
date | ➖ | The expiration date and time for the payment link. | 2024-06-01T00:00:00.000Z |
external_identifier |
OptionalNullable[str] | ➖ | The merchant reference for the payment link. | external-12345 |
statement_descriptor |
OptionalNullable[models.StatementDescriptor] | ➖ | The statement descriptor for the payment link. | |
locale |
OptionalNullable[str] | ➖ | The locale for the payment link. | en |
merchant_name |
OptionalNullable[str] | ➖ | The merchant's display name. | ACME Inc. |
merchant_url |
OptionalNullable[str] | ➖ | The merchant's website URL. | https://merchant.example.com |
merchant_banner_url |
OptionalNullable[str] | ➖ | The merchant's banner image URL. | https://merchant.example.com/banner.png |
merchant_color |
OptionalNullable[str] | ➖ | The merchant's brand color. | #FF5733 |
merchant_message |
OptionalNullable[str] | ➖ | A message from the merchant. | Thank you for your purchase! |
merchant_terms_and_conditions_url |
OptionalNullable[str] | ➖ | URL to the merchant's terms and conditions. | https://merchant.example.com/terms |
merchant_favicon_url |
OptionalNullable[str] | ➖ | URL to the merchant's favicon. | https://merchant.example.com/favicon.ico |
amount |
int | ✔️ | The amount for the payment link. | 1299 |
country |
str | ✔️ | The country code for the payment link. | DE |
currency |
str | ✔️ | The currency code for the payment link. | EUR |
intent |
models.TransactionIntent | ✔️ | N/A | |
return_url |
OptionalNullable[str] | ➖ | The return URL after payment completion. | https://merchant.example.com/return |
cart_items |
List[models.CartItem] | ✔️ | The cart items for the payment link. | [ { "amount": { "currency": "USD", "value": 500 }, "name": "Widget", "quantity": 2 } ] |
metadata |
Dict[str, Any] | ➖ | Arbitrary metadata for the payment link. | { "order_id": "ORD-12345" } |
payment_source |
models.TransactionPaymentSource | ✔️ | The way payment method information made it to this transaction. | |
created_at |
date | ✔️ | The date and time the payment link was created. | 2024-05-30T12:34:56.000Z |
updated_at |
date | ✔️ | The date and time the payment link was last updated. | 2024-05-30T13:00:00.000Z |
status |
models.PaymentLinkStatus | ✔️ | N/A | |
buyer |
OptionalNullable[models.TransactionBuyer] | ➖ | The buyer associated with the payment link. | |
shipping_details |
OptionalNullable[models.ShippingDetails] | ➖ | The shipping details for the payment link. | |
connection_options |
Dict[str, Dict[str, Any]] | ➖ | The connection options for the payment link. | |
store |
Optional[bool] | ➖ | Whether the payment method was stored. | |
buyer_id |
OptionalNullable[str] | ➖ | The ID of the buyer to associate with the stored payment method. | a1b2c3d4-5678-90ab-cdef-1234567890ab |
installment_count |
OptionalNullable[int] | ➖ | The number of installments a buyer is required to make. |
