v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Criar cartão

Este recurso cria um card associado ao customer através do customer_id informado.

post/customers/{customer_id}/cards

Path parameters

customer_idstring required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX

Request body

numberstring required

Número do cartão. Entre 13 e 19 caracteres

holder_namestring

Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)

holder_documentstring

CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Sodexo).

exp_monthinteger required

Mês de validade do cartão. Valor entre 1 e 12 (inclusive)

exp_yearinteger required

Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.

cvvstring

Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira.

brandstring

Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, JCB, Aura, Hipercard, Diners ou Discover. Para voucher, temos como valores possíveis: Alelo, VR ou Sodexo.

labelstring

Indica a label do cartão

billing_address_idstring

Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address.

billing_addressobject

Endereço de cobrança.

optionsobject

Objeto com opções para a criação do cartão. Um exemplo de opção que pode ser adicionada ao cartão é o verify_card : true, que informa que haverá uma validação do cartão antes da utilização (Zero Dollar Auth).

metadataobject

Objeto chave/valor utilizado para armazenar informações adicionais sobre o cartão. Saiba mais sobre metadata

tokenstring

Pode ser enviado no lugar dos dados do cartão, caso este já tenha sido tokenizado previamente. Saiba mais sobre criação de token de cartão.

Response

200

idstring

first_six_digitsstring

last_four_digitsstring

brandstring

holder_namestring

holder_documentstring

exp_monthinteger

exp_yearinteger

statusstring

labelstring

created_atstring

updated_atstring

typestring

Example response

{
  "id": "card_8ELY0AwVF9HDa3jK",
  "first_six_digits": "542501",
  "last_four_digits": "7793",
  "brand": "Mastercard",
  "holder_name": "Tony Stark",
  "holder_document": "93095135270",
  "exp_month": 1,
  "exp_year": 2030,
  "status": "active",
  "label": "Sua bandeira",
  "created_at": "2017-07-07T19:50:33Z",
  "updated_at": "2017-07-07T19:50:33Z",
  "billing_address": {
    "zip_code": "220000111",
    "city": "Rio de Janeiro",
    "state": "RJ",
    "country": "BR",
    "line_1": "375, Av. General Osorio, Centro",
    "line_2": "7º Andar"
  },
  "customer": {
    "id": "cus_yoqONwOJI1IBNbjl",
    "name": "Tony Stark",
    "email": "0fee2dc5-e440-4dd1-9cd6-9c2bc90533d0@avengers.com",
    "document": "93095135270",
    "type": "individual",
    "created_at": "2017-07-07T19:50:23Z",
    "updated_at": "2017-07-07T19:50:23Z",
    "phones": {
      "home_phone": {
        "country_code": "55",
        "number": "000000000",
        "area_code": "21"
      },
      "mobile_phone": {
        "country_code": "55",
        "number": "000000000",
        "area_code": "21"
      }
    },
    "metadata": {
      "company": "Avengers"
    }
  },
  "type": "credit"
}