Skip to content

paymentlinkcreate.md

Latest commit

 

History

History
43 lines (38 loc) · 28.2 KB

paymentlinkcreate.md

File metadata and controls

43 lines (38 loc) · 28.2 KB

PaymentLinkCreate

Example Usage

import { PaymentLinkCreate } from "@gr4vy/sdk/models/components";

let value: PaymentLinkCreate = {
  amount: 1299,
  country: "DE",
  currency: "EUR",
  store: true,
};

Fields

Field Type Required Description Example
buyer components.GuestBuyer ➖ The guest buyer for the payment link.
expiresAt Date ➖ The expiration date and time for the payment link. 2024-06-01T00:00:00.000Z
connectionOptions components.TransactionConnectionOptions ➖ Connection options for the payment link.
externalIdentifier string ➖ The merchant reference for the payment link. external-12345
statementDescriptor components.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 number ✔️ 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 components.TransactionIntent ➖ N/A
returnUrl string ➖ The return URL after payment completion. https://merchant.example.com/return
cartItems components.CartItem[] ➖ The cart items for the payment link.
metadata Record<string, any> ➖ Arbitrary metadata for the payment link. {
"order_id": "ORD-12345"
}
paymentSource components.TransactionPaymentSource ➖ The way payment method information made it to this transaction.
store boolean ➖ Whether to store the payment method for future use. true
buyerId 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 number ➖ The number of installments a buyer is required to make.