🚧 This project is currently in active development. A sandbox environment will be made available soon for testing and exploration. Stay tuned!
Create a payment link
Sandbox
Sandbox
POST
/v1/payment-links/create
send_email and send_sms ask the payment gateway tonotify the customer at create time; there is no separate share call. Both default to
false, so a request that omits them creates the link and sends nothing — you areexpected to deliver
short_url yourself.default. That asymmetry is deliberate: the API defaults to the non-surprising behaviour
for integrators (no outbound message you did not ask for), while the portal defaults to
the behaviour an operator creating a link by hand almost always wants. Set
send_email: true explicitly if you want the portal's behaviour.sends array onGET /v1/payment-links/{linkId}.Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/payment-links/create' \
--header 'api_key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"merchant_id": 0,
"amount": 0,
"expires_at": "string",
"description": "string",
"customer_email": "user@example.com",
"customer_name": "string",
"phone_number": "string",
"send_email": false,
"send_sms": false,
"sale_type": "pay_by_link",
"order_id": "string",
"shopper_id": "string",
"webhook_url": "http://example.com",
"redirect_url": "http://example.com",
"cancel_url": "http://example.com",
"back_url": "http://example.com"
}'Response Response Example
201 - Example 1
{
"data": {
"id": 0,
"order_ref": "string",
"short_code": "string",
"short_url": "string",
"amount": 0,
"currency_code": "string",
"description": "string",
"customer_email": "string",
"customer_name": "string",
"phone_number": "string",
"sale_type": "pay_by_link",
"status": "active",
"effective_status": "string",
"expires_at": "string",
"created_by_email": "string",
"deactivated_at": "string",
"created_at": "string",
"merchant_id": 0
}
}