API Reference

Create a PIX bank account

posthttps://api-sandbox.circle.com/v1/businessAccount/banks/pix

  • Reference
  • Playground
Body parameters
accountType
string
Required

Beneficiary account type.

Allowed valuescheckingsavingssalaryprepaid
taxId
string
Required

Beneficiary Tax ID.

branchCode
string
Required

Beneficiary account branch code.

ispb
string
Required

Beneficiary ISPB.

accountNumber
string
Required

Beneficiary account number.

name
string
Required

Name of the beneficiary.

idempotencyKey
string
Required

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

Response
RequestChoose a language
ResponseChoose an example
1{
2  "data": {
3    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4    "status": "pending",
5    "description": "BTG Pactual ****0010",
6    "trackingRef": "CIR13FB13A",
7    "transferTypesInfo": {
8      "pix": {
9        "currencies": [
10          "BRL"
11        ]
12      }
13    },
14    "riskEvaluation": {
15      "decision": "approved",
16      "reason": "3000"
17    },
18    "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2",
19    "createDate": "2020-04-10T02:13:30.000Z",
20    "updateDate": "2020-04-10T02:13:30.000Z"
21  }
22}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.