Create a PIX bank account

curl --request POST \
  --url https://api-sandbox.circle.com/v1/businessAccount/banks/pix \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "name": "CIRCLE INTERNET FINANCIAL INC",
  "accountNumber": "322286803",
  "ispb": "68033222",
  "branchCode": "123",
  "taxId": "57112345675712",
  "accountType": "checking"
}
'

{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "status": "pending",
    "description": "BTG Pactual ****0010",
    "trackingRef": "CIR13FB13A",
    "transferTypesInfo": {
      "pix": {
        "currencies": [
          "BRL"
        ]
      }
    },
    "riskEvaluation": {
      "decision": "approved",
      "reason": "3000"
    },
    "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2",
    "createDate": "2020-04-10T02:13:30.000Z",
    "updateDate": "2020-04-10T02:13:30.000Z"
  }
}

POST

businessAccount

banks

pix

Create a PIX bank account

curl --request POST \
  --url https://api-sandbox.circle.com/v1/businessAccount/banks/pix \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "name": "CIRCLE INTERNET FINANCIAL INC",
  "accountNumber": "322286803",
  "ispb": "68033222",
  "branchCode": "123",
  "taxId": "57112345675712",
  "accountType": "checking"
}
'

{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "status": "pending",
    "description": "BTG Pactual ****0010",
    "trackingRef": "CIR13FB13A",
    "transferTypesInfo": {
      "pix": {
        "currencies": [
          "BRL"
        ]
      }
    },
    "riskEvaluation": {
      "decision": "approved",
      "reason": "3000"
    },
    "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2",
    "createDate": "2020-04-10T02:13:30.000Z",
    "updateDate": "2020-04-10T02:13:30.000Z"
  }
}

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

Show child attributes

data.id

string<uuid>

required

Unique system generated identifier for the entity.

Example:

"b8627ae8-732b-4d25-b947-1df8f4007a29"

data.status

enum<string>

required

Status of the account. A pending status indicates that the linking is in-progress; complete indicates the account was linked successfully; failed indicates it failed.

Available options:

pending,

complete,

failed

data.description

string

required

Bank name plus last four digits of the PIX account number.

Example:

"BTG Pactual ****0010"

data.trackingRef

string

required

Wire tracking ref that needs to be set in the wire reference to beneficiary field.

Example:

"CIR13FB13A"

data.transferTypesInfo

object

required

A <TransferType, TransferTypeInfo> map which shows transfer types supported on this account as well as additional information for each. For PIX accounts this will always only show information for PIX transfers.

Show child attributes

data.transferTypesInfo.{key}

object

Additional information for specific transfer type.

Show child attributes

data.transferTypesInfo.{key}.currencies

enum<string>[]

required

Currency code.

Available options:

USD,

EUR,

MXN,

SGD,

BRL

data.transferTypesInfo.{key}.additionalProperties

object

Additional properties that apply to specific transfer type.

Show child attributes

data.transferTypesInfo.{key}.additionalProperties.transactionLimits

integer

Transaction amount limit for the transfer type.

Example:

100000

Example:

{ "pix": { "currencies": ["BRL"] } }

data.fingerprint

string

required

A UUID that uniquely identifies the account number. If the same account is used more than once, each card object will have a different id, but the fingerprint will stay the same.

Example:

"eb170539-9e1c-4e92-bf4f-1d09534fdca2"

data.createDate

string

required

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

data.updateDate

string

required

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

data.riskEvaluation

object

Results of risk evaluation. Only present if the payment is denied by Circle's risk service.

Show child attributes

data.riskEvaluation.decision

enum<string>

Enumerated decision of the account.

Available options:

approved,

denied,

review

data.riskEvaluation.reason

string | null

Risk reason for the definitive decision outcome.

Example:

"3000"

List all PIX bank accounts.

Get a PIX bank account

Core API

API Overview

Crypto Deposits API

Crypto Payouts API

Cross-Currency API

Reserve Management API

Create a PIX bank account

Authorizations

Body

Response