Create banking refund

POST

/order/v1/banking/order-refunds

• Production
• Sandbox

Create a refund for a banking order.

Authorizations

• Bearer

Parameters

Header Parameters

idempotency-key

required

string

Unique key for idempotent requests

Request Body ^required

object

orderId

required

Order identifier to refund

string format: uuid

Example

f288ae0d-47fd-4207-aee4-0a384888bd96

externalId

External identifier of the refund

string

Example

refund-123

amount

required

Refund amount

object

currency

required

Currency code

string

Allowed values: BRL

Example

BRL

value

required

Amount value as numeric string

string

Example

10.00

Example

{
  "currency": "BRL",
  "value": "10.00"
}

refundCode

required

Refund code

string

Example

RECEIVER_REQUEST

refundReason

Reason for the refund

string

Example

Customer requested refund

description

Description of the refund

string

Example

Partial refund for order #123

Responses

200

object

id

required

Refund identifier

string

Example

c1c4c0b1-3bb8-4b1c-9e47-3f4a6f3a1b2c

externalId

required

External identifier

string

Example

refund-123

status

required

Status of the refund

string

Example

PENDING

endToEndId

required

EndToEnd identifier

string

Example

E12345678920240101120000abcd

amount

required

Refund amount

object

currency

required

Currency code

string

Allowed values: BRL USD ARS EUR CLP COP MXN PEN BUSD USDT

Example

BRL

value

required

Amount value as string

string

Example

10.00

Example

{
  "currency": "BRL",
  "value": "10.00"
}

400

Bad request

403

Forbidden

500

Internal error