v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Editar cartão

Com o verbo HTTP PUT, através do identificador do cartão (card_id) e do identificador do cliente ao qual o mesmo está associado (customer_id) é possível alterar dados do cartão informado.

put/customers/{customer_id}/cards/{card_id}

Path parameters

customer_idstring required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX

card_idstring required

Código do Cartão. Formato: card_XXXXXXXXXXXXXXXX.

Request body

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 Pluxee).

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.

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.

metadataobject

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

Response

200

idstring

first_six_digitsstring

last_four_digitsstring

brandstring

holder_namestring

exp_monthinteger

exp_yearinteger

statusstring

created_atstring

updated_atstring

typestring

Example response

{
  "id": "card_oXpOkr1Sy3UQm7P9",
  "first_six_digits": "542501",
  "last_four_digits": "7793",
  "brand": "Mastercard",
  "holder_name": "Peter Parker",
  "exp_month": 12,
  "exp_year": 2030,
  "status": "active",
  "created_at": "2018-04-03T20:54:58Z",
  "updated_at": "2018-04-04T12:25:32Z",
  "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_lNXOjXVSLZC4rQom",
    "name": "Tony Stark",
    "email": "14a2f1a5-79a8-4b2b-a658-d4f931b0e02e@avengers.com",
    "document": "93095135270",
    "type": "individual",
    "created_at": "2018-04-03T20:11:48Z",
    "updated_at": "2018-04-03T20:11:48Z",
    "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"
}