Cadastrar portador adicional

Use este endpoint para cadastrar um portador adicional com criação do cartão.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/cartoes/portador-adicional' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "nome": "Nome Ficticia da Silva", "nomeCartao": "Nome Ficticia da Silva", "cpf": "51468315056", "rg": "2062216", "nomeMae": "Nome Cavalcante Ficticia", "dataNascimento": "2000-04-15", "sexo": "MASCULINO", "telefones": [ { "tipo": "CELULAR", "ramal": "4020", "area": "83", "telefone": "991234567", "receberSMS": true, "faturaDigital": true } ], "endereco": { "numero": "58", "cep": "57020449", "complemento": "Ao lado da Padaria", "logradouro": "Rua Mauro Cavalcante", "bairro": "Bessa", "pais": "Brasil", "localidade": "João Pessoa", "uf": "PB" }, "idGrauParentesco": 1, "idPessoa": 2001, "nomePersonalizado": "Nome Silva" }'

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer.

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Parâmetros Bodyapplication/json

opcional

One of

Processadora Cards

Processadora Dock

Informações para cadastro de portador adicional através da processadora Cards.

nome

string

requerido

Nome completo do portador adicional.

Exemplo:

Nome Ficticia da Silva

nomeCartao

string

requerido

Nome impresso no cartão.

Exemplo:

Nome Ficticia da Silva

cpf

string

requerido

CPF do portador adicional.

Exemplo:

51468315056

string

opcional

RG do portador adicional.

Exemplo:

2062216

nomeMae

string

opcional

Nome completo da mãe do portador adicional.

Exemplo:

Nome Cavalcante Ficticia

dataNascimento

string <date>

requerido

Data de nascimento do portador adicional no formato yyyy-MM-dd.

Exemplo:

2000-04-15

sexo

enum<string>

opcional

Sexo do portador adicional.

Valores permitidos:

MASCULINOFEMININO

Exemplo:

FEMININO

telefones

array [object {6}]

opcional

Informações sobre os telefones do portador adicional.

Campo não é obrigatório para cadastro do portador, porém possui campos obrigatórios se for usado no cadastro.

endereco

object (EnderecoAdicionalRequest)

opcional

Informações do endereço do portador adicional.

idGrauParentesco

enum<integer> <int64>

requerido

Identificado do grau de parentesco do adicional, em relação ao titular.

Valor	Descrição
1	PAI
2	MÃE
3	FILHO(A)
4	IRMÃO/IRMÃ
5	CÔNJUGE
6	OUTRO

Valores permitidos:

123456

Exemplo:

idPessoa

integer <int64>

requerido

Identificador do portador titular.

Exemplo:

2001

nomePersonalizado

string

opcional

Nome personalizado para o cartão do portador adicional.

Exemplo:

Nome Silva

Examples

application/json

Body

opcional

One of

Processadora Cards

Processadora Dock

integer

opcional

Identificação do portador adicional.

Exemplo:

111111

Cadastrar portador adicional

Requisição

Respostas