Skip to content

paymentlinkcreate.md

Latest commit

 

History

History
31 lines (28 loc) · 28 KB

paymentlinkcreate.md

File metadata and controls

31 lines (28 loc) · 28 KB

PaymentLinkCreate

Fields

Field Type Required Description Example
buyer OptionalNullable[models.GuestBuyer] ➖ The guest buyer for the payment link.
expires_at date ➖ The expiration date and time for the payment link. 2024-06-01T00:00:00.000Z
connection_options OptionalNullable[models.TransactionConnectionOptions] ➖ Connection options for the payment link.
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 Optional[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.
metadata Dict[str, Any] ➖ Arbitrary metadata for the payment link. {
"order_id": "ORD-12345"
}
payment_source Optional[models.TransactionPaymentSource] ➖ The way payment method information made it to this transaction.
store Optional[bool] ➖ Whether to store the payment method for future use. true
buyer_id OptionalNullable[str] ➖ 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
installment_count OptionalNullable[int] ➖ The number of installments a buyer is required to make.