Cadastro de cartão de crédito/débito

De RBX ISP - Manual do Usuário
Revisão de 09h01min de 4 de junho de 2021 por Felipe (discussão | contribs) (Criou página com 'O objetivo deste serviço é realizar a inclusão de um cartão de crédito/débito para um cliente ou mercado. Abaixo, segue exemplo do json de envio: <syntaxhighlight lang=...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

O objetivo deste serviço é realizar a inclusão de um cartão de crédito/débito para um cliente ou mercado. Abaixo, segue exemplo do json de envio:

{
  "payment_card_insert":
  {
    "person":
    {
      "type": "customer",
      "id": 15
    },
    "card":
    {
      "number": "6548654825149256",
      "holder": "Jose Bonifacio da Silva",
      "expiration_date": "12/2020",
      "brand": "visa",
      "type": "credit",
      "default": true,
      "generate_token": true,
      "security_code": "2545"
    }
  }
}

Detalhamento dos campos

ID Campo Obrigatório Pai Tipo Observações
A01 payment_card_insert Sim Raiz -  
A02 person Sim A01 -

Grupo de informações da pessoa

B01 type Sim A02 Texto

Define o alvo, podendo ser:

  • customer: cliente
  • prospect: mercado
B02 id Sim A02 Número

Código do cliente/mercado (conforme o campo anterior). Aceita valores positivos maiores que zero.

A03 card Sim A01 -

Grupo de informações do cartão.

C01 number Sim A03 Texto

Número do cartão sem pontuação. Aceita números entre 13 e 19 dígitos.

C02 holder Sim A03 Texto

Nome do portador do cartão. Aceita no máximo 30 dígitos. Informar sem caracteres especiais ou acentuações.

C03 expiration_date Sim A03 Data

Data de expiração do cartão no formato MM/AAAA. Aceita períodos maiores ou iguais à data atual.

C04 brand Sim A03 Texto

Bandeira do cartão. Valores válidos (até 08/2020 para Administradora de cartões Cielo):

  • amex: American Express
  • diners: Diners
  • elo: Elo
  • hipercard: Hipercard
  • jcb: JCB
  • master: MasterCard
  • discover: Discover
  • aura: Aura
  • visa: Visa
C05 type Sim A03 Texto

Tipo do cartão. Valores válidos:

  • credit: cartão de crédito
  • debit: cartão de débito
  • multiple: múltiplo (crédito e débito)
C06 default Não A03 Booleano

Define se o cartão informado será definido como o cartão padrão do cliente utilizado para cobranças recorrentes. Atenção: requer um cartão com a função débito. Valores permitidos:

  • true: define o cartão como padrão.
  • false: não define o cartão como padrão.
C07 generate_token Não A03 Booleano

Define se deverá ser gerado o token do cartão para cobranças periódicas. Valores permitidos:

  • true: gera token do cartão.
  • false: não gera token do cartão.
C08 security_code Não* A03 Texto

Código de segurança do cartão. Este campo aceita apenas números. Este campo é obrigatório se o campo generate_token foi definido como true.

 

Mensagem de retorno

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result":
  {
    "card_id": 22,
    "generated_token": true
  }
}

Em caso de falha, será retornado um json conforme o exemplo abaixo:

{
  "status": 0,
  "error_code": 19,
  "error_description": "Unknown error!",
  "result": ""
}