Início

Ambiente de homologação (Sandbox)

    API Endpoint Base:

    https://sandbox-pagamentos.gallopay.com.br/api/v1

Esta API tem por finalidade permitir a interação com o sistema Gallopay - Módulo de pagamentos. O endpoint base no ambiente de sandbox para testes é: https://sandbox-pagamentos.gallopay.com.br/api/v1. Então, toda menção na documentação a {URL_BASE}, deve-se considerar o endpoint informado anteriormente.

Para acessar os endpoints, faz-se necessário acrescentar no header alguns parâmetros:

  1. Content-Type: application/json (Em todas as requisições)
  2. Accept: application/json (Em todas as requisições)
  3. Authorization : Token Bearer (Em todos os endpoints na qual precisa de autenticação).
    (Ver como obter token de acesso)

Caso deseje visualizar a documentação da API relacionada ao módulo de checkout, clique aqui

Ambiente de produção

Para o ambiente de produção, é fornecido um subdomínio específico para nossos clientes após a habilitação do sistema para este.

Rate Limit

Alguns endpoints estão configurados para ter o rate limit isto é, aceitam uma determinada quantidade de requisições de uma mesma origem (IP) em um intervalo de tempo. Caso o limite seja ultrapassado, este endpoint fica bloqueado por 1(um) minuto para a origem em questão. Os endpoints que possuem rate limit são:

  1. /login [POST]
  2. /reset/password [POST]
  3. /charge [POST]

Autenticação


# Exemplo de requisição CURL para autenticação
curl --request POST \
  --url {URL_BASE}/login \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
	"email":"[email protected]",
	"password":"******"
}'

Para realizar a autenticação no sistema, deve-se realizar a seguinte requisição POST:
{URL_BASE}/login


Possíveis retornos:

  1. Status (200) = Autenticação bem-sucedida.
  2. Status (401) = Usuário e/ou senha inválido(s).
  3. Status (423) = Usuário bloqueado.
  4. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"hash_id": "1-hxYWP5q2kR1hWihvCDHFO44OYiK6CcqEjyEEQlEoR1zkL4aLIY",
	"token": "Bearer 11|iiPvSD4ZNO5wc9hNgYTfDyJ3UnUETLq8wPCIAAekvWOLyTHG3DsEKiHP3iTVOjOnEW4",
	"name": "Admin",
	"email": "[email protected]",
	"time_session": 60,
	"role": "admin"
 }

Parâmetros da autenticação (* = campos obrigatórios)

Valor Tipo Descrição
email* String E-mail de acesso do usuário.
password* String Senha de acesso do usuário

Redefinir senha


# Exemplo de requisição CURL para solicitar a redefinição de senha
curl --request POST \
  --url {URL_BASE}/reset/password \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
	"email":"[email protected]"
}'

Para realizar a solicitação de redefinição de senha de um usuário no sistema, deve-se realizar a seguinte requisição POST:
{URL_BASE}/reset/password


Possíveis retornos:

  1. Status (200) = Ação bem-sucedida.
  2. Status (404) = Usuário não identificado.
  3. Status (422) = Validação dados enviados não aceita.
  4. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  5. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"msg": "Um link com as instruções foi enviado por e-mail caso exista em nosso banco de dados"
}

Parâmetros para redefinição de senha (* = campos obrigatórios)

Valor Tipo Descrição
email* String E-mail de acesso do usuário.

Encerrar token (Logout)


# Exemplo de requisição CURL para realiazr o logout
curl --request POST \
  --url {URL_BASE}/logout \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \

Para encerrar a utilização de um token (logout), deve-se realizar a seguinte requisição POST:
{URL_BASE}/logout

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (200) = Autenticação bem-sucedida.
  2. Status (401) = Usuário não logado.
  3. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"msg": "Logout realizado com sucesso!"
}

Listagem de clientes


# Exemplo de requisição CURL para listagem de clientes
curl --request GET \
  --url {URL_BASE}/client \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \
  --data '{
	"page":"1",
	"search":"Cliente teste"
}'

Para realizar a listagem de clientes cadastrados, deve-se realizar a seguinte requisição GET:
{URL_BASE}/client

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (200) = Ação bem-sucedida.
  2. Status (401) = Acesso não autorizado.
  3. Status (403) = Usuário não autenticado.
  4. Status (419) = Sessão expirada.
  5. Status (422) = Validação dados enviados não aceita.
  6. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  7. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"last_page": 1,
	"total_itens": 1,
	"current_page": 1,
	"has_page": false,
	"per_page": 10,
	"data": [
		{
			"hash_id": "12-QPWViwKLJE4Xbp7xAr25xLATYVEM8ImWIV6smHRATk2QJyFLlz",
			"document": "32556200100",
			"name": "11945620010",
			"email": "[email protected]",
			"email_notification": null,
			"gender": "M",
			"birth_date": "2000-03-15",
			"zipcode": "35362000",
			"address": "Avpaulista",
			"number_address": "1",
			"complement_address": null,
			"district": "centro",
			"city": "São paulo",
			"state": "sp",
			"phone": "1121111111",
			"phone_notification": "11945620010",
			"type": "pf"
		}
	]
}

Parâmetros aplicados (filtros) na listagem de clientes (* = campos obrigatórios)

Valor Tipo Descrição
page* Integer Nº atual da paginação de elementos. O valor inicial deve ser 1.
search String Descrição para buscar um cliente. Pode ser: nome,documento,e-mail, telefone ou endereço de um cliente.

Pesquisar cliente


# Exemplo de requisição CURL para pesquisa de cliente
curl --request GET \
  --url {URL_BASE}/client/get-client-by-document-or-email \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \
  --data '{
	"search":"Cliente teste"
}'

Para realizar a busca de um cliente a partir de seu documento ou e-mail, deve-se realizar a seguinte requisição GET:
{URL_BASE}/client/get-client-by-document-or-email

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (200) = Ação bem-sucedida.
  2. Status (412) = Domínio não autorizado para buscar cliente.
  3. Status (500) = Erro interno no servidor.


Exemplo de retorno cliente identificado:

{
	"client": {
	"name": "Cliente teste",
	"email": "[email protected]",
	"gender": "O",
	"birth_date": "1990-01-01",
	"zipcode": "62452895",
	"address":"Av. Paulista",
	"number_address":"700",
	"complement_address":"Próximo ao MASP",
	"birth_date": "2000-03-15",
	"district":"Centro",
	"city":"São Paulo",
	"state":"SP",
	"country":"Brasil",
	"phone":"11912345678",
	},
	"exists": true
}

Parâmetros aplicados (filtros) na listagem de clientes (* = campos obrigatórios)

Valor Tipo Descrição
search String Descrição para buscar um cliente. Pode ser: documento ou e-mail. 


Exemplo de retorno cliente não identificado :

{
	"client": [],
	"exists": false,
	"cod": 404
}

Criar novo cliente


# Exemplo de requisição CURL para criação de um novo cliente
curl --request POST \
  --url {URL_BASE}/client \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \
  --data '{
	"document":"xxx.xxx.xxx-xx",
	"name":"Cliente teste",
        "email":"[email protected]",
        "email_notification":"[email protected]",
        "gender":"M, F ou O",
        "address":"Av. Paulista",
        "number_address":"700",
        "complement_address":"Próximo ao MASP",
        "birth_date": "2000-03-15",
        "district":"Centro",
        "city":"São Paulo",
        "state":"SP",
        "country":"Brasil",
        "phone":"(11)9.1234-5678",
        "phone_notification":"(11)9.1234-5678",
        "type_client":"pf ou pj",
        "mat_external":"123"
}'

Para realizar o cadastro de um cliente, deve-se realizar a seguinte requisição POST:
{URL_BASE}/client

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (201) = Ação bem-sucedida.
  2. Status (401) = Acesso não autorizado.
  3. Status (403) = Usuário não autenticado.
  4. Status (419) = Sessão expirada.
  5. Status (422) = Validação dados enviados não aceita.
  6. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  7. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"client": {
		"hash_id": "18-vKov3xNr5t3VNqUmLCt73r2RVpdVHm1G5qyhVowB3vkhgQlJa3",
		"document": "80415515315",
		"name": "Cliente teste",
		"email": "[email protected]",
		"email_notification": "[email protected]",
		"gender": "M",
		"birth_date": "2000-03-15",
		"zipcode": "",
		"address": "Av. Paulista",
		"number_address": "700",
		"complement_address": "Próximo ao MASP",
		"district": "Centro",
		"city": "São Paulo",
		"state": "SP",
		"phone": "11912345678",
		"phone_notification": "11912345678",
		"type": "pf"
	}
}

Parâmetros para criação cliente (* = campos obrigatórios)

Valor Tipo Descrição
document* String Nº do documento do cliente (CPF ou CNPJ).
name* String Nome completo do cliente
email* String E-mail válido do cliente
email_notification String E-mail válido do cliente para notificações do sistema
birth_date Date Idade do cliente
gender* String Gênero do cliente. M = Masculino | F = Feminino | O = Outros
address* String Endereço do cliente
number_address* String Nº do endereço do cliente
complement_address String Complemento do endereço do cliente, caso exista
district* String Bairro do endereço do cliente
city* String Cidade do cliente
state* String Estado (UF) do cliente
country* String País do cliente
phone* String Telefone do cliente
phone_notification String Telefone do cliente para notificações
type_client String Tipo de cliente. PF = Pessoa Física | PJ = Pessoa Jurídica
mat_external String Matrícula externa do cliente, caso seja utilizada alguma matrícula vinculada ao cliente em outro sistema.

Listagem de cobranças


# Exemplo de requisição CURL para listagem de cobranças
curl --request GET \
  --url {URL_BASE}/charge \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \
  --data '{
	"page":"1",
	"search":"Cliente teste",
    "from":"2025-01-01",
    "to":"2025-12-31",
    "status":"pending"
}'

Para realizar a listagem de cobranças cadastradas, deve-se realizar a seguinte requisição GET:
{URL_BASE}/charge

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (200) = Ação bem-sucedida.
  2. Status (401) = Acesso não autorizado.
  3. Status (403) = Usuário não autenticado.
  4. Status (419) = Sessão expirada.
  5. Status (422) = Validação dados enviados não aceita.
  6. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  7. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"total_charge_paid": "38182.32",
	"count_charge_paid": 278,
	"total_charge_pending": "9834.56",
	"count_charge_pending": 44,
	"total_charge_overdue": "5584.00",
	"count_charge_overdue": 27,
	"total_charge_cancelled": "2619.50",
	"count_charge_cancelled": 29,
	"last_page": 1,
	"total_itens": 0,
	"current_page": 1,
	"has_page": false,
	"per_page": 10,
	"data": [],
	"methods": [
		{
			"id": 2,
			"hash_id": "2-MnHTwU0hfgGtZLdP2mBc2VxmqrgWFLc1UM7ePS275gtopzxxbH",
			"name": "Cartão Crédito",
			"code": "credit_card",
			"status": true
		},
		{
			"id": 4,
			"hash_id": "4-6fN4biKMs2kYe51erRzczCMhIR5qdsiViPWCRTH7kxiWeQZHIq",
			"name": "Boleto",
			"code": "ticket",
			"status": true
		},
		{
			"id": 7,
			"hash_id": "7-R8ELop1mPAuwwf8yqPnwdax05GAthHyZ8DUZO8wXRId5cNz0VT",
			"name": "PIX",
			"code": "pix",
			"status": true
		},
		{
			"id": 12,
			"hash_id": "12-1bHfM3U1dizGFrRXJV5QlHfrNZkZUmYaPFThukWOoSvnHvyyaD",
			"name": "Boleto Instantâneo",
			"code": "invoice",
			"status": true
		}
	]
}

Parâmetros aplicados (filtros) na listagem de cobranças (* = campos obrigatórios)

Valor Tipo Descrição
page* Integer Nº atual da paginação de elementos. O valor inicial deve ser 1.
search String Descrição para buscar uma cobrança de um cliente. Pode ser: nome,documento,e-mail, telefone ou endereço de um cliente.
from Date Vencimento de cobranças a partir da data informada. O formato deve ser: Y-m-d
to Date Vencimento de cobranças até data informada. O formato deve ser: Y-m-d
status String Status da cobrança. Os status podem ser:
  1. processing //Processando
  2. pending //Pendente
  3. paid //Paga
  4. cancelled //Cancelada
  5. overdue //Atrasada
  6. leverage //Atrasada, mas em prazo extra
  7. waiting_reversal_data //Aguardando dados bancários para estorno
  8. awaiting_reversal //Aguardando estorno
  9. reversed //estornado
  10. error //error

Solicitar criação nova cobrança


# Exemplo de requisição CURL para solicitar a criação de uma nova cobrança
curl --request GET \
  --url {URL_BASE}/charge/create \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \

Para realizar a criação de uma cobrança, deve-se requisitar este endpoint para que seja possível obter alguns dados obrigatórios, como o método de pagamento, dias de alavancagem padrão, obrigatoriedade do CPF e o mínimo de porcentagem para que a cobrança entre em alavancagem (prazo extra). Para tanto, deve-se realizar a seguinte requisição GET:
{URL_BASE}/charge/create

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (200) = Ação bem-sucedida.
  2. Status (401) = Acesso não autorizado.
  3. Status (403) = Usuário não autenticado.
  4. Status (419) = Sessão expirada.
  5. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  6. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"cpf_required": "1",
	"leverage_days": "1",
	"leverage_min_percent": "0",
	"methods": [
		{
			"id": 2,
			"hash_id": "2-MnHTwU0hfgGtZLdP2mBc2VxmqrgWFLc1UM7ePS275gtopzxxbH",
			"name": "Cartão Crédito",
			"code": "credit_card",
			"status": true
		},
		{
			"id": 12,
			"hash_id": "12-1bHfM3U1dizGFrRXJV5QlHfrNZkZUmYaPFThukWOoSvnHvyyaD",
			"name": "Boleto Instantâneo",
			"code": "invoice",
			"status": true
		}
	]
}

Criar nova cobrança


# Exemplo de requisição CURL para criação de uma nova cobrança
curl --request POST \
  --url {URL_BASE}/charge \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \
  --data '{
	"document": "123.456.789-01",
	"name": "Cliente teste",
	"email": "[email protected]",
	"email_notification": "[email protected]",
	"gender":"M",
    "birth_date": "2000-03-15",
	"address": "Av. Paulista",
	"number_address": "700",
	"complement_address": "Próximo ao MASP",
	"district": "Centro",
	"city": "São Paulo",
	"state": "SP",
	"phone": "11912345678",
	"type":"u, p ou r",
	"type_charge":"c ou d",
	"leverage_days_single":"1",
	"description_single_charge":"Cobrança de teste",
	"amount":"10",
	"due_date_single_charge":"2025-05-17",
	"method":"12",
	"fractionated":"1"
}'

Para realizar o cadastro de uma cobrança, deve-se realizar a seguinte requisição POST:
{URL_BASE}/charge

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (201) = Ação bem-sucedida.
  2. Status (401) = Acesso não autorizado.
  3. Status (403) = Usuário não autenticado.
  4. Status (419) = Sessão expirada.
  5. Status (422) = Validação dados enviados não aceita.
  6. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  7. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"charge": {
		"hash_id": "327-5t7LTvVqD3dBcGCZ3QFGUhpx",
		"description": "Cobrança de teste",
		"leverage_days": 1,
		"leverage_min_percent": "0.00",
		"amount": "10.00",
		"total_paid": "0.00",
		"total_pending": "10.00",
		"taxes": [],
		"status": "pending",
		"is_recurrence": false,
		"recurrence": [],
		"external": 0,
		"proposal": false,
		"total_payments": 1,
		"due_date": "17/05/2025",
		"created_at": "16/05/2025 14:58",
		"updated_at": "16/05/2025 14:58",
		"client": {
			"hash_id": "7-H6RHH12RIcZWdiSUEi",
			"document": "80459436023",
			"name": "Cliente teste",
			"email": "[email protected]",
			"email_notification": "[email protected]",
			"gender": "M",
			"birth_date": "2000-03-15",
			"zipcode": "35362000",
			"address": "Avpaulista",
			"number_address": "1",
			"complement_address": null,
			"district": "centro",
			"city": "São paulo",
			"state": "sp",
			"phone": "11912345678",
			"phone_notification": null,
			"type": "pf"
		},
		"payments": [
			{
				"hash_id": "483-VYs9DzAwCz1rByLd3RWCX",
				"amount_original": "10.00",
				"amount_paid": "0.00",
				"amount_proposal": "0.00",
				"status": "pending",
				"is_internacional": false,
				"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/327-5t7LTvVqD3dBcGCZ3QFGUhpxQsUxMsgsEN6Skfa76DTmCABKe5",
				"digitable_line": "34191.09107 79718.267309 71444.640008 1 10840000001000",
				"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/aeb2eb4ae2d34f3f9455d20855fc78725204000053039865802BR592551.627.104 Cliente Ro6005Crato62070503***6304D9B2",
				"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/ouxYZ520250516145821.png",
				"expiration": "",
				"paid_at": "",
				"last_conciliation_try_date": " - ",
				"created_by": "pagador",
				"method": "invoice",
				"created_at": "16/05/2025 14:58",
				"updated_at": "16/05/2025 14:58"
			}
		],
		"method_payment": "PopPague",
		"link_solidarity_payment": "",
		"link_invoice": null
	}
}

Parâmetros para criação cliente (* = campos obrigatórios)

Valor Tipo Descrição
document* String Nº do documento do cliente (CPF ou CNPJ).
name* String Nome completo do cliente
email* String E-mail válido do cliente
email_notification String E-mail válido do cliente para notificações do sistema
gender* String Gênero do cliente. M = Masculino | F = Feminino | O = Outros
birth_date Date Idade do cliente
address* String Endereço do cliente
number_address* String Nº do endereço do cliente
complement_address String Complemento do endereço do cliente, caso exista
district* String Bairro do endereço do cliente
city* String Cidade do cliente
state* String Estado (UF) do cliente
country* String País do cliente
phone* String Telefone do cliente
type* String Tipo de cobrança. u = cobrança única | p = cobrança parcelada | r = cobrança recorrente
webhook_url String Nota: caso informado, o sistema enviará uma requisição [POST] para a URL fornecida em quaisquer eventos que ocorram na cobrança. Todos os dados relativos à cobrança serão enviados.
type_charge* String Natureza da cobrança. c = cobrança | d = doação
leverage_days_single* Integer Prazo para pagamento após vencimento (prazo extra). Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for u = única.
description_single_charge* String Descrição da cobrança. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for u = única.
amount* Numeric Valor da cobrança. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for u = única.
due_date_single_charge* Date Data de vencimento da cobrança. Esta data deve ser igual ou superior ao dia corrente. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for u = única.
method* Integer Id do método de pagamento (Ver lista). Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for u = única.
leverage_days_installment* Integer Prazo para pagamento após vencimento (prazo extra). Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for p = parcelada.
expiration_day_installments* Integer Dia para o vencimento de cada parcela. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for p = parcelada.
description_installment_amount* String Descrição da cobrança. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for p = parcelada.
recurrence_interval_installment* String Informe o intervalo entre parcelas. São elas:
  1. daily (diário)
  2. weekly (semanal)
  3. fortnightly (quizenal)
  4. monthly (mensal)
  5. bimonthly (bimestral)
  6. quarterly (trimestral)
  7. semester (semestral)
  8. anual (yearly)
Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for p = parcelada
installment_amount* Numeric Valor da parcela. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for p = parcelada.
total_installment* Integer Total de parcelas. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for p = parcelada.
due_date_installment_billing* Date Data de vencimento da primeira parcela. Esta data deve ser igual ou superior ao dia corrente. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for p = parcelada.
method* Integer Id do método de pagamento (Ver lista). Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for p = parcelada
leverage_days_recurrence* Integer Prazo para pagamento após vencimento (prazo extra). Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for r = recorrente.
expiration_day_recurrence* Integer Dia para o vencimento de cada recorrência. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for r = recorrente.
description_recurrence* String Descrição da cobrança. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for r = recorrente.
recurrence_interval* String Informe o intervalo entre parcelas. São elas:
  1. daily (diário)
  2. weekly (semanal)
  3. fortnightly (quizenal)
  4. monthly (mensal)
  5. bimonthly (bimestral)
  6. quarterly (trimestral)
  7. semester (semestral)
  8. anual (yearly)
Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for r = recorrente.
due_date_recurrence* Date Data de vencimento da primeira cobrança. Esta data deve ser igual ou superior ao dia corrente. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for u = recorrente
amount_recurrence* Numeric Valor de cada cobrança. Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for u = recorrente.
method* Integer Id do método de pagamento (Ver lista). Nota: esse parâmetro é obrigatório apenas nos casos em que o tipo da cobrança (type) for p = parcelada.

Filtrar por uma cobrança específica


# Exemplo de requisição CURL para solicitar a criação de uma nova cobrança
curl --request GET \
  --url {URL_BASE}/charge/status/{hash_charge_id} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \

Para realizar a busca de uma cobrança específica, deve-se requisitar este endpoint. Para tanto, deve-se realizar a seguinte requisição GET:
{URL_BASE}/charge/status/{hash_charge_id}

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (200) = Ação bem-sucedida.
  2. Status (401) = Acesso não autorizado.
  3. Status (403) = Usuário não autenticado.
  4. Status (404) = Cobrança não encontrada.
  5. Status (419) = Sessão expirada.
  6. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  7. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"charge": {
		"hash_id": "327-5t7LTvVqD3dBcGCZ3QFGUhpxQsUxMsgsEN6Skfa76DTmCABKe5",
		"description": "Cobrança de teste",
		"leverage_days": 1,
		"leverage_min_percent": "0.00",
		"amount": "10.00",
		"total_paid": "0.00",
		"total_pending": "10.80",
		"taxes": {
			"daily_tax": "3.00%",
			"late_fine": "2.00%",
			"late_days": 2
		},
		"status": "overdue",
		"is_recurrence": false,
		"recurrence": [],
		"external": 0,
		"proposal": false,
		"total_payments": 1,
		"due_date": "17/05/2025",
		"created_at": "16/05/2025 14:58",
		"updated_at": "18/05/2025 02:00",
		"client": {
			"hash_id": "7-H6RHH12RIcZWdiSUEiKazLpDjjrcIC9mkCrTAGiUA9ucShMdXM",
			"document": "80459436023",
			"name": "Cliente teste",
			"email": "[email protected],
			"email_notification": "[email protected],
			"gender": "M",
			"birth_date": "1990-01-01",
			"zipcode": "63113765",
			"address": "Av. Paulista",
			"number_address": "700",
			"complement_address": "Próximo ao MASP",
			"district": "Centro",
			"city": "São Paulo",
			"state": "UF",
			"phone": "11912345678",
			"phone_notification": null,
			"type": "pf"
		},
		"payments": [
			{
				"hash_id": "483-VYs9DzAwCz1rByLd3RWCXHpSfcNDKZOFzDKclsjsN0EcqBaQz0",
				"amount_original": "10.00",
				"amount_paid": "10.00",
				"amount_proposal": "0.00",
				"status": "cancelled",
				"is_internacional": false,
				"document_url": "",
				"digitable_line": "",
				"document_hash": "",
				"qrcode_img": "",
				"expiration": "",
				"paid_at": "16/05/2025 15:01",
				"last_conciliation_try_date": "18/05/2025 00:00",
				"created_by": "pagador",
				"method": "invoice",
				"created_at": "16/05/2025 14:58",
				"updated_at": "18/05/2025 00:00"
			}
		],
		"method_payment": "Boleto Instantâneo",
		"link_solidarity_payment": "",
		"link_invoice": null
	}
}

Listagem de pagamentos


# Exemplo de requisição CURL para listagem de pagamentos
curl --request GET \
  --url {URL_BASE}/payment \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \
  --data '{
	"page":"1",
	"search":"Cliente teste",
    "from":"2025-01-01",
    "to":"2025-12-31",
    "status":"pending",
    "method":"12"
}'

Para realizar a listagem de pagamentos realizados, deve-se realizar a seguinte requisição GET:
{URL_BASE}/payment

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (200) = Ação bem-sucedida.
  2. Status (401) = Acesso não autorizado.
  3. Status (403) = Usuário não autenticado.
  4. Status (419) = Sessão expirada.
  5. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  6. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"last_page": 49,
	"total_itens": 482,
	"current_page": 1,
	"has_page": true,
	"per_page": 10,
	"data": [
		{
			"hash_id": "481-NzMbuNweUcssDpC438f4pqyvjyr52V274rdh9hJT1MHGXrAHkk",
			"user": null,
			"charge": {
				"hash_id": "325-gn7383sTCQC6C7s470EUpzfdubOFiUqE5hIMlsnVvz71aFUMX7",
				"description": "CObrança de teste",
				"leverage_days": 1,
				"leverage_min_percent": "0.00",
				"amount": "10.00",
				"total_paid": "0.00",
				"total_pending": "10.00",
				"taxes": [],
				"status": "paid",
				"is_recurrence": false,
				"recurrence": [],
				"external": 0,
				"proposal": false,
				"total_payments": 1,
				"due_date": "17/05/2025",
				"created_at": "16/05/2025 14:51",
				"updated_at": "16/05/2025 15:00",
				"client": {
					"hash_id": "7-H6RHH12RIcZWdiSUEiKazLpDjjrcIC9mkCrTAGiUA9ucShMdXM",
					"document": "80459436023",
					"name": "Rai Moreira Rodrigues",
					"email": "[email protected]",
					"email_notification": "[email protected]",
					"gender": "M",
					"birth_date": "1992-12-17",
					"zipcode": "63113765",
					"address": "Rua Walmair Gonçalves de Oliveira",
					"number_address": "123",
					"complement_address": "Próximo aos Correios",
					"district": "Seminário",
					"city": "Crato",
					"state": "CE",
					"phone": "88997137063",
					"phone_notification": null,
					"type": "pf"
				},
				"payments": [
					{
						"hash_id": "481-NzMbuNweUcssDpC438f4pqyvjyr52V274rdh9hJT1MHGXrAHkk",
						"amount_original": "10.00",
						"amount_paid": "10.00",
						"amount_proposal": "0.00",
						"status": "overdue",
						"is_internacional": false,
						"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/325-gn7383sTCQC6C7s470EUpzfdubOFiUqE5hIMlsnVvz71aFUMX7",
						"digitable_line": "34191.09107 79717.927309 71444.640008 3 10840000001000",
						"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/e8eda760b87d4eb8bd77b6c0520ca3a55204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***63047B25",
						"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/MN2M1Q20250516145105.png",
						"expiration": "",
						"paid_at": "16/05/2025 15:00",
						"last_conciliation_try_date": "19/05/2025 09:01",
						"created_by": "pagador",
						"method": "invoice",
						"created_at": "16/05/2025 14:51",
						"updated_at": "19/05/2025 09:01"
					}
				],
				"method_payment": null,
				"link_solidarity_payment": "",
				"link_invoice": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/325-gn7383sTCQC6C7s470EUpzfdubOFiUqE5hIMlsnVvz71aFUMX7"
			},
			"amount_original": "10.00",
			"amount_paid": "10.00",
			"amount_proposal": null,
			"due_date": "2025-05-17",
			"paid_at": "2025-05-16 15:00:52",
			"installments": 1,
			"status": "overdue",
			"method": "Boleto Instantâneo",
			"method_code": "invoice",
			"rate": [
				{
					"name": "Boleto (%)",
					"method": "invoice",
					"type": "p",
					"value": "1.00",
					"rate_antecipation": 0
				}
			],
			"is_internacional": 0,
			"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/325-gn7383sTCQC6C7s470EUpzfdubOFiUqE5hIMlsnVvz71aFUMX7",
			"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/MN2M1Q20250516145105.png",
			"error": null,
			"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/e8eda760b87d4eb8bd77b6c0520ca3a55204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***63047B25",
			"payment_detail": null,
			"created_at": "2025-05-16T17:51:21.000000Z",
			"updated_at": "2025-05-19T12:01:16.000000Z"
		},
		{
			"hash_id": "324-s2Bq8sZ0B0SgJGFHhGdkglf2W7oB9AbqP5XOOd8sO1kEypCbhb",
			"user": null,
			"charge": {
				"hash_id": "206-4Oo2sNNP9wIfb7inxMp2Qd29wiFK6gihNThOHZ4huuHus2fize",
				"description": "Assinatura Anual Caras",
				"leverage_days": 1,
				"leverage_min_percent": "0.00",
				"amount": "350.00",
				"total_paid": "110.00",
				"total_pending": "280.80",
				"taxes": {
					"daily_tax": "3.00%",
					"late_fine": "2.00%",
					"late_days": 5
				},
				"status": "overdue",
				"is_recurrence": false,
				"recurrence": [],
				"external": 0,
				"proposal": false,
				"total_payments": 10,
				"due_date": "14/05/2025",
				"created_at": "08/04/2025 16:56",
				"updated_at": "15/05/2025 02:00",
				"client": {
					"hash_id": "1-9hZvwAO0wwOJF7DlaFw6Pen56k3fzPDNBShuFx40LzYmqwUWlr",
					"document": "44335865015",
					"name": "Luciano Medici Antunes",
					"email": "[email protected]",
					"email_notification": "[email protected]",
					"gender": "M",
					"birth_date": "1966-03-20",
					"zipcode": "04110060",
					"address": "Rua Baltazar Lisboa",
					"number_address": "148",
					"complement_address": "até 275/276",
					"district": "Vila Mariana",
					"city": "São Paulo",
					"state": "SP",
					"phone": "5551998606",
					"phone_notification": "",
					"type": "pf"
				},
				"payments": [
					{
						"hash_id": "324-s2Bq8sZ0B0SgJGFHhGdkglf2W7oB9AbqP5XOOd8sO1kEypCbhb",
						"amount_original": "50.00",
						"amount_paid": "50.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "15/04/2025 12:15",
						"last_conciliation_try_date": "19/05/2025 00:00",
						"created_by": "pagador",
						"method": "credit_card",
						"created_at": "15/04/2025 12:15",
						"updated_at": "19/05/2025 00:00"
					},
					{
						"hash_id": "322-jsYdC7wyeaNjOLQDJgBJiOtinvi7jUCuOflMfKPlayt9L9zo3c",
						"amount_original": "10.00",
						"amount_paid": "10.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "14/04/2025 16:05",
						"last_conciliation_try_date": "15/05/2025 23:57",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 16:05",
						"updated_at": "15/05/2025 23:57"
					},
					{
						"hash_id": "320-RPbgITd2nA57XKiwEYWanja7WBcIJxWHLyqNGGatG9LVb9lcqI",
						"amount_original": "10.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:34",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 15:34",
						"updated_at": "14/04/2025 15:34"
					},
					{
						"hash_id": "319-Nu27TrOy45ySe2qh5bsoLyPMbPVxZusEW4vn6Stuo1qafhUyMe",
						"amount_original": "25.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:31",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 15:30",
						"updated_at": "14/04/2025 15:31"
					},
					{
						"hash_id": "318-64D7sz0WfuwOmta3NvVm9Ci2qeup6J6Uqrut7WLPigjRxYTMoj",
						"amount_original": "25.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": " - ",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 15:29",
						"updated_at": "14/04/2025 15:29"
					},
					{
						"hash_id": "317-7FD0jvwznUEJIvV6A041M0CBU6UuDWKoCULm3oSX03dHahpUPP",
						"amount_original": "20.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:19",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 15:00",
						"updated_at": "14/04/2025 15:19"
					},
					{
						"hash_id": "316-kwJi5J7vyKNKdeAXhcauyUmS4lRZeXjePHvKWDyf1cpeWuxr9t",
						"amount_original": "15.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:19",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 14:51",
						"updated_at": "14/04/2025 15:19"
					},
					{
						"hash_id": "315-RYrnR9SZKvtdQNF28deZtNcwtAPzkJL9VpBbeG4nNYU4AJP7zR",
						"amount_original": "25.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:19",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 14:30",
						"updated_at": "14/04/2025 15:19"
					},
					{
						"hash_id": "314-5mZKSV9TYZW4OihUOunC5bMqbDna1JPg2TrnnJ0KDlW7LATYJC",
						"amount_original": "10.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:19",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 14:26",
						"updated_at": "14/04/2025 15:19"
					},
					{
						"hash_id": "305-y7KHWRxwXrbihmMzOUMm8BuEKzXxpLr6BgG38eBrdl7G1mDqrt",
						"amount_original": "50.00",
						"amount_paid": "50.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "08/04/2025 16:59",
						"last_conciliation_try_date": "12/05/2025 00:01",
						"created_by": "pagador",
						"method": "credit_card",
						"created_at": "08/04/2025 16:59",
						"updated_at": "12/05/2025 00:01"
					}
				],
				"method_payment": null,
				"link_solidarity_payment": "https://sandbox-pagamentos.gallopay.com.br/ajuda-liquidacao-cobranca/206-4Oo2sNNP9wIfb7inxMp2Qd29wiFK6gihNThOHZ4huuHus2fize",
				"link_invoice": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/206-4Oo2sNNP9wIfb7inxMp2Qd29wiFK6gihNThOHZ4huuHus2fize"
			},
			"amount_original": "50.00",
			"amount_paid": "50.00",
			"amount_proposal": null,
			"due_date": "2025-04-15",
			"paid_at": "2025-04-15 12:15:14",
			"installments": 1,
			"status": "paid",
			"method": "Cartão Crédito",
			"method_code": "credit_card",
			"rate": [
				{
					"name": "Cartão de crédito 1x (R$)",
					"method": "credit_card",
					"type": "v",
					"value": "{\"1\":\" 1.50\"}",
					"rate_antecipation": 0
				},
				{
					"name": "Cartão de crédito 1x (%)",
					"method": "credit_card",
					"type": "p",
					"value": "{\"1\":\"2.60\"}",
					"rate_antecipation": 0
				}
			],
			"is_internacional": 0,
			"document_url": null,
			"qrcode_img": "",
			"error": null,
			"document_hash": "",
			"payment_detail": {
				"credit_card_banner": "mastercard"
			},
			"created_at": "2025-04-15T15:15:12.000000Z",
			"updated_at": "2025-05-19T03:00:42.000000Z"
		},
		{
			"hash_id": "483-VYs9DzAwCz1rByLd3RWCXHpSfcNDKZOFzDKclsjsN0EcqBaQz0",
			"user": null,
			"charge": {
				"hash_id": "327-5t7LTvVqD3dBcGCZ3QFGUhpxQsUxMsgsEN6Skfa76DTmCABKe5",
				"description": "CObrança de teste",
				"leverage_days": 1,
				"leverage_min_percent": "0.00",
				"amount": "10.00",
				"total_paid": "0.00",
				"total_pending": "10.80",
				"taxes": {
					"daily_tax": "3.00%",
					"late_fine": "2.00%",
					"late_days": 2
				},
				"status": "overdue",
				"is_recurrence": false,
				"recurrence": [],
				"external": 0,
				"proposal": false,
				"total_payments": 1,
				"due_date": "17/05/2025",
				"created_at": "16/05/2025 14:58",
				"updated_at": "18/05/2025 02:00",
				"client": {
					"hash_id": "7-H6RHH12RIcZWdiSUEiKazLpDjjrcIC9mkCrTAGiUA9ucShMdXM",
					"document": "80459436023",
					"name": "Rai Moreira Rodrigues",
					"email": "[email protected]",
					"email_notification": "[email protected]",
					"gender": "M",
					"birth_date": "1992-12-17",
					"zipcode": "63113765",
					"address": "Rua Walmair Gonçalves de Oliveira",
					"number_address": "123",
					"complement_address": "Próximo aos Correios",
					"district": "Seminário",
					"city": "Crato",
					"state": "CE",
					"phone": "88997137063",
					"phone_notification": null,
					"type": "pf"
				},
				"payments": [
					{
						"hash_id": "483-VYs9DzAwCz1rByLd3RWCXHpSfcNDKZOFzDKclsjsN0EcqBaQz0",
						"amount_original": "10.00",
						"amount_paid": "10.00",
						"amount_proposal": "0.00",
						"status": "cancelled",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "16/05/2025 15:01",
						"last_conciliation_try_date": "18/05/2025 00:00",
						"created_by": "pagador",
						"method": "invoice",
						"created_at": "16/05/2025 14:58",
						"updated_at": "18/05/2025 00:00"
					}
				],
				"method_payment": "Boleto Instantâneo",
				"link_solidarity_payment": "",
				"link_invoice": null
			},
			"amount_original": "10.00",
			"amount_paid": "10.00",
			"amount_proposal": null,
			"due_date": "2025-05-17",
			"paid_at": "2025-05-16 15:01:22",
			"installments": 1,
			"status": "cancelled",
			"method": "Boleto Instantâneo",
			"method_code": "invoice",
			"rate": [
				{
					"name": "Boleto (%)",
					"method": "invoice",
					"type": "p",
					"value": "1.00",
					"rate_antecipation": 0
				}
			],
			"is_internacional": 0,
			"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/327-5t7LTvVqD3dBcGCZ3QFGUhpxQsUxMsgsEN6Skfa76DTmCABKe5",
			"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/ouxYZ520250516145821.png",
			"error": null,
			"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/aeb2eb4ae2d34f3f9455d20855fc78725204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***6304D9B2",
			"payment_detail": null,
			"created_at": "2025-05-16T17:58:34.000000Z",
			"updated_at": "2025-05-18T03:00:24.000000Z"
		},
		{
			"hash_id": "480-YV0HSf6Teot15FDGVUUfp5n6qJiNR7x1LIJG5yhlWw2BGiePSF",
			"user": null,
			"charge": {
				"hash_id": "324-wiQhhp06CyRRZ18p0jYl1rxLCpPgQiDPvJIOBvx1GFutwgHgGX",
				"description": "CObrança de teste",
				"leverage_days": 1,
				"leverage_min_percent": "0.00",
				"amount": "10.00",
				"total_paid": "10.00",
				"total_pending": "0.00",
				"taxes": [],
				"status": "paid",
				"is_recurrence": false,
				"recurrence": [],
				"external": 0,
				"proposal": false,
				"total_payments": 1,
				"due_date": "17/05/2025",
				"created_at": "16/05/2025 14:50",
				"updated_at": "16/05/2025 15:01",
				"client": {
					"hash_id": "7-H6RHH12RIcZWdiSUEiKazLpDjjrcIC9mkCrTAGiUA9ucShMdXM",
					"document": "80459436023",
					"name": "Rai Moreira Rodrigues",
					"email": "[email protected]",
					"email_notification": "[email protected]",
					"gender": "M",
					"birth_date": "1992-12-17",
					"zipcode": "63113765",
					"address": "Rua Walmair Gonçalves de Oliveira",
					"number_address": "123",
					"complement_address": "Próximo aos Correios",
					"district": "Seminário",
					"city": "Crato",
					"state": "CE",
					"phone": "88997137063",
					"phone_notification": null,
					"type": "pf"
				},
				"payments": [
					{
						"hash_id": "480-YV0HSf6Teot15FDGVUUfp5n6qJiNR7x1LIJG5yhlWw2BGiePSF",
						"amount_original": "10.00",
						"amount_paid": "10.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "16/05/2025 15:01",
						"last_conciliation_try_date": "16/05/2025 15:01",
						"created_by": "pagador",
						"method": "pix",
						"created_at": "16/05/2025 14:50",
						"updated_at": "16/05/2025 15:01"
					}
				],
				"method_payment": "PIX",
				"link_solidarity_payment": "",
				"link_invoice": null
			},
			"amount_original": "10.00",
			"amount_paid": "10.00",
			"amount_proposal": null,
			"due_date": "2025-05-17",
			"paid_at": "2025-05-16 15:01:02",
			"installments": 1,
			"status": "paid",
			"method": "PIX",
			"method_code": "pix",
			"rate": [
				{
					"name": "PIX (R$)",
					"method": "pix",
					"type": "v",
					"value": "0.00",
					"rate_antecipation": 0
				},
				{
					"name": "PIX (%)",
					"method": "pix",
					"type": "p",
					"value": "2.00",
					"rate_antecipation": 0
				}
			],
			"is_internacional": 0,
			"document_url": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/HsR3fm20250516145025.png",
			"qrcode_img": "",
			"error": null,
			"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/f3fac87d5d2f41b49a46be610fe435e55204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***63040DD4",
			"payment_detail": null,
			"created_at": "2025-05-16T17:50:39.000000Z",
			"updated_at": "2025-05-16T18:01:02.000000Z"
		},
		{
			"hash_id": "482-dk7E7o7SpFKzlSpRsOLn3gtRDRxBPRVRHm5spd6etZYGar6i9k",
			"user": null,
			"charge": {
				"hash_id": "326-nNkAcRRNOczSaHBh7BeCTdpFFdSEsYr3gHJ6vrcoPl7dDue3Xz",
				"description": "Parcela TV 50 Pol",
				"leverage_days": 1,
				"leverage_min_percent": "0.00",
				"amount": "500.00",
				"total_paid": "0.00",
				"total_pending": "500.00",
				"taxes": [],
				"status": "pending",
				"is_recurrence": false,
				"recurrence": [],
				"external": 0,
				"proposal": false,
				"total_payments": 1,
				"due_date": "07/06/2025",
				"created_at": "16/05/2025 14:51",
				"updated_at": "16/05/2025 15:00",
				"client": {
					"hash_id": "1-9hZvwAO0wwOJF7DlaFw6Pen56k3fzPDNBShuFx40LzYmqwUWlr",
					"document": "44335865015",
					"name": "Luciano Medici Antunes",
					"email": "[email protected]",
					"email_notification": "[email protected]",
					"gender": "M",
					"birth_date": "1966-03-20",
					"zipcode": "04110060",
					"address": "Rua Baltazar Lisboa",
					"number_address": "148",
					"complement_address": "até 275/276",
					"district": "Vila Mariana",
					"city": "São Paulo",
					"state": "SP",
					"phone": "5551998606",
					"phone_notification": "",
					"type": "pf"
				},
				"payments": [
					{
						"hash_id": "482-dk7E7o7SpFKzlSpRsOLn3gtRDRxBPRVRHm5spd6etZYGar6i9k",
						"amount_original": "500.00",
						"amount_paid": "500.00",
						"amount_proposal": "0.00",
						"status": "pending",
						"is_internacional": false,
						"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/326-nNkAcRRNOczSaHBh7BeCTdpFFdSEsYr3gHJ6vrcoPl7dDue3Xz",
						"digitable_line": "34191.09107 79718.007309 71444.640008 1 11050000050000",
						"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/4dd7b9187b414f57a6ac399d206a89c65204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***6304C44E",
						"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/JVL5f620250516145144.png",
						"expiration": "",
						"paid_at": "16/05/2025 15:00",
						"last_conciliation_try_date": "16/05/2025 15:00",
						"created_by": "backoffice",
						"method": "invoice",
						"created_at": "16/05/2025 14:51",
						"updated_at": "16/05/2025 15:00"
					}
				],
				"method_payment": null,
				"link_solidarity_payment": "https://sandbox-pagamentos.gallopay.com.br/ajuda-liquidacao-cobranca/326-nNkAcRRNOczSaHBh7BeCTdpFFdSEsYr3gHJ6vrcoPl7dDue3Xz",
				"link_invoice": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/326-nNkAcRRNOczSaHBh7BeCTdpFFdSEsYr3gHJ6vrcoPl7dDue3Xz"
			},
			"amount_original": "500.00",
			"amount_paid": "500.00",
			"amount_proposal": null,
			"due_date": "2025-06-07",
			"paid_at": "2025-05-16 15:00:52",
			"installments": 1,
			"status": "pending",
			"method": "Boleto Instantâneo",
			"method_code": "invoice",
			"rate": [
				{
					"name": "Boleto (%)",
					"method": "invoice",
					"type": "p",
					"value": "1.00",
					"rate_antecipation": 0
				}
			],
			"is_internacional": 0,
			"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/326-nNkAcRRNOczSaHBh7BeCTdpFFdSEsYr3gHJ6vrcoPl7dDue3Xz",
			"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/JVL5f620250516145144.png",
			"error": null,
			"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/4dd7b9187b414f57a6ac399d206a89c65204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***6304C44E",
			"payment_detail": null,
			"created_at": "2025-05-16T17:51:59.000000Z",
			"updated_at": "2025-05-16T18:00:52.000000Z"
		},
		{
			"hash_id": "478-6je45diNeRpWecB5BKaDnRaSwaeOBgPaCgamZjDYxoezsUy0kp",
			"user": null,
			"charge": {
				"hash_id": "323-5hnKpVuvlzFaqzqBTi7YghpD05NAmWlVnDRYbedG5TnXp3xCVg",
				"description": "Mensalidade",
				"leverage_days": 1,
				"leverage_min_percent": "0.00",
				"amount": "200.00",
				"total_paid": "40.00",
				"total_pending": "160.00",
				"taxes": [],
				"status": "paid",
				"is_recurrence": false,
				"recurrence": [],
				"external": 0,
				"proposal": false,
				"total_payments": 2,
				"due_date": "31/05/2025",
				"created_at": "15/05/2025 11:00",
				"updated_at": "15/05/2025 11:07",
				"client": {
					"hash_id": "1-9hZvwAO0wwOJF7DlaFw6Pen56k3fzPDNBShuFx40LzYmqwUWlr",
					"document": "44335865015",
					"name": "Luciano Medici Antunes",
					"email": "[email protected]",
					"email_notification": "[email protected]",
					"gender": "M",
					"birth_date": "1966-03-20",
					"zipcode": "04110060",
					"address": "Rua Baltazar Lisboa",
					"number_address": "148",
					"complement_address": "até 275/276",
					"district": "Vila Mariana",
					"city": "São Paulo",
					"state": "SP",
					"phone": "5551998606",
					"phone_notification": "",
					"type": "pf"
				},
				"payments": [
					{
						"hash_id": "479-bLP4GPdRWE796tJ8q6TRYHdv4Pj1VP08EhuDzupKYqvTO3AWvK",
						"amount_original": "40.00",
						"amount_paid": "40.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "15/05/2025 11:03",
						"last_conciliation_try_date": "15/05/2025 11:03",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "15/05/2025 11:03",
						"updated_at": "15/05/2025 11:03"
					},
					{
						"hash_id": "478-6je45diNeRpWecB5BKaDnRaSwaeOBgPaCgamZjDYxoezsUy0kp",
						"amount_original": "200.00",
						"amount_paid": "200.00",
						"amount_proposal": "0.00",
						"status": "pending",
						"is_internacional": false,
						"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/323-5hnKpVuvlzFaqzqBTi7YghpD05NAmWlVnDRYbedG5TnXp3xCVg",
						"digitable_line": "34191.09107 79695.647309 71444.640008 6 10980000020000",
						"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/cd090303423f403d9c27dc75785efb1d5204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***63045DC7",
						"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/fcuRVK20250515110249.png",
						"expiration": "",
						"paid_at": "15/05/2025 11:07",
						"last_conciliation_try_date": "16/05/2025 03:57",
						"created_by": "backoffice",
						"method": "invoice",
						"created_at": "15/05/2025 11:00",
						"updated_at": "16/05/2025 03:57"
					}
				],
				"method_payment": null,
				"link_solidarity_payment": "",
				"link_invoice": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/323-5hnKpVuvlzFaqzqBTi7YghpD05NAmWlVnDRYbedG5TnXp3xCVg"
			},
			"amount_original": "200.00",
			"amount_paid": "200.00",
			"amount_proposal": null,
			"due_date": "2025-05-31",
			"paid_at": "2025-05-15 11:07:37",
			"installments": 1,
			"status": "pending",
			"method": "Boleto Instantâneo",
			"method_code": "invoice",
			"rate": [
				{
					"name": "Boleto (%)",
					"method": "invoice",
					"type": "p",
					"value": "1.00",
					"rate_antecipation": 0
				}
			],
			"is_internacional": 0,
			"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/323-5hnKpVuvlzFaqzqBTi7YghpD05NAmWlVnDRYbedG5TnXp3xCVg",
			"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/fcuRVK20250515110249.png",
			"error": null,
			"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/cd090303423f403d9c27dc75785efb1d5204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***63045DC7",
			"payment_detail": null,
			"created_at": "2025-05-15T14:00:09.000000Z",
			"updated_at": "2025-05-16T06:57:45.000000Z"
		},
		{
			"hash_id": "322-jsYdC7wyeaNjOLQDJgBJiOtinvi7jUCuOflMfKPlayt9L9zo3c",
			"user": null,
			"charge": {
				"hash_id": "206-4Oo2sNNP9wIfb7inxMp2Qd29wiFK6gihNThOHZ4huuHus2fize",
				"description": "Assinatura Anual Caras",
				"leverage_days": 1,
				"leverage_min_percent": "0.00",
				"amount": "350.00",
				"total_paid": "110.00",
				"total_pending": "280.80",
				"taxes": {
					"daily_tax": "3.00%",
					"late_fine": "2.00%",
					"late_days": 5
				},
				"status": "overdue",
				"is_recurrence": false,
				"recurrence": [],
				"external": 0,
				"proposal": false,
				"total_payments": 10,
				"due_date": "14/05/2025",
				"created_at": "08/04/2025 16:56",
				"updated_at": "15/05/2025 02:00",
				"client": {
					"hash_id": "1-9hZvwAO0wwOJF7DlaFw6Pen56k3fzPDNBShuFx40LzYmqwUWlr",
					"document": "44335865015",
					"name": "Luciano Medici Antunes",
					"email": "[email protected]",
					"email_notification": "[email protected]",
					"gender": "M",
					"birth_date": "1966-03-20",
					"zipcode": "04110060",
					"address": "Rua Baltazar Lisboa",
					"number_address": "148",
					"complement_address": "até 275/276",
					"district": "Vila Mariana",
					"city": "São Paulo",
					"state": "SP",
					"phone": "5551998606",
					"phone_notification": "",
					"type": "pf"
				},
				"payments": [
					{
						"hash_id": "324-s2Bq8sZ0B0SgJGFHhGdkglf2W7oB9AbqP5XOOd8sO1kEypCbhb",
						"amount_original": "50.00",
						"amount_paid": "50.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "15/04/2025 12:15",
						"last_conciliation_try_date": "19/05/2025 00:00",
						"created_by": "pagador",
						"method": "credit_card",
						"created_at": "15/04/2025 12:15",
						"updated_at": "19/05/2025 00:00"
					},
					{
						"hash_id": "322-jsYdC7wyeaNjOLQDJgBJiOtinvi7jUCuOflMfKPlayt9L9zo3c",
						"amount_original": "10.00",
						"amount_paid": "10.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "14/04/2025 16:05",
						"last_conciliation_try_date": "15/05/2025 23:57",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 16:05",
						"updated_at": "15/05/2025 23:57"
					},
					{
						"hash_id": "320-RPbgITd2nA57XKiwEYWanja7WBcIJxWHLyqNGGatG9LVb9lcqI",
						"amount_original": "10.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:34",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 15:34",
						"updated_at": "14/04/2025 15:34"
					},
					{
						"hash_id": "319-Nu27TrOy45ySe2qh5bsoLyPMbPVxZusEW4vn6Stuo1qafhUyMe",
						"amount_original": "25.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:31",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 15:30",
						"updated_at": "14/04/2025 15:31"
					},
					{
						"hash_id": "318-64D7sz0WfuwOmta3NvVm9Ci2qeup6J6Uqrut7WLPigjRxYTMoj",
						"amount_original": "25.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": " - ",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 15:29",
						"updated_at": "14/04/2025 15:29"
					},
					{
						"hash_id": "317-7FD0jvwznUEJIvV6A041M0CBU6UuDWKoCULm3oSX03dHahpUPP",
						"amount_original": "20.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:19",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 15:00",
						"updated_at": "14/04/2025 15:19"
					},
					{
						"hash_id": "316-kwJi5J7vyKNKdeAXhcauyUmS4lRZeXjePHvKWDyf1cpeWuxr9t",
						"amount_original": "15.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:19",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 14:51",
						"updated_at": "14/04/2025 15:19"
					},
					{
						"hash_id": "315-RYrnR9SZKvtdQNF28deZtNcwtAPzkJL9VpBbeG4nNYU4AJP7zR",
						"amount_original": "25.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:19",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 14:30",
						"updated_at": "14/04/2025 15:19"
					},
					{
						"hash_id": "314-5mZKSV9TYZW4OihUOunC5bMqbDna1JPg2TrnnJ0KDlW7LATYJC",
						"amount_original": "10.00",
						"amount_paid": "0.00",
						"amount_proposal": "0.00",
						"status": "error",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "",
						"last_conciliation_try_date": "14/04/2025 15:19",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "14/04/2025 14:26",
						"updated_at": "14/04/2025 15:19"
					},
					{
						"hash_id": "305-y7KHWRxwXrbihmMzOUMm8BuEKzXxpLr6BgG38eBrdl7G1mDqrt",
						"amount_original": "50.00",
						"amount_paid": "50.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "08/04/2025 16:59",
						"last_conciliation_try_date": "12/05/2025 00:01",
						"created_by": "pagador",
						"method": "credit_card",
						"created_at": "08/04/2025 16:59",
						"updated_at": "12/05/2025 00:01"
					}
				],
				"method_payment": null,
				"link_solidarity_payment": "https://sandbox-pagamentos.gallopay.com.br/ajuda-liquidacao-cobranca/206-4Oo2sNNP9wIfb7inxMp2Qd29wiFK6gihNThOHZ4huuHus2fize",
				"link_invoice": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/206-4Oo2sNNP9wIfb7inxMp2Qd29wiFK6gihNThOHZ4huuHus2fize"
			},
			"amount_original": "10.00",
			"amount_paid": "10.00",
			"amount_proposal": null,
			"due_date": "2025-05-14",
			"paid_at": "2025-04-14 16:05:54",
			"installments": 1,
			"status": "paid",
			"method": "Cartão Crédito",
			"method_code": "credit_card",
			"rate": [
				{
					"name": "Cartão de crédito 1x (R$)",
					"method": "credit_card",
					"type": "v",
					"value": "{\"1\":\" 1.50\"}",
					"rate_antecipation": 0
				},
				{
					"name": "Cartão de crédito 1x (%)",
					"method": "credit_card",
					"type": "p",
					"value": "{\"1\":\"2.60\"}",
					"rate_antecipation": 0
				}
			],
			"is_internacional": 0,
			"document_url": null,
			"qrcode_img": "",
			"error": null,
			"document_hash": "",
			"payment_detail": {
				"credit_card_banner": "mastercard"
			},
			"created_at": "2025-04-14T19:05:51.000000Z",
			"updated_at": "2025-05-16T02:57:48.000000Z"
		},
		{
			"hash_id": "479-bLP4GPdRWE796tJ8q6TRYHdv4Pj1VP08EhuDzupKYqvTO3AWvK",
			"user": null,
			"charge": {
				"hash_id": "323-5hnKpVuvlzFaqzqBTi7YghpD05NAmWlVnDRYbedG5TnXp3xCVg",
				"description": "Mensalidade",
				"leverage_days": 1,
				"leverage_min_percent": "0.00",
				"amount": "200.00",
				"total_paid": "40.00",
				"total_pending": "160.00",
				"taxes": [],
				"status": "paid",
				"is_recurrence": false,
				"recurrence": [],
				"external": 0,
				"proposal": false,
				"total_payments": 2,
				"due_date": "31/05/2025",
				"created_at": "15/05/2025 11:00",
				"updated_at": "15/05/2025 11:07",
				"client": {
					"hash_id": "1-9hZvwAO0wwOJF7DlaFw6Pen56k3fzPDNBShuFx40LzYmqwUWlr",
					"document": "44335865015",
					"name": "Luciano Medici Antunes",
					"email": "[email protected]",
					"email_notification": "[email protected]",
					"gender": "M",
					"birth_date": "1966-03-20",
					"zipcode": "04110060",
					"address": "Rua Baltazar Lisboa",
					"number_address": "148",
					"complement_address": "até 275/276",
					"district": "Vila Mariana",
					"city": "São Paulo",
					"state": "SP",
					"phone": "5551998606",
					"phone_notification": "",
					"type": "pf"
				},
				"payments": [
					{
						"hash_id": "479-bLP4GPdRWE796tJ8q6TRYHdv4Pj1VP08EhuDzupKYqvTO3AWvK",
						"amount_original": "40.00",
						"amount_paid": "40.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "15/05/2025 11:03",
						"last_conciliation_try_date": "15/05/2025 11:03",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "15/05/2025 11:03",
						"updated_at": "15/05/2025 11:03"
					},
					{
						"hash_id": "478-6je45diNeRpWecB5BKaDnRaSwaeOBgPaCgamZjDYxoezsUy0kp",
						"amount_original": "200.00",
						"amount_paid": "200.00",
						"amount_proposal": "0.00",
						"status": "pending",
						"is_internacional": false,
						"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/323-5hnKpVuvlzFaqzqBTi7YghpD05NAmWlVnDRYbedG5TnXp3xCVg",
						"digitable_line": "34191.09107 79695.647309 71444.640008 6 10980000020000",
						"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/cd090303423f403d9c27dc75785efb1d5204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***63045DC7",
						"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/fcuRVK20250515110249.png",
						"expiration": "",
						"paid_at": "15/05/2025 11:07",
						"last_conciliation_try_date": "16/05/2025 03:57",
						"created_by": "backoffice",
						"method": "invoice",
						"created_at": "15/05/2025 11:00",
						"updated_at": "16/05/2025 03:57"
					}
				],
				"method_payment": null,
				"link_solidarity_payment": "",
				"link_invoice": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/323-5hnKpVuvlzFaqzqBTi7YghpD05NAmWlVnDRYbedG5TnXp3xCVg"
			},
			"amount_original": "40.00",
			"amount_paid": "40.00",
			"amount_proposal": null,
			"due_date": "2025-05-31",
			"paid_at": "2025-05-15 11:03:31",
			"installments": 1,
			"status": "paid",
			"method": "Cartão Crédito",
			"method_code": "credit_card",
			"rate": [
				{
					"name": "Cartão de crédito 1x (R$)",
					"method": "credit_card",
					"type": "v",
					"value": "{\"1\":\" 1.50\"}",
					"rate_antecipation": 0
				},
				{
					"name": "Cartão de crédito 1x (%)",
					"method": "credit_card",
					"type": "p",
					"value": "{\"1\":\"2.60\"}",
					"rate_antecipation": 0
				}
			],
			"is_internacional": 0,
			"document_url": null,
			"qrcode_img": "",
			"error": null,
			"document_hash": "",
			"payment_detail": {
				"credit_card_banner": "mastercard"
			},
			"created_at": "2025-05-15T14:03:26.000000Z",
			"updated_at": "2025-05-15T14:03:31.000000Z"
		},
		{
			"hash_id": "477-X65grE5CIfxAmfDhcOjOL01lqi2Cd8BpKjEKeEEl6nozPjkuhv",
			"user": null,
			"charge": {
				"hash_id": "322-2hrqjfNd5jI7joJIxhJL9LGezk8Rwog6IFztramdQW46ODqupZ",
				"description": "Mensalidade",
				"leverage_days": 1,
				"leverage_min_percent": "0.00",
				"amount": "100.00",
				"total_paid": "100.00",
				"total_pending": "0.00",
				"taxes": [],
				"status": "paid",
				"is_recurrence": false,
				"recurrence": [],
				"external": 0,
				"proposal": false,
				"total_payments": 1,
				"due_date": "31/05/2025",
				"created_at": "14/05/2025 14:04",
				"updated_at": "14/05/2025 14:07",
				"client": {
					"hash_id": "1-9hZvwAO0wwOJF7DlaFw6Pen56k3fzPDNBShuFx40LzYmqwUWlr",
					"document": "44335865015",
					"name": "Luciano Medici Antunes",
					"email": "[email protected]",
					"email_notification": "[email protected]",
					"gender": "M",
					"birth_date": "1966-03-20",
					"zipcode": "04110060",
					"address": "Rua Baltazar Lisboa",
					"number_address": "148",
					"complement_address": "até 275/276",
					"district": "Vila Mariana",
					"city": "São Paulo",
					"state": "SP",
					"phone": "5551998606",
					"phone_notification": "",
					"type": "pf"
				},
				"payments": [
					{
						"hash_id": "477-X65grE5CIfxAmfDhcOjOL01lqi2Cd8BpKjEKeEEl6nozPjkuhv",
						"amount_original": "100.00",
						"amount_paid": "100.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "14/05/2025 14:07",
						"last_conciliation_try_date": "14/05/2025 14:07",
						"created_by": "backoffice",
						"method": "invoice",
						"created_at": "14/05/2025 14:04",
						"updated_at": "14/05/2025 14:07"
					}
				],
				"method_payment": null,
				"link_solidarity_payment": "",
				"link_invoice": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/322-2hrqjfNd5jI7joJIxhJL9LGezk8Rwog6IFztramdQW46ODqupZ"
			},
			"amount_original": "100.00",
			"amount_paid": "100.00",
			"amount_proposal": null,
			"due_date": "2025-05-31",
			"paid_at": "2025-05-14 14:07:58",
			"installments": 1,
			"status": "paid",
			"method": "Boleto Instantâneo",
			"method_code": "invoice",
			"rate": [
				{
					"name": "Boleto (%)",
					"method": "invoice",
					"type": "p",
					"value": "1.00",
					"rate_antecipation": 0
				}
			],
			"is_internacional": 0,
			"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/322-2hrqjfNd5jI7joJIxhJL9LGezk8Rwog6IFztramdQW46ODqupZ",
			"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/2bE1sT20250514140716.png",
			"error": null,
			"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/cb4d8348602849b5bc87d8903b498e9d5204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***63044353",
			"payment_detail": null,
			"created_at": "2025-05-14T17:04:36.000000Z",
			"updated_at": "2025-05-14T17:07:58.000000Z"
		},
		{
			"hash_id": "474-AOcYIdB6B0W7Zqf2wqpARTiChF7LDI4O7tfUaf5n4nep6dIO8H",
			"user": null,
			"charge": {
				"hash_id": "321-BhrvzR8PWKm5RsTB84GEmhaAuqey48w1HDt85nGDKMssToFbvY",
				"description": "Compra de Janelas",
				"leverage_days": 1,
				"leverage_min_percent": "0.00",
				"amount": "500.00",
				"total_paid": "650.00",
				"total_pending": "-150.00",
				"taxes": [],
				"status": "paid",
				"is_recurrence": false,
				"recurrence": [],
				"external": 0,
				"proposal": false,
				"total_payments": 3,
				"due_date": "31/05/2025",
				"created_at": "13/05/2025 15:21",
				"updated_at": "13/05/2025 15:57",
				"client": {
					"hash_id": "1-9hZvwAO0wwOJF7DlaFw6Pen56k3fzPDNBShuFx40LzYmqwUWlr",
					"document": "44335865015",
					"name": "Cliente teste",
					"email": "[email protected],",
					"email_notification": "[email protected],",
					"gender": "M",
					"birth_date": "1990-01-01",
					"zipcode": "04110060",
					"address": "Av. Paulista",
					"number_address": "700",
					"complement_address": "até 275/276",
					"district": "Centro",
					"city": "São Paulo",
					"state": "SP",
					"phone": "11912345678",
					"phone_notification": "",
					"type": "pf"
				},
				"payments": [
					{
						"hash_id": "476-pMo4yuIY4jTdHdYvm5UszqVkNLtGOVd22Bk7e2YAVk5gXkvlVi",
						"amount_original": "50.00",
						"amount_paid": "50.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "13/05/2025 15:23",
						"last_conciliation_try_date": "13/05/2025 15:23",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "13/05/2025 15:23",
						"updated_at": "13/05/2025 15:23"
					},
					{
						"hash_id": "475-83Chjaf8sVHySoHDo0YhGDsfXEsV2ItonaDU3EjLP6c6AofALK",
						"amount_original": "100.00",
						"amount_paid": "100.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "13/05/2025 15:23",
						"last_conciliation_try_date": "13/05/2025 15:23",
						"created_by": "External",
						"method": "credit_card",
						"created_at": "13/05/2025 15:23",
						"updated_at": "13/05/2025 15:23"
					},
					{
						"hash_id": "474-AOcYIdB6B0W7Zqf2wqpARTiChF7LDI4O7tfUaf5n4nep6dIO8H",
						"amount_original": "500.00",
						"amount_paid": "500.00",
						"amount_proposal": "0.00",
						"status": "paid",
						"is_internacional": false,
						"document_url": "",
						"digitable_line": "",
						"document_hash": "",
						"qrcode_img": "",
						"expiration": "",
						"paid_at": "13/05/2025 15:57",
						"last_conciliation_try_date": "13/05/2025 15:57",
						"created_by": "backoffice",
						"method": "invoice",
						"created_at": "13/05/2025 15:21",
						"updated_at": "13/05/2025 15:57"
					}
				],
				"method_payment": null,
				"link_solidarity_payment": "",
				"link_invoice": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/321-BhrvzR8PWKm5RsTB84GEmhaAuqey48w1HDt85nGDKMssToFbvY"
			},
			"amount_original": "500.00",
			"amount_paid": "500.00",
			"amount_proposal": null,
			"due_date": "2025-05-31",
			"paid_at": "2025-05-13 15:57:57",
			"installments": 1,
			"status": "paid",
			"method": "Boleto Instantâneo",
			"method_code": "invoice",
			"rate": [
				{
					"name": "Boleto (%)",
					"method": "invoice",
					"type": "p",
					"value": "1.00",
					"rate_antecipation": 0
				}
			],
			"is_internacional": 0,
			"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/321-BhrvzR8PWKm5RsTB84GEmhaAuqey48w1HDt85nGDKMssToFbvY",
			"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/Ln0Ktu20250513152355.png",
			"error": null,
			"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/81354d7382b140f887ff96ab191911c95204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***6304CA04",
			"payment_detail": null,
			"created_at": "2025-05-13T18:21:15.000000Z",
			"updated_at": "2025-05-13T18:57:57.000000Z"
		}
	]
}

Parâmetros aplicados (filtros) na listagem de pagamentos (* = campos obrigatórios)

Valor Tipo Descrição
page* Integer Nº atual da paginação de elementos. O valor inicial deve ser 1.
search String Descrição para buscar um pagamento de um cliente. Pode ser: nome,documento ou e-mail de um cliente.
from Date Data de pagamento caso o filtro de status aplicado seja paid(pago). Para demais status, o sistema verifica a partir de quando houve atualização no pagamento. O formato deve ser: Y-m-d
to Date Data de pagamento caso o filtro de status aplicado seja paid(pago). Para demais status, o sistema verifica até quando houve atualização no pagamento. O formato deve ser: Y-m-d
status String Status do pagamento. Os status podem ser:
  1. processing //Processando
  2. pending //Pendente
  3. paid //Paga
  4. canceling //Cancelando
  5. cancelled //Cancelada
  6. overdue //Atrasada
  7. reversed / chargedback //Estornada
  8. received //Recebido (cartão de crédito)
  9. error //error

Filtrar por um pagamento específico


# Exemplo de requisição CURL para solicitar a criação de um nova pagamento
curl --request GET \
  --url {URL_BASE}/payment/checkStatusPayment/{hash_payment_id} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \

Para realizar a busca de um pagamento específico, deve-se requisitar este endpoint. Para tanto, deve-se realizar a seguinte requisição GET:
{URL_BASE}/payment/checkStatusPayment/{hash_payment_id}

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (200) = Ação bem-sucedida.
  2. Status (401) = Acesso não autorizado.
  3. Status (403) = Usuário não autenticado.
  4. Status (404) = Pagamento não encontrado.
  5. Status (419) = Sessão expirada.
  6. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  7. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"payment": {
		"hash_id": "481-NzMbuNweUcssDpC438f4pqyvjyr52V274rdh9hJT1MHGXrAHkk",
		"user": null,
		"charge": {
			"hash_id": "325-gn7383sTCQC6C7s470EUpzfdubOFiUqE5hIMlsnVvz71aFUMX7",
			"description": "Cobrança de teste",
			"leverage_days": 1,
			"leverage_min_percent": "0.00",
			"amount": "10.00",
			"total_paid": "10.00",
			"total_pending": "0.00",
			"taxes": [],
			"status": "paid",
			"is_recurrence": false,
			"recurrence": [],
			"external": 0,
			"proposal": false,
			"total_payments": 1,
			"due_date": "17/05/2025",
			"created_at": "16/05/2025 14:51",
			"updated_at": "16/05/2025 15:00",
			"client": {
				"hash_id": "7-H6RHH12RIcZWdiSUEiKazLpDjjrcIC9mkCrTAGiUA9ucShMdXM",
        "document": "80459436023",
        "name": "Cliente teste",
        "email": "[email protected],
        "email_notification": "[email protected],
        "gender": "M",
        "birth_date": "1990-01-01",
        "zipcode": "63113765",
        "address": "Av. Paulista",
        "number_address": "700",
        "complement_address": "Próximo ao MASP",
        "district": "Centro",
        "city": "São Paulo",
        "state": "UF",
        "phone": "11912345678",
        "phone_notification": null,
        "type": "pf"
			},
			"payments": [
				{
					"hash_id": "481-NzMbuNweUcssDpC438f4pqyvjyr52V274rdh9hJT1MHGXrAHkk",
					"amount_original": "10.00",
					"amount_paid": "10.00",
					"amount_proposal": "0.00",
					"status": "paid",
					"is_internacional": false,
					"document_url": "",
					"digitable_line": "",
					"document_hash": "",
					"qrcode_img": "",
					"expiration": "",
					"paid_at": "19/05/2025 11:21",
					"last_conciliation_try_date": "19/05/2025 11:24",
					"created_by": "pagador",
					"method": "invoice",
					"created_at": "16/05/2025 14:51",
					"updated_at": "19/05/2025 11:24"
				}
			],
			"method_payment": null,
			"link_solidarity_payment": "",
			"link_invoice": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/325-gn7383sTCQC6C7s470EUpzfdubOFiUqE5hIMlsnVvz71aFUMX7"
		},
		"amount_original": "10.00",
		"amount_paid": "10.00",
		"amount_proposal": null,
		"due_date": "2025-05-17",
		"paid_at": "2025-05-19 11:21:54",
		"installments": 1,
		"status": "paid",
		"method": "Boleto Instantâneo",
		"method_code": "invoice",
		"rate": [
			{
				"name": "Boleto (%)",
				"method": "invoice",
				"type": "p",
				"value": "1.00",
				"rate_antecipation": 0
			}
		],
		"is_internacional": 0,
		"document_url": "https://sandbox-pagamentos.gallopay.com.br/pdf-invoice/325-gn7383sTCQC6C7s470EUpzfdubOFiUqE5hIMlsnVvz71aFUMX7",
		"qrcode_img": "https://genial-pay.sfo3.digitaloceanspaces.com/genialpay/pix/MN2M1Q20250516145105.png",
		"error": null,
		"document_hash": "00020101021226940014br.gov.bcb.pix2572brcode-h.sandbox.starkinfra.com/v2/cobv/e8eda760b87d4eb8bd77b6c0520ca3a55204000053039865802BR592551.627.104 rai Moreira Ro6005Crato62070503***63047B25",
		"payment_detail": null,
		"created_at": "2025-05-16T17:51:21.000000Z",
		"updated_at": "2025-05-19T14:24:18.000000Z"
	}
}

Listagem de ofertas


# Exemplo de requisição CURL para listagem de ofertas
curl --request GET \
  --url {URL_BASE}/proposal \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxx' \
  --data '{
	"page":"1",
	"search":"Oferta de teste"
}'

Para realizar a listagem de ofertas cadastradas, deve-se realizar a seguinte requisição GET:
{URL_BASE}/proposal

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (200) = Ação bem-sucedida.
  2. Status (401) = Acesso não autorizado.
  3. Status (403) = Usuário não autenticado.
  4. Status (419) = Sessão expirada.
  5. Status (422) = Validação dados enviados não aceita.
  6. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  7. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"last_page": 1,
	"total_itens": 1,
	"current_page": 1,
	"has_page": false,
	"per_page": 10,
	"data": [
		{
			"id": 2,
			"hash_id": "2-ohvMfXJAvlDnBAQ8QHXWT0U4qHY9kDE733cFRTAthaf9CxIw0H",
			"user": {
				"id": 16,
				"hash_id": "16-d6UuwesqDtYypSk8WIyXktZX2tyHWWQvY0Ok4UojTpKUTqbnTG",
				"hash_sso_id": "23-4eRawnlG5OYE0Hc1R5wWyCQQrGNv5RoBO830QPosI6VItb5yrv",
				"name": "Luciano",
				"email": "[email protected]",
				"email_verified_at": null,
				"active": 1,
				"time_session": 60,
				"tow_factor_authentication": 0,
				"photo_profile": null,
				"created_at": "2025-02-03T20:10:04.000000Z",
				"updated_at": "2025-02-03T20:10:05.000000Z",
				"deleted_at": null
			},
			"description": "Oferta 15% especial",
			"type": null,
			"offer_percentage": "15.00",
			"minimum_value_percentage": "0.00",
			"start_date": "07/03/2025 00:00:00",
			"end_date": "15/03/2025 00:00:00",
			"status": "finished",
			"filter": "defaulter",
			"number_of_eligible_client": 8,
			"amount_expected_return": "3206.00",
			"path_list_client": "",
			"created_at": "07/03/2025 17:33:25"
		},
		
	]
}

Parâmetros aplicados (filtros) na listagem de clientes (* = campos obrigatórios)

Valor Tipo Descrição
page* Integer Nº atual da paginação de elementos. O valor inicial deve ser 1.
search String Descrição da oferta.

Logs


# Exemplo de requisição CURL para de logs registrados
curl --request GET \
  --url {URL_BASE}/audit \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
	"page":"1",
	"search":"Cliente teste"
}'

Para realizar de logs registrados no sistema, deve-se realizar a seguinte requisição GET:
{URL_BASE}/audit

Nota: endpoint que exige autenticação: informar o Authorization : Bearer xxxx no header


Possíveis retornos:

  1. Status (200) = Ação bem-sucedida.
  2. Status (401) = Acesso não autorizado.
  3. Status (403) = Usuário não autenticado.
  4. Status (419) = Sessão expirada.
  5. Status (422) = Validação dados enviados não aceita.
  6. Status (423) = Sistema parcial ou totalmente bloqueado para requisições.
  7. Status (500) = Erro interno no servidor.


Exemplo de retorno :

{
	"data": [
		{
			"id": 10023,
			"hash_id": "10023-FvtESDVq3lnvWzA1gHr6c4cJUJagBYlAJxOByJuJJEBLk5jbG3",
			"user": "[email protected]",
			"method": "GET",
			"action": "http://sandbox-pagamentos.gallopay.com.br/api/v1/client",
			"ip": "2804:29b8:5011:bec7:74e2:8f00:41c9:5182",
			"agent": "insomnia/9.3.2",
			"observation": "Sucesso",
			"created_at": "21/05/2025 10:22:47"
		},
	],
	"last_page": 1,
	"total_itens": 1,
	"current_page": 1,
	"has_page": true,
	"per_page": 10
}

Parâmetros aplicados (filtros) na listagem de logs (* = campos obrigatórios)

Valor Tipo Descrição
page* Integer Nº atual da paginação de elementos. O valor inicial deve ser 1.
search String Descrição para buscar um log específico. Pode ser: ee-mail do usuário, ação, IP ou observações realizadas.