Get PIX instructions

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

GET /v1/businessAccount/banks/pix/{id}/instructions

Get PIX instructions

cURL

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

200

{
  "data": {
    "trackingRef": "CIR25XSXT8",
    "ispb": "68033222",
    "branchCode": "123",
    "accountNumber": "322286803",
    "accountType": "checking",
    "taxId": "57112345675712",
    "name": "CIRCLE INTERNET FINANCIAL INC"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> · required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Response

200

application/json

Successfully retrieved PIX transfer instructions for the bank account.

data · object

Show child attributes