Skip to content
Gowd Platform

Brazil payout - V3

PUT
/order/v3/payout/brazil
 
  Request a payout for Brazil country

NOTE: Please, to authenticate use the scope: “api://app-order-prd”

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
idempotency-key
required
string format: uuid

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request Body required

Section titled “Request Body required ”
object
amount
required

The payout amount

object
currency
required

The currency of the transaction.

string
Allowed values: BRL USDT
Example
BRL
value
required

The amount of the transaction, in minor units.

Minor Units Format

All amount values must be formatted in that currency’s smallest unit. Two-decimal currency (for example Brazilian Real): R$ 10.95 BRL, amount will be “10.95”.

Click in the link bellow to see the latest official ISO 4217 Currency Table, with Minor Units (number of decimal places) per currency.

https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes

string
Example
10.95
paymentMethod

Payment Method

string
Allowed values: PIX TED TETHER
customer
required

The payout customer

object
fullName
required

Customer fullName

string
Example
John Doe Martins
email

Customer email

string
Example
john@domain.com
phone

Customer phone

string
Example
51999999
birth

The date of birth or foundation, in ISO-8601 YYYY-MM-DD format.

string
Example
1984-03-16
document
required

Document

object
type
required

The document type

string
Allowed values: CPF CNPJ
Example
CPF
number
required

The document number

string
Example
123.456.789-01
bank
required

The payout bank information

OBS: If you send this pix data, you don’t need to send the account data or vice-versa

object
pix
required

Pix information data

OBS: If you send this data, you don’t need to send the account data

object
qrcodeData
required

QR code data

OBS: If you send this qrcodeData, you don’t need to send the type and key

string
Example
00020101021126440014br.gov.bcb.PIX0126fulano.tal@provedor.com.br52040 00053039865802BR5913Fulano de Tal6009Sao Paulo6304DFE3
type
required

Pix key type

string
Allowed values: CPF CNPJ EMAIL PHONE RANDOM
Example
EMAIL
key
required

Pix key

Examples: - email: jhon@domain.com - phone: +5511999999999 - cpf: 12345678900 - cnpj: 12345678900000 - random: 8c0f58b9-3976-44e5-a25f-35d8485100b3

string
Example
jhon@domain.com
account
required

Bank account information data

OBS: If you send this data, you don’t need to send the pix data

object
bankNumber
required

The bank number accept the ISPB or COMPE number.

ISPB number is composed by 8 numerical digits like “12345678”. If you decide to use the IPSB, you can find it in the bank list in the following link: https://www.bcb.gov.br/estabilidadefinanceira/participantespix

COMPE number is composed by 3 numerical digits like “123”. If you decide to use the COMPE, you can find it in the bank list in the following link: https://www.bcb.gov.br/content/estabilidadefinanceira/str1/ParticipantesSTR.pdf

string
Example
12345678
branchNumber
required

The bank branch number (Agência)

string
Example
6770
accountNumber
required

The bank account number

string
Example
123452
accountType
required

Account Type Examples: - CHECKING - PAYMENT - WAGE - SAVINGS

string
Allowed values: CHECKING WAGE SAVINGS PAYMENT
Example
CHECKING
crypto

Crypto

object
address
required

The crypto wallet address

string
Example
0x1234567890123456789012345678901234567890
memo
required

The memo

string
Example
12345678901
description
required

The payout description.

string
webhookUrl
required

The webhook url to receive the payout status

string
Example
https://your-webhook-url.com
code
required

Order id in your system.

string
Example
order_id_in_your_system

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The resource was returned successfully

object
id
required

Payout id, unique identification

string
Example
7fa88b86-66a1-4932-b5b8-987bcef65e0b
amount
required

Payout amout

string
status
required

Payout status

string
Allowed values: INITIAL PENDING PAID EXPIRED ANALYSIS REFUNDED PARTIAL_REFUNDED PARTIALLY_PAID CANCELED ERROR
Example
PAID
fee

Fee

object
fixed
required

Fixed fee amount

object
Example
1.00
variable
required

Variable fee amount

object
Example
1.00
additional
required

Addictional fee amount

object
Example
1.00
errorMessage
required

Payout error message

string
createdAt
required

Payout creation date

string
Example
2026-08-12T23:14:50.425Z
batch

Batch information when this payout was split into a batch

object
id
required

Id of the batch

string
Example
5160c73e-8b9b-4f1f-8c64-0edcbb97c335
transactionsCount
required

Total number of child transactions in the batch

number
Example
3
paidCount
required

Number of child transactions already paid

number
Example
2
failedCount
required

Number of child transactions that failed

number
Example
1
pendingCount
required

Number of child transactions still pending

number
0
paidAmount
required

Amount already paid across all child transactions

string
Example
30000.00
pendingAmount
required

Amount still pending across all child transactions

string
Example
15000.00
transactions
required

Child transactions the batch was split into

Array<object>
object
id
required

Id of this child transaction

string
Example
a4cf980e-f66d-4321-b0f2-95c7eecca7ce
idempotencyKey
required

Idempotency key of this child transaction - the first child reuses the batch idempotencyKey verbatim, later ones suffix it

string
Example
bf8b0b1f-f444-40c5-b657-d236ee03e6ba-01
sequence
required

Ordering position of this child transaction within the batch

number
Example
1
amount
required

Amount of this child transaction

string
Example
15000.00
status
required

Status of this child transaction

string
Allowed values: INITIAL PENDING PAID EXPIRED ANALYSIS REFUNDED PARTIAL_REFUNDED PARTIALLY_PAID CANCELED ERROR
Example
PAID
endToEndId

End-to-end id of this child transaction

string
Example
E69467793202607101200Je8IkFT5JQS
paidAt

Date this child transaction was paid

string
Example
2026-07-10T12:01:03.000Z
errorMessage

Error message when this child transaction failed

string
Example
An unexpected error occurred

400

Section titled “400 ”

The request is not valid

Array<string>

403

Section titled “403 ”

Unauthorized Request

Array<string>

500

Section titled “500 ”

An unexpected error occurred inside the server

Array<string>