Skip to main content
POST
/
v1
/
refunds
Request a refund
curl --request POST \
  --url https://api-global.fastpaybrasil.com/v1/refunds \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chargeId": "2vorkDcXyvzifL63YX09S9VqcnI",
  "reason": "Customer requested cancellation"
}
'
{
  "status": "refunded",
  "reason": null,
  "pspRefundRefId": "ref_abc123"
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.

Body

application/json
​
chargeId
string
required

ID of the charge to refund. Must be in paid status.

Example:

"2vorkDcXyvzifL63YX09S9VqcnI"

​
reason
string
required

Reason for the refund.

Example:

"Customer requested cancellation"

Response

Refund requested successfully

​
status
enum<string>

Result status of the refund operation

Available options:
refunded,
pending,
refused,
failed
Example:

"refunded"

​
reason
string | null

Reason from the PSP (null if not provided)

Example:

null

​
pspRefundRefId
string | null

PSP reference ID for the refund transaction

Example:

"ref_abc123"