List all PIX bank accounts.

curl --request GET \
  --url https://api-sandbox.circle.com/v1/businessAccount/banks/pix \
  --header 'Authorization: Bearer <token>'

{
  "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"
    }
  ]
}

GET

businessAccount

banks

pix

List all PIX bank accounts.

curl --request GET \
  --url https://api-sandbox.circle.com/v1/businessAccount/banks/pix \
  --header 'Authorization: Bearer <token>'

{
  "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.

Response

Successfully retrieved all bank accounts 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 deposits

Create a PIX bank account

Core API

API Overview

Crypto Deposits API

Crypto Payouts API

Cross-Currency API

Reserve Management API

List all PIX bank accounts.

Authorizations

Response