List Inbound Bank Accounts

GET {{Environment_URL}}/customers/v1/partner/physical/:cpf/accounts/inbound

This route list all inbound bank accounts record for a client.

Path Params

Attribute
Description
Type
Required

cpf

Client CPF document. For example 123.456.789-00

String

Yes

Headers

Name
Value
Description

authorization

Bearer <token>

Bearer Token obtained via sign-in

client-key

123ABCD456

Client authentication key, obtained via webhook.

Response

[
  {
    "id": "69440c9bcc731f14f8008a1f",
    "name": "JOHN DOE",
    "type": "INBOUND",
    "currency": "BRL",
    "createdAt": "2025-12-18T14:15:55.282Z",
    "pixKey": "123.456.789-00",
    "pixType": "CPF",
    "paymentMethod": "PIX",
    "purposeCode": "MAINTENANCE",
    "hateoas": {
      "self": {
        "remove": {
          "href": "/customers/physicals/123.456.789-00/accounts/69440c9bcc731f14f8008a1f",
          "rel": "DELETE"
        },
        "read": {
          "href": "/customers/physicals/123.456.789-00/accounts/69440c9bcc731f14f8008a1f",
          "rel": "GET"
        }
      },
      "create": {
        "accountInbound": {
          "href": "/customers/physicals/123.456.789-00/accounts/inbound",
          "rel": "POST"
        },
        "accountOutboundUsd": {
          "href": "/customers/physicals/123.456.789-00/accounts/outbound/usd",
          "rel": "POST"
        },
        "accountOutboundCad": {
          "href": "/customers/physicals/123.456.789-00/accounts/outbound/cad",
          "rel": "POST"
        },
        "accountOutboundEur": {
          "href": "/customers/physicals/123.456.789-00/accounts/outbound/eur",
          "rel": "POST"
        },
        "accountOutboundGbp": {
          "href": "/customers/physicals/123.456.789-00/accounts/outbound/gbp",
          "rel": "POST"
        },
        "accountOutboundArs": {
          "href": "/customers/physicals/123.456.789-00/accounts/outbound/ars",
          "rel": "POST"
        },
        "accountOutboundPen": {
          "href": "/customers/physicals/123.456.789-00/accounts/outbound/pen",
          "rel": "POST"
        },
        "accountOutboundAud": {
          "href": "/customers/physicals/123.456.789-00/accounts/outbound/aud",
          "rel": "POST"
        }
      }
    }
  }
]

Last updated