Skip to main content
POST
/
v1
/
refunds
Create a refund
curl --request POST \
  --url https://api.stan-app.fr/v1/refunds \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "reason": "requested_by_customer"
}'
{
  "refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_id": "<string>",
  "amount": 123,
  "status": "payment_holding",
  "reason": "requested_by_customer",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
payment_id
string<uuid>
required

Payment ID linked to this refund

​
amount
integer
required

Amount in cents

​
reason
enum<string>
required

Reason for the refund

Available options:
requested_by_customer,
duplicate,
fraudulent

Response

Successful operation

​
refund_id
string<uuid>
​
payment_id
string<string>
​
amount
integer

Amount in cents

​
status
enum<string>

Status of the refund, a refund is a reversed payment

Available options:
payment_holding,
payment_pending,
payment_failure,
payment_success,
payment_cancelled
​
reason
enum<string>

Reason for the refund

Available options:
requested_by_customer,
duplicate,
fraudulent
​
created_at
string<date-time>