Descrição #
Este passo tem por finalidade criar um agente de saque.
Nota: Ao efetuar um novo cadastro, as informações irão passar por uma analise interna para validar alguns dados e posteriormente serão liberadas para consulta e disponibilizadas para o bacen.
Endpoints #
- Produção: https://api2.bancosemear.com.br/paas-withdrawal-agents-api/api/v1/public/withdrawl
- Homologação: https://hmlapi2.bancosemear.com.br/paas-withdrawal-agents-api/api/v1/public/withdrawl
Requisição (POST) #
Segue exemplo de requisição:
curl "https://hmlapi2.bancosemear.com.br/paas-withdrawal-agents-api/api/v1/public/withdrawl" \
--request POST \
--header "Content-Type: application/json" \
--header "client_id: <CLIENT_ID>" \
--header "access_token: <ACCESS_TOKEN>" \
--data '
{
"documento": "xxxxxxxxxxx",
"registro": {
"nome_agente_saque": "Comercial PAY",
"cnpj_agente_saque": "37233282000187",
"pontos_atendimento": [
{
"nome": "Mercado 4",
"nome_original": "super nosso LTDA",
"latitude": "40.7128",
"longitude": "-74.0060",
"logradouro": "Rua Tagipuru",
"bairro": "Barra Funda",
"cidade": "São Paulo",
"estado": "SP",
"cep": "01156000",
"produtos": {
"Pix-saque": true,
"Pix-troco": false
},
"horarios_funcionamento": [
{
"dia": "SEGUNDA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "TERCA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "QUARTA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "QUINTA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "SEXTA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "SABADO",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "DOMINGO",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
}
],
"observacoes": "Campo livre"
}
]
}
}'Parâmetros de Requisição #
Cabeçalho #
- Content-Type: Informa ao servidor de que o corpo da requisição possui o formato JSON
- client_id: ID de cliente usado para encaminhar a requisição ao gateway de APIs
- access_token: Token recebido após executar o método oAuth (Access Token)
Corpo (JSON) #
| Propriedade | Descrição | Tipo | Obrigatoriedade |
|---|---|---|---|
| documento | Cnpj do agente de saque ou do participante que, diretamente, facilite o serviço de saque. Com 14 dígitos, sem máscara. | String | Obrigatório |
| registro | Lista de informações relativas aos pontos de atendimento dos agentes de saque ou do participante que, diretamente, preste o serviço de saque. | List | Obrigatório |
| registro.nome_agente_saque | Nome do agente de saque ou do participante que, diretamente, facilite o serviço de saque. | String | Obrigatório |
| registro.cnpj_agente_saque | Cnpj do agente de saque ou do participante que, diretamente, facilite o serviço de saque. Com 14 dígitos, sem máscara. | String | Obrigatório |
| registro.pontos_atendimento | Lista de todos os pontos de atendimento de um agente de saque ou do participante que, diretamente, facilite o serviço de saque. | List | Obrigatório |
| registro.pontos_atendimento.nome | Nome do ponto de atendimento. Este nome tem como função detalhar cada ponto de atendimento de um agente de saque ou do participante que, diretamente, venha a facilitar o serviço de saque. Este será considerado para aparecer na lista de pontos de saque ao cliente final (max. 50 caracteres) | String | Obrigatório |
| registro.pontos_atendimento.nome_original | Nome do ponto de atendimento. Este nome tem como função detalhar cada ponto de atendimento de um agente de saque ou do participante que, diretamente, venha a facilitar o serviço de saque. (max. 100 caracteres) | String | Obrigatório |
| registro.pontos_atendimento.latitude | Latitude da posição geográfica. A faixa de valores válida é de -90 a 90, sendo que devem ser utilizadas pelo menos 5 casas decimais. | String | Obrigatório |
| registro.pontos_atendimento.longetude | Longitude da posição geográfica. A faixa de valores válida é de -180 a 180, sendo que devem ser utilizadas pelo menos 5 casas decimais. | String | Obrigatório |
| registro.pontos_atendimento.logradouro | Logradouro do ponto de atendimento. (max. 100 caracteres) | String | Obrigatório |
| registro.pontos_atendimento.bairro | Bairro do ponto de atendimento. (max. 40 caracteres) | String | Obrigatório |
| registro.pontos_atendimento.cidade | Cidade do ponto de atendimento. (max. 40 caracteres) | String | Obrigatório |
| registro.pontos_atendimento.estado | Estado do ponto de atendimento. (max. 2 caracteres, ex. “AC”) | String | Obrigatório |
| registro.pontos_atendimento.cep | CEP do ponto de atendimento. Devem ser informados apenas os 8 números sem qualquer máscara. | String | Obrigatório |
| registro.pontos_atendimento.produtos | Indicação sobre quais produtos este ponto de atendimento disponibiliza. | String | Obrigatório |
| registro.pontos_atendimento.produtos.Pix-saque | Indicação se o ponto de atendimento disponibiliza Pix Saque. | Boolean | Obrigatório |
| registro.pontos_atendimento.produtos.Pix-troco | Indicação se o ponto de atendimento disponibiliza Pix Troco. | Boolean | Obrigatório |
| registro.pontos_atendimento.horarios_funcionamento | Lista com os horários em que o Pix Saque ou Pix Troco estará disponível. Caso algum dia da semana não seja informado isto significa que os produtos não estarão disponíveis naquele dia. | List | Obrigatório |
| registro.pontos_atendimento.horarios_funcionamento.dia | Dia da semana. | String | Obrigatório |
| registro.pontos_atendimento.horarios_funcionamento.horario.abertura_saque | Hora de abertura para disponibilização dos produtos no ponto de atendimento. | String | Obrigatório |
| registro.pontos_atendimento.horarios_funcionamento.horario.fechamento_saque | Hora de fechamento para disponibilização dos produtos no ponto de atendimento. | String | Obrigatório |
| registro.pontos_atendimento.horarios_funcionamento.valor_maximo_disponivel | Valor máximo disponível por saque/troco | String | Obrigatório |
| registro.pontos_atendimento.observacoes | Observações gerais sobre o ponto de atendimento. (max. 250 caracteres) | String | Opcional |
Resposta #
Segue exemplo de resposta:
{
"nome_agente_saque": "Comercial",
"cnpj_agente_saque": "37233282000187",
"pontos_atendimento": [
{
"nome": "Mercado 4",
"nome_original": "super nosso LTDA",
"latitude": "40.7128",
"longitude": "-74.0060",
"logradouro": "Rua Tagipuru",
"bairro": "Barra Funda",
"cidade": "São Paulo",
"estado": "SP",
"cep": "01156000",
"produtos": {
"Pix-saque": true,
"Pix-Troco": false
},
"horarios_funcionamento": [
{
"dia": "SEGUNDA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "TERCA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "QUARTA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "QUINTA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "SEXTA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "SABADO",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
},
{
"dia": "DOMINGO",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "1000.00"
}
],
"observacoes": "Campo livre"
}
]
}
