API Reference
  1. AlliancePay — API de parceiros
  2. Recebíveis e repasses

Consultar agenda mensal de recebíveis

get
https://api-hml.alliancepay.app/acquiring/settlements/batches/by-payment-month

Agrupa lotes de cartão e Pix por data de pagamento no mês YYYY-MM. Envie merchant_id para consultar um estabelecimento ou partner_id para consultar o parceiro autenticado. Pelo menos um desses filtros é obrigatório; a ausência dos dois retorna 403. Esses filtros não são preenchidos automaticamente.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid | null

UUID do estabelecimento vinculado ao parceiro autenticado. Informe pelo menos um dos filtros merchant_id ou partner_id.

uuid | null

UUID do parceiro autenticado. Não permite consultar dados de outro parceiro. Informe pelo menos um dos filtros merchant_id ou partner_id.

string
required
^\d{4}-(0[1-9]|1[0-2])$
Headers
string
length between 1 and 512
^[ -~]+$

Identificador de rastreio. Se omitido, o gateway gera um identificador. Retornado no cabeçalho X-Request-Id.

Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?