Criar cartão virtual

Request

ENDPOINT

/postpaid/wallet/WALLET-KEY/card/

MÉTODO

POST

Request Body

{
  "owner": {
    "name": "Nome Completo do Cliente",
    "document_number": "12345678901",
    "document_type": "cpf",
    "person_type": "natural",
    "birth_date": "1990-01-01",
    "email": "cliente@email.com",
    "phone": {
      "number": "999999999",
      "area_code": "11",
      "country_code": "+55"
    },
    "address": {
      "street": "Rua Exemplo",
      "number": "123",
      "neighborhood": "Bairro",
      "city": "Cidade",
      "state": "SP",
      "postal_code": "00000000",
      "country": "Brazil"
    }
  },
  "type": "virtual",
  "card_limit": 10000,
  "card_name": "ecommerce",
  "printed_name": "Aurora Catarina",
  "cvv_rotation_interval_hours": 72
}

Body params

Campo	Tipo	Descrição	Caracteres
owner	object	Objeto Dono da carteira	Objeto owner
program_key *	string	Chave de identificação do programa para emitir um cartão.	uuid
card_type *	string	Tipo do cartão a ser emitido (VIRTUAL).	Enumeradores
card_name *	string	Alias do cartão, como esse cartão será identificado.	uuid
printed_name *	string	Nome que será impresso no cartão (não será permitido o uso de números e caracteres especiais).	uuid
cvv_rotation_interval_hours *	int	Intervalo em horas para atualizar o número CVV.	Number
card_limit *	number	Limite inicial do cartão.	1000

Objeto owner

Campo	Tipo	Descrição	Caracteres
person_type	string	Identificador de que o objeto enviado é uma pessoa física ou jurídica.
name	string	Razão social em caso de operações PJ ou Nome da pessoa em caso de operações PF.	100
document_number	string	CPF da pessoa (apenas números). Limitado a 11 caracteres.
birthdate	string	Data de nascimento no formato YYYY-MM-DD
address	string	Endereço do cliente.	Objeto adress
phone	string	Objeto com dados do telefone	Objeto phone
email	string	Email do cliente.

Objeto address

Campo	Descrição	Exemplo	Máx. Caracteres
street	string	Rua do endereço	100
state	string	Estado do endereço (com dois caracteres maiúsculos)	2
city	string	Cidade do endereço	100
neighborhood	string	Bairro do endereço	100
number	string	Número da rua	10
postal_code	string	CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números)	8
complement	string	Complemento do endereço (texto livre)	100

Objeto phone

Campo	Descrição	Exemplo	Máx. Caracteres
country_code	string	Código DDI do telefone (https://ddi.guiamais.com.br/)	3
area_code	string	Código DDD do telefone (https://ddd.guiamais.com.br/)	2
number	string	Número de telefone (apenas números)	10

Enumeradores card_type

Enumerador	Tradução
plastic	Cartão físico
virtual	Cartão virtual

Response

STATUS

201

Response Body

{
    "card_key": "05fd3654-1f5d-479d-ade5-64239fdf214d",
	"created_at": "2023-02-20T19:28:16Z",
    "status":"created"
}

Erros

STATUS

4XX

Response Body

{
  "title": "Bad Request",
  "description": "The type of person is invalid for this program, please try another.",
  "translation": "Invalid Person",
  "code": "CARD000007"
}

Code	Status code	Descrição
QIT000001	400	Invalid Json schema.
CARD000005	404	It was not possible to fetch the Program for the program_key {program_key}.
CARD000006	404	It was not possible to fetch the Account for the account_key {account_key}.
CARD000007	400	The type of person is invalid for this program, please try another.
CARD000008	400	The Card Holder with the status {status} is invalid for the operation.
CARD000009	400	We're sorry, but the card could not be generated. Please try again later.
CARD000010	404	It was not possible to fetch the Person for the person_key {owner_person_key}.
CARD000032	403	Create virtual card is not allowed for program_key {program_key}.

Webhook

WEBHOOK_TYPE

baas.pospaid_card.card

Webhook Body

{
    "webhook_type": "baas.pospaid_card.card",
    "event_datetime": "2023-07-24T12:00:00.000Z",
    "data": {
        "card_key": "9bd93e97-bb6d-410f-8981-06b2765f12a1",
        "program_key": "bf74df61-557a-45cb-914f-41e127a6e18c",
        "status": "created",
        "type": "virtual"
    }
}