Skip to main content
POST
/
refund-payment
/
{payment_id}
Refund Payment
curl --request POST \
  --url https://api.atlas.co/functions/v1/refund-payment/{payment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "reason": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "currency": "<string>",
  "status": "pending",
  "reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Path Parameters

payment_id
string<uuid>
required

Body

application/json
amount
integer

Partial refund amount in cents

reason
string

Response

Refund created

id
string<uuid>
payment_id
string<uuid>
amount
integer
currency
string
status
enum<string>
Available options:
pending,
succeeded,
failed
reason
string
created_at
string<date-time>