Skip to main content
POST
Create a PIX bank account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
idempotencyKey
string<uuid>
required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

name
string
required

Name of the beneficiary.

Example:

"CIRCLE INTERNET FINANCIAL INC"

accountNumber
string
required

Beneficiary account number.

Example:

"322286803"

ispb
string
required

Beneficiary ISPB.

Example:

"68033222"

branchCode
string
required

Beneficiary account branch code.

Example:

"123"

taxId
string
required

Beneficiary Tax ID.

Example:

"57112345675712"

accountType
enum<string>
required

Beneficiary account type.

Available options:
checking,
savings,
salary,
prepaid
Example:

"checking"

Response

Successfully created a bank account for PIX transfers.

data
object