Payment Links

https://api.payload.com/payment_links

Nested Objects

https://api.payload.com/payment_links/{id}/attachments

https://api.payload.com/payment_links/{id}/customer

https://api.payload.com/payment_links/{id}/invoice

https://api.payload.com/payment_links/{id}/notifications

https://api.payload.com/payment_links/{id}/processing

https://api.payload.com/payment_links/{id}/processing_settings

https://api.payload.com/payment_links/{id}/transaction

https://api.payload.com/payment_links/{id}/webhooks

Example

{
  "id": "pay_1IXpXbxJr05oJursSaPQp5EUX",
  "object": "payment_link",
  "amount": 484.21,
  "amount_editable": false,
  "attachments": [],
  "attrs": {},
  "created_at": "2024-08-21 13:35:03",
  "customer_fields": "required",
  "customer_id": "acct_15HtfUYqUSl3gBrbk6xHgyKH7",
  "description": "string",
  "invoice_id": "inv_1uydJ6bmQ816e9xPgS3pjd4UP",
  "modified_at": "2024-08-21 13:35:03",
  "notifications": [],
  "processing_id": "acct_hC9KmZYqbelIldN5uf7r4tDX",
  "processing_settings_id": "ps_BN6SP7B3o4F8BbO4YjzCA4yt",
  "qr_url": "string",
  "status": "active",
  "transaction_id": "txn_1RESTacHGOVYBdLLw41TZEuGq",
  "type": "one_time",
  "url": "string",
  "webhooks": [],
  "additional_datafields": [
    {
      "name": "string",
      "section": "string",
      "fields": [
        {
          "autocomplete_required": false,
          "autocomplete_url": "string",
          "confirm": true,
          "details": "string",
          "name": "string",
          "optional": false,
          "placeholder": "string",
          "readonly": true,
          "title": "string",
          "type": "string",
          "value": "string"
        }
      ]
    }
  ],
  "billing_contact": {
    "city": "string",
    "email": "string",
    "name": "string",
    "phone": "string",
    "postal_code": "postal_code",
    "state_province": "string",
    "street_address1": "string",
    "street_address2": "string",
    "website": "string"
  },
  "checkout_options": {
    "auto_billing_toggle": true,
    "bank_account_payments": false,
    "billing_address": false,
    "card_payments": true,
    "default_payment_option": "card",
    "enable_mobile_wallets": false,
    "enable_plaid": true,
    "keep_active_toggle": false,
    "payment_method_preview": false,
    "show_disclosure": false,
    "payment": {
      "status": "authorized"
    }
  }
}

Attributes	Description
`id` string readonly	Object ID
`object` string readonly	Value: payment_link
`amount` number	Total amount due
`amount_editable` bool	Allow the amount to be editable
`attachments` list	Array of associated Payment Link Attachment objects
`attrs` json	Custom object attributes
`created_at` datetime readonly	None
`customer_fields` string	Values: required optional disabled
`customer_id` id	ID of the associated Customer Account object
`description` string	Description of the payment
`invoice_id` id	ID of the associated Invoice object
`modified_at` datetime readonly	None
`notifications` list	Array of associated Notification objects
`processing_id` id required	ID of the associated Processing Account object
`processing_settings_id` id readonly: update	ID of the processing settings object
`qr_url` string readonly	A qr code version of the URL
`status` string readonly: method	Values: active sent received opened bounced completed inactive expired
`transaction_id` id readonly: method	ID of the Transaction object
`type` string	Arbitrary type classification
`url` string readonly	The URL to be used by client(s) to make payments
`webhooks` list	Array of associated Webhook objects

additional_datafields:
`name` string	Custom form name
`section` string	Field section name

fields:
`autocomplete_required` bool	Value must be in autocomplete list
`autocomplete_url` string	URL of autocomplete values. Expects json array of strings
`confirm` bool	Field requires confirm
`details` string	Description of field
`name` string	Custom form name
`optional` bool	Specify field as optional
`placeholder` string	Placeholder input value
`readonly` bool	Specify field as readonly
`title` string	Title for the field
`type` string	Field type: text, date, checkbox, etc
`value` string	Default value

billing_contact:
`city` string readonly	City of the billing contact
`email` string readonly	Email of the billing contact
`name` string readonly	Name of the billing contact
`phone` string readonly	Phone number of the billing contact
`postal_code` postal_code readonly	Zipcode of the billing contact
`state_province` string readonly	State of the billing contact
`street_address1` string readonly	Street address of the billing contact
`street_address2` string readonly	Street address 2 of the billing contact
`website` string readonly	Website of the billing contact

checkout_options:
`auto_billing_toggle` bool	Include a toggle to enroll in autopayments
`bank_account_payments` bool	Enable/disable card payments
`billing_address` bool	Require billing address
`card_payments` bool	Enable/disable card payments
`default_payment_option` string	Select payment method option to select by default
`enable_mobile_wallets` bool	Enable Google/Apple Pay
`enable_plaid` bool	Enable linking bank accounts with Plaid
`keep_active_toggle` bool	Include a toggle to remember a payment method
`payment_method_preview` bool	Display a preview of the payment method
`show_disclosure` bool	Include the standard checkout disclosure

payment:
`status` string	Set transaction to be authorized/processed