Creating a payment link | Yoco Developer Hub

Create shareable payment links that customers can use to make payments without requiring integration into your website or app.

Create payment links using the Yoco Payment Links API. You require authentication using the appropriate scopes. For more information, see the Authentication documentation.

What are Yoco Payment Links?

Yoco Payment Links are secure, shareable URLs that direct customers to a Yoco payment page. They’re perfect for:

Invoice payments: Send payment links via email or text message
Once-off payments: Collect payments without building a checkout flow

Creating a Yoco Payment Link

Create the payment link

Make an authenticated POST request with the payment details.

POST

/v1/payment_links/

1 curl -X POST https://api.yoco.com/v1/payment_links/ \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "amount": {
6     "amount": 1500,
7     "currency": "ZAR"
8   },
9   "customer_reference": "Peter Parker",
10   "customer_description": "This description is visible to the customer on the payment page."
11 }'

For more information on the request body and response, see the create payment link API reference.

Store the response data

Save the order_id from the response - you’ll need this to verify payment status later.

1 {
2   "id": "1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4",
3   "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
4   "url": "https://pay.yoco.com/r/example",
5   "customer_reference": "John Doe",
6   "customer_description": "Invoice #12345",
7   "created_at": "2024-11-19T15:27:02+00:00"
8 }

Error handling

For more information on errors, see the error handling documentation.

Next steps

After creating a payment link, you’ll need to verify when a customer pays. Check the order status using the Orders API.