Skip to main content
POST
/
v1
/
refunds
Issue a refund
curl --request POST \
  --url https://api.getsly.ai/v1/v1/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "originalTransferId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "reasonDetails": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "original_transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": "<string>",
    "currency": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "reason_details": "<string>",
    "refund_transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key (pk_test_* or pk_live_), JWT session, agent token (agent_), Ed25519 session (sess_), or portal token (portal_).

Headers

​
x-idempotency-key
string

Body

application/json
​
originalTransferId
string<uuid>
required
​
reason
enum<string>
required
Available options:
duplicate_payment,
service_not_rendered,
customer_request,
error,
other
​
amount
number

Omit for full refund

​
reasonDetails
string
Maximum string length: 1000

Response

Refund initiated

​
data
object
required