POST
/
api
/
v1
/
payments
/
{id}
/
refund
Refund a Payment
curl --request POST \
  --url http://localhost:8080/api/v1/payments/{id}/refund \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "1000.00"
}
'
{
  "amount": "1500.00",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "fail_url": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "language": "<string>",
  "satim_order_number": "<string>",
  "success_url": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "venture_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "action_code": "<string>",
  "action_code_description": "<string>",
  "description": "<string>",
  "form_url": "<string>",
  "masked_pan": "<string>",
  "order_ref": "<string>",
  "paid_at": "2023-11-07T05:31:56Z",
  "satim_error_code": "<string>",
  "satim_order_id": "<string>",
  "satim_order_status": 123
}

Path Parameters

​
id
string<uuid>
required

Payment UUID

Body

application/json

Optional body for a refund. Omit or {} for a full refund.

​
amount
string | null

Partial refund amount in DZD. Defaults to the full payment amount.

Example:

"1000.00"

Response

Refund accepted; payment marked REFUNDED

​
amount
string
required
Example:

"1500.00"

​
created_at
string<date-time>
required
​
currency
string
required
​
fail_url
string
required
​
id
string<uuid>
required
​
language
string
required
​
satim_order_number
string
required
​
status
enum<string>
required

Lifecycle status of a payment.

Available options:
PENDING,
PAID,
FAILED,
REFUSED,
CANCELED,
REFUNDED,
EXPIRED
​
success_url
string
required
​
updated_at
string<date-time>
required
​
venture_id
string<uuid>
required
​
action_code
string | null
​
action_code_description
string | null
​
description
string | null
​
form_url
string | null
​
masked_pan
string | null
​
order_ref
string | null
​
paid_at
string<date-time> | null
​
satim_error_code
string | null
​
satim_order_id
string | null
​
satim_order_status
integer<int32> | null