v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Cards

Listar cartões

get/{companyId}/banking/cards

Path parameters

companyIdstring required

CNPJ da empresa

Query parameters

itemsPerPageinteger nullable

Número de itens por página

cursorstring nullable

Cursor para paginação dos resultados

pageinteger nullable

Número da página

ownerDocumentstring nullable

CPF ou CNPJ do dono do cartão

statusstring nullable

Status do cartão

last4Digitsstring nullable

Últimos 4 dígitos do cartão

isContactlessEnabledboolean nullable

Indica se o cartão tem aproximação habilitada

isTravelNoticeEnabledboolean nullable

Indica se o aviso de viagem está habilitado

isOnlineShoppingEnabledboolean nullable

Indica se compras online estão habilitadas

isWithdrawalEnabledboolean nullable

Indica se saques estão habilitados

printedNamestring nullable

Nome impresso no cartão

orderstring nullable

Ordem de exibição dos resultados

sortBystring nullable

Campo para ordenação dos resultados

limitOperatorstring nullable

Operador para filtro de limite do cartão

limitAmountstring nullable

Valor para filtro de limite do cartão

Response

Success

Example response

{
  "data": [
    {
      "cardId": "f47d235c-17de-4e4b-87eb-a60208acf11f",
      "last4Digits": "1234",
      "status": "REQUESTED",
      "printedName": "JOAO DA SILVA",
      "modality": "DEBIT",
      "variant": "GOLD",
      "activatedAt": "2023-01-15",
      "type": "PHYSICAL",
      "owner": {
        "document": "11111111111",
        "name": "JOAO DA SILVA",
        "birthDate": "1980-01-01",
        "phone": "+5511999999999"
      },
      "debitAccount": {
        "branch": "50",
        "number": "12345-6"
      }
    }
  ],
  "_links": [
    {
      "rel": "self",
      "href": "/direct-debits/d2627834-dd84-4094-9dcf-ca784460b352",
      "method": "DELETE",
      "type": "application/json"
    }
  ]
}