search

Create Inbound Bank Account

hashtag
Create Inbound Bank Account

POST {{Environment_URL}}/customers/v1/partner/physical/:cpf/accounts/inbound

This route creates a new inbound bank account record for a client, which is necessary for inbound remittance operations. There are two ways one can create an account: with a PIX Key body or a Bank Account body.

hashtag
PIX Key Body

Attribute
Description
Type
Required

name

Client name

String

Yes

currency

Received currency must always be BRL

String

Yes

pixKey

The identification for a specific PIX Type

String

Yes

pixType

Can be CPF, PHONE, EMAIL or HASH

String

Yes

purposeCode

Generated quotation Purpose Code

String

Yes

paymentMethod

Account payment method, in this case must be PIX

String

Yes

hashtag
Bank Account Body

Attribute
Description
Type
Required

name

Client name

String

Yes

bankName

Account bank name. 336 - Banco C6 S.A.

String

Yes

bankBranch

Account branch. 0001

String

Yes

bankCode

COMPE code formed by three digits code identifiyng the bank. 336

String

Yes

bankAccountType

Can be CH (Checking) or SA (Savings)

String

Yes

number

Bank account number. 38491419-5

String

Yes

currency

Received currency must always be BRL

String

Yes

purposeCode

Generated quotation Purpose Code

String

Yes

paymentMethod

Account payment method, in this case must be BANK_ACCOUNT

String

Yes

hashtag
Path Params

Attribute
Description
Type
Required

cpf

Client CPF document. For example 123.456.789-00

String

Yes

hashtag
Headers

Name
Value
Description

authorization

Bearer <token>

Bearer Token obtained via sign-in

client-key

123ABCD456

Client authentication key, obtained via webhook.

hashtag
Request Body

hashtag
Response

PreviousInbound Bank Accounts - Physical PersonNextList Inbound Bank Accounts

Last updated