Get a drop-in link
Fetch a single drop-in link by ID.
Authorizations
You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>.
These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.
Path Parameters
Identifier of the resource in Payrails.
Response
Success.
Unique identifier of the drop-in link.
Unique identifier of a workspace in Payrails.
Public URL that can be shared with payers.
Current status of the drop-in link.
enabled, closed, expired, deleted Total amount configured for the payment link (decimal string value, ISO 3-letter currency code).
Total amount paid so far (decimal string value, ISO 3-letter currency code).
Whether the link allows partial payments.
Workflow code used for executions created from this link.
Expiration timestamp in ISO 8601 format with timezone, e.g. 2025-03-01T23:59:59Z.
Creation timestamp of the drop-in link.
Workflow execution ID associated with the drop-in link, when one has been created.
Human-readable description of the payment link.
Merchant reference for reconciliation (commonly, the identifier of the order on the Merchant's system e.g. an invoice number).
Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our Meta Fields guide. See Meta for every field.