Vinculação do cartão combo a uma conta

beta

Este endpoint possibilita vincular um cartão do tipo combo a uma conta bancária. Desse modo, a modalidade de débito do cartão será ativada.

🚧

Importante

A vinculação de um cartão a uma conta bancária só é realizada uma vez e não pode ser desfeita.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que o cliente do parceiro Bankly:

  • Possua uma conta ativa;
  • Tenha criado um cartão do tipo combo somente com o crédito habilitado (sem informar agência e conta no momento da emissão), e que nunca tenha sido vinculado a uma conta bancária.

Requisição (Request)

PATCH 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/account'
--request PATCH 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/account' \
--header 'api-version: 1' \ 
--header 'Authorization: Bearer {{Token}}' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ 
     "account": {
          "branch": "0001", 
          "number": "62150075442" 
     }
}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

ScopeDescrição
card.updateConcede acesso para realizar atualizações no cartão.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição, envie o seguinte campo:

NomeTipoDescriçãoEspecificação
proxypathObrigatório. Código identificador do cartão.Insira somente números, sem caracteres especiais.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

NomeTipoDescriçãoEspecificação
accountobjectObrigatório. Objeto que deverá conter informações sobre a conta bancária à qual o cartão será vinculado.
account.branchstringObrigatório. Número da agência.4
account.numberstringObrigatório. Número da conta.
{
   "account": {
     "branch": "0001", 
     "number": "62150075442" 
	}
}

Resposta (Response)

O status code 202 indicará que a solicitação foi aceita e que o cartão está sendo vinculado à conta.

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status CodeCódigoMensagemDescrição
404100Program not found!Programa não encontrado.
404002Card not found!Cartão não encontrado.
406102Program undefined!Programa indefinido.
406101Program disable!Programa desativado.
406203The account is inactive!Conta bancária desativada.
409OPERATION_INVALID_FOR_CARD_NOT_BINDED_TO_CUSTOMEROperation Invalid. The card is not binded to a customer.Operação inválida. O cartão foi desvinculado para o cliente.
409BANKING_LICENSE_NOT_FOUNDThe banking license was not found!Licença bancária não encontrada.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são:

Nome do eventoDescrição
CARD_WAS_BINDED_WITH_NEW_ACCOUNTUm cartão do tipo combo foi vinculado a uma conta.
CARD_FUNCTION_WAS_MODIFIEDUm cartão do tipo combo teve o status de uma de suas modalidades (débito ou crédito) alterado.

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados