Skip to content
Gowd Platform Production

Create banking refund

POST
/order/v1/banking/order-refunds

Create a refund for a banking order.

idempotency-key
required
string

Unique key for idempotent requests

object
orderId
required

Order identifier to refund

string format: uuid
externalId

External identifier of the refund

string
amount
required

Refund amount

object
currency
required

Currency code

string
Allowed values: BRL
value
required

Amount value as numeric string

string
refundCode
required

Refund code

string
refundReason

Reason for the refund

string
description

Description of the refund

string
object
id
required

Refund identifier

string
externalId
required

External identifier

string
status
required

Status of the refund

string
endToEndId
required

EndToEnd identifier

string
amount
required

Refund amount

object
currency
required

Currency code

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

Amount value as string

string

Bad request

Forbidden

Internal error