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

201CreateBusinessPixAccountResponse

Response Body

object

data

object

Show 9 properties

string

Required

Unique system generated identifier for the entity.

status

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.

Allowed valuespendingcompletefailed

description

string

Required

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

trackingRef

string

Required

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

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.

riskEvaluation

object

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

Show 2 properties

decision

string

Enumerated decision of the account.

Allowed valuesapproveddeniedreview

reason

string

Risk reason for the definitive decision outcome.

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.

createDate

string

Required

ISO-8601 UTC date/time format.

updateDate

string

Required

ISO-8601 UTC date/time format.

400BadRequest

401NotAuthorized

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?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy