POST
/
api
/
v1
/
payments
Create a Satim Payment Link
curl --request POST \
  --url http://localhost:8080/api/v1/payments \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "1500.00",
  "fail_url": "<string>",
  "success_url": "<string>",
  "description": "<string>",
  "order_ref": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_url": "<string>",
  "satim_order_id": "<string>"
}

Body

application/json

Request to create a payment link.

​
amount
string
required

Amount in DZD (decimal string). Minimum 50.00, at most 2 decimal places.

Example:

"1500.00"

​
fail_url
string
required

Where to send the customer after a failed/declined payment.

​
success_url
string
required

Where to send the customer after a successful payment.

​
description
string | null

Free-form description shown on the payment.

​
language
enum<string>

Hosted-page language (AR/FR/EN). Defaults to FR.

Available options:
AR,
FR,
EN
​
order_ref
string | null

The venture's own reference for this payment (passed to Satim as udf1).

Response

Payment link created

Response returned when a payment link is created.

​
id
string<uuid>
required
​
payment_url
string
required

The payment link the customer should be redirected to.

​
satim_order_id
string
required