Descrição #
Este passo tem por finalidade listar os agentes de saque.
Endpoints
- Produção: https://api2.bancosemear.com.br/paas-withdrawal-agents-api/api/v1/public/withdrawl/all
- Homologação: https://hmlapi2.bancosemear.com.br/paas-withdrawal-agents-api/api/v1/public/withdrawl/all
Requisição (POST) #
Segue exemplo de requisição:
curl "https://hmlapi2.bancosemear.com.br/paas-withdrawal-agents-api/api/v1/public/withdrawl/all?document=xxxxxxxxxxxxxx&withdrawalAgentDocument=xxxxxxxxxxxxxx&servicePointName=Trillion TV&isActive=true&itensPage=10&page=1\
--request GET \
--header "Content-Type: application/json" \
--header "client_id: <CLIENT_ID>" \
--header "access_token: <ACCESS_TOKEN>"
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)
- servicePointName: Nome do ponto de atendimento. (Deve ser exatamente o mesmo que foi usado no cadastro)(opcional)
- withdrawalAgentDocument: CNPJ do agente de saque ou do participante que, diretamente, facilite o serviço de saque.(opcional)
- isActive: Flag de controle do ponto de atendimento.(default true)(opcional)
- page: Número da pagina de navegação.(default 1)(opcional)
- itensPage: Quantidade de itens por pagina.(default quantidade definida pelo sistema)(opcional)
- document: CNPJ do agente de saque ou do participante que, diretamente, facilite o serviço de saque. (obrigatório)
#
Resposta #
Segue exemplo de resposta:
{
"total_itens": 1,
"total_paginas": 1,
"itens_por_pagina": 5,
"pagina": 1,
"registros": [
{
"nome_agente_saque": "Trillion Pay",
"cnpj_agente_saque": "xxxxxxxxxxxxxx",
"pontos_atendimento": [
{
"id": 81,
"nome": "Trillion TV",
"nome_original": "Trillion Game TV RC",
"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": true
},
"horarios_funcionamento": [
{
"dia": "SEGUNDA_FEIRA",
"horario": {
"abertura_saque": "09:00:00",
"fechamento_saque": "18:00:00"
},
"valor_maximo_disponivel": "500.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": "500.00"
}
],
"observacoes": "Observação ALTERADA"
}
]
}
]
}
Propriedade | Descrição | Tipo |
---|---|---|
total_itens | Quantidade total de itens existentes sem a paginação. | Int32 |
total_paginas | Quantidade total de paginas existentes para a busca. | Int32 |
itens_por_pagina | Quantidade de itens por pagina da busca. | Int32 |
pagina | Número da pagina atual em que a busca se encontra. | Int32 |
registro.nome_agente_saque | Nome do agente de saque ou do participante que, diretamente, facilite o serviço de saque. | String |
registro.cnpj_agente_saque | CNPJ do agente de saque ou do participante que, diretamente, facilite o serviço de saque. | String |
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 |
registro.pontos_atendimento.id | Identificador do ponto de atendimento | Int32 |
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. | String |
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. | String |
registro.pontos_atendimento.latitude | Latitude da posição geográfica. | String |
registro.pontos_atendimento.longetude | Longitude da posição geográfica. | String |
registro.pontos_atendimento.logradouro | Logradouro do ponto de atendimento. | String |
registro.pontos_atendimento.bairro | Bairro do ponto de atendimento. | String |
registro.pontos_atendimento.cidade | Cidade do ponto de atendimento. | String |
registro.pontos_atendimento.estado | Estado do ponto de atendimento. | String |
registro.pontos_atendimento.cep | CEP do ponto de atendimento. | String |
registro.pontos_atendimento.produtos | Indicação sobre quais produtos este ponto de atendimento disponibiliza. | String |
registro.pontos_atendimento.produtos.Pix-saque | Indicação se o ponto de atendimento disponibiliza Pix Saque. | Boolean |
registro.pontos_atendimento.produtos.Pix-troco | Indicação se o ponto de atendimento disponibiliza Pix Troco. | Boolean |
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 |
registro.pontos_atendimento.horarios_funcionamento.dia | Dia da semana. | String |
registro.pontos_atendimento.horarios_funcionamento.horario.abertura_saque | Hora de abertura para disponibilização dos produtos no ponto de atendimento. | String |
registro.pontos_atendimento.horarios_funcionamento.horario.fechamento_saque | Hora de fechamento para disponibilização dos produtos no ponto de atendimento. | String |
registro.pontos_atendimento.horarios_funcionamento.valor_maximo_disponivel | Valor máximo disponível por saque/troco | String |
registro.pontos_atendimento.observacoes | Observações gerais sobre o ponto de atendimento. | String |