Embossing
Nas requisições de emissão de cartões físicos e de segunda via, além dos campos já descritos nas documentações anteriores, o parceiro tem a possibilidade de enviar o objeto embossing e suas propriedades, caso:
- Possua um acordo com a embossadora, que requeira o envio desse tipo de informação;
- Tenha a necessidade de enviar dados específicos não contemplados por nossos endpoints, como um determinado código de produto, um tipo de folheteria especial para certo público, ou até mesmo códigos referentes à postagem.
Nota
Essas particularidades são definidas no momento de implantação do produto.
Corpo da requisição (Body)
Para acrescentar o objeto embossing em sua requisição, envie os seguintes campos:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
embossingCustomFields | object | Objeto que deverá conter informações sobre os campos customizáveis de embossing do cartão. | — |
embossingCustomFields.shippingType | integer | Tipo de envio, o qual deve ser "N" (Normal). | — |
embossingCustomFields.plasticCode | string | Código do plástico. | Tamanho máximo de quatro dígitos. |
embossingCustomFields.embossingKitType | string | Tipo do kit de embossing. | Tamanho máximo de quatro dígitos. |
embossingCustomFields.specialNeeds | object | Objeto que deverá conter informações sobre as necessidades especiais da pessoa portadora do cartão. | — |
embossingCustomFields.specialNeeds.hasSpecialNeeds | boolean | Indica se a pessoa portadora do cartão possui (true) ou não (false) alguma necessidade especial. | — |
embossingCustomFields.specialNeeds.code | integer | Código da necessidade. Caso a pessoa não possua uma necessidade especial (false), informe null neste campo. Importante: verifique com a fábrica os possíveis códigos a serem informados neste campo. | Informe um valor entre 1 e 99. |
Exemplo de requisição
--request POST \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/physical' \
--header 'Authorization: Bearer {{Token}}'\
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'x-bkly-license: f64197e4-80b3-4820-bfae-1419049b15b5'\
--header 'content-type: application/json'\
--data '{
"documentNumber": "47742663023",
"cardName": "Nísia Floresta",
"alias": "Cartão principal",
"bankAgency": "0001",
"bankAccount": "15164",
"programId": "1234",
"password": "1234",
"address": {
"zipCode": "68060100",
"address": "Rua 6 de Março",
"number": "2500",
"neighborhood": "Alter do Chão",
"complement": "",
"city": "Santarém",
"state": "PA",
"country": "BR"
},
"embossingCustomFields": {
"shippingType": "N",
"plasticCode ": "123",
"embossingKitType": "456",
"specialNeeds": {
"hasSpecialNeeds": true,
"specialNeedsCode": 99
}
},
"metadata":{
"updatedAt": "2022-12-30T01:11:07.4019873Z",
"versao": "1.0"
}
}'
Updated about 5 hours ago