Get payment link
Retrieve details of a specific payment link.
Authorizations
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Path Parameters
The unique identifier for the payment link.
Response
Payment link details.
A hosted payment link created from a payment intent that can be shared with customers.
Unique identifier for the payment link.
"j47ac10b-58cc-4372-a567-0e02b2c3d479"
The URL where customers can complete their payment.
"https://checkout.yourapp.com/pay/j47ac10b-58cc-4372-a567-0e02b2c3d479"
Current status of a payment link.
ACTIVE, EXPIRED, COMPLETED, CANCELED, FAILED When the payment link was created.
"2024-01-15T10:00:00Z"
When the payment link was last updated.
"2024-01-15T10:00:00Z"
The order this payment link collects payment for.
"44567801-a504-4f09-8089-31ea78bc239b"
The customer this payment link collects payment from.
"a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d"
Payment service provider that processes the transaction.
STRIPE, BILLOGRAM "STRIPE"
The saved payment method pre-selected for the customer, if any.
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
Optional description displayed on the payment page.
"Pay your monthly subscription"
The payment intent that collected the payment, available once the link has been paid.
"64870b5c-fb61-4c9a-955a-e148e0826c20"
When the payment was completed, if the link has been paid.
"2024-01-15T14:30:00Z"
A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.