-
- abort-payment-on-terminal
- cancel-payment
- capture-payment
- filter-payments
- find-payment
- initiate-payment-flow
- list-activity-logs
- list-installment-issuers
- list-payment-activities
- list-payments
- list-payments-by-contact
- list-payments-by-terminal
- refund-payment
- request-payment
- resume-payment-on-terminal
- retrieve-refund-performance
- retrieve-sales-performance
- reverse-payment
- start-payment-on-terminal
- void-payment
Send a payment link
Queues a payment link for delivery through an active email or SMS communication channel. The recipient is validated and normalized according to the selected channel.
payment_link_id
string
Required. The payment link to send.
communication_channel_id
string
Required. The active communication channel used to send the link.
recipient
string
Required. An email address for an email channel or mobile number for an SMS channel.
| Attribute | Description |
|---|---|
communication_delivery_idstring
|
Always present. The ID of the queued communication delivery. |
communication_channel_idstring
|
Always present. The communication channel used for this delivery. |
payment_link_idstring
|
Always present. The payment link sent to the recipient. |
deliverystring
|
Always present. How the message is delivered. Possible values:
|
recipientstring
|
Always present. The email address or mobile number. |
contact_idstring
|
Nullable. The contact matched by the recipient. Null when no contact matches. |
statusstring
|
Always present. The current delivery status. Accepted means the provider accepted the message. Possible values:
|
created_atnumber
|
Always present. When the delivery was queued. |
accepted_atnumber
|
Nullable. When the provider accepted the message. |
NOT_FOUND
The payment link or communication channel does not exist for this merchant.
BAD_REQUEST
The payment link, channel, or recipient cannot be used for this delivery.
UNHANDLED_ERROR
This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.
INVALID_ARGUMENTS
This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.
BAD_VERSION
This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.
