Create a payment request and deliver it to the recipient. The recipient then has a designated amount of time to respond (90 seconds by default), either by paying or rejecting. If no action is taken, the payment request expires and the recipient can no longer pay.
When the payment request status has changed, a notification callback is posted to the URL defined in notify_url with the payment request data. If a notify_url is not defined, no notification callback is posted.
Request
Response
POST /v1/requests
Key
Type
Description
amount
float
The amount being requested. required
currency
string
Three-letter ISO-4217 code. Must be a supported currency. required
description
string
Message to payer.
image_url
string
URL to an image which the payer will see.
order
string
Custom value which will be returned in the notification callback data. The payer never sees this value.
recipient
string
A recipient's username or phone number. Phone number can include the country code (not required). Adding multiple recipients is currently not supported.
terminal
int
Custom value which will be returned in the notification callback data. The payer never sees this value.
expires_in
int
Expiry time in seconds. Minimum 10 seconds, maximum 7 days. Default value is 90 seconds.
notify_url
string
If this URL is defined you will receive a notification callback from the API with the payment data (and a signature) when the payment request status changes.
Get a single payment request's status and expiration timestamp. This may be more convenient than getting the entire payment request object if you only need to know the status.
Request
Response
GET /v1/requests/{id}/status
200 OK
Key
Type
Description
id
uuid
The unique identifier for the payment request.
status
string
The payment request status. Note: Rejected can either mean that the payer declined or the payment request expired.
pending
paid
rejected
expires
int
The date and time when the payment request expires. UTC (GMT +0) UNIX timestamp.