Create Payout

Create Payout

POST {{Environment_URL}}/v1/payments/payouts/simple-pay

To create a new Payout, you need to follow a specific request depending on the desired payment method. We accept PIX or TED to create our Payouts.

Please, check our "Example Request" for more information.

Regardless of the payoutMethod chosen, every Payout may require the following fields:

Key
Description
Required?
Data type
Example value

externalId

Unique Payout identifier.

true

String

"cmpny_245193284"

amount

Value in Real (R$) cents.

true

Integer

12000

payoutMethod

Either "PIX" or "TED", depends on the desired transaction.

true

String

"PIX"

ownerDocument

Document linked to the receiving account owner. Either CPF or CNPJ.

true

String

"59552209099"

merchant

Enter your partner's name or your company name in this field.

true

String

"Frente Corretora"

metadata

Any aditional information regarding this operation.

false

Any

{ "isRegular": true, "ranking": 152, "referralCode": "4123u-123fjd" }

accountId

Sub account Identifier

false

String

"acc_01..."

payoutMethod PIX - Aditional fields

Key
Description
Required?
Data type
Example value

pixKey

PIX Key linked to client account.

true

String

"59552209099"

pixType

Available values are listed bellow, but it's not a required field.

false

String

"TAX_ID"

Available values for pixType:

Value
Description
Example pixKey for pixType

EVP

Hash PIX key.

"673878f6-4897-4ff8-8d85-883e732da347"

PHONE

Phone number PIX key.

"+5513996746072"

EMAIL

Email PIX key.

"[email protected]"

TAX_ID

CPF or CNPJ PIX key.

"59552209099"

UNKNOWN

Unknown PIX key type.

"673878f6-4897-4ff8-8d85-883e732da347" or "+5513996746072" or "[email protected]" or "59552209099"

* for every pixType, the "ownerDocument" must be filled.

payoutMethod TED - Aditional fields

Key
Description
Required?
Data type
Example value

name

Person name linked to bank account.

true

String

"John Doe"

accountNumber

Number of the account.

true

String

"357391"

branchNumber

Number of the account's branch.

true

String

"0001"

bankNumber

Number representing the bank.

true

String

"077"

accountType

Available values are listed bellow. Defines the type of the account.

true

String

"IP"

cpf

Required if the account is registered in beneficiary CPF.

false

String

"74972393092"

cnpj

Required if the account is registered in beneficiary CNPJ.

false

String

"53417122000144"

Available values for accountType:

Value
Description

CC

For checking accounts

CP

For saving accounts

IP

For payment institution accounts

Regardless of the payoutMethod chosen, every Payout may require the following fields:

Headers

Name
Value

Authorization

Bearer <token>

Request Body

Response

PreviousCreating and finding PayoutsNextList Payouts