API Reference

Web3 Services

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Circle Contracts

Templates

View / Update

Interact

Deploy / Import

Event Monitors

Modular Wallets

Transfers

UserOps

Wallets

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Get PIX instructions

gethttps://api-sandbox.circle.com/v1/businessAccount/banks/pix/{id}/instructions

Reference
Playground

Get the PIX transfer instructions into the Circle bank account given your bank account id.

Path parameters

uuid

Required

Universally unique identifier (UUID v4) of a resource.

Response

200BusinessPixAccountInstructionsResponse

Response Body

object

data

object

Show 7 properties

trackingRef

string

Circle tracking reference that needs to be set in the PIX reference field.

ispb

string

ISPB of beneficiary's bank.

branchCode

string

Beneficiary account branch code.

accountNumber

string

Beneficiary account number.

accountType

string

Beneficiary account type.

Allowed valuescheckingsavingssalaryprepaid

taxId

string

Beneficiary Tax ID.

name

string

Name of the beneficiary.

401NotAuthorized

404NotFound

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "trackingRef": "CIR25XSXT8",
4    "ispb": "68033222",
5    "branchCode": "123",
6    "accountNumber": "322286803",
7    "accountType": "checking",
8    "taxId": "57112345675712",
9    "name": "CIRCLE INTERNET FINANCIAL INC"
10  }
11}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy