Início

    API Endpoint

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

Esta API tem por finalidade permitir a interação com o sistema Gallopay - Módulo de checkout. O endpoint base no ambiente de sandbox para testes é: https://sandbox-vendas.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 pagamentos, clique aqui

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' \
  --header 'User-Agent: insomnia/10.1.1' \
  --data '{
	"email":"[email protected]",
	"password":"******"
}'
                

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

Exemplo de retorno :

{
	"hash_id": "1-123",
	"token": "Bearer 1|123",
	"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 do usuário cadastrado no sistema.
password*	String	Senha de acesso do usuário cadastrado no sistema.

Listagem de clientes

# Exemplo de requisição CURL para autenticação
curl --request GET \
  --url {URL_BASE}/client \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 1|q123' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: insomnia/10.1.1' \
  --data '{
	"page":1
}'
                

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

Exemplo de retorno :

{
	"last_page": 1,
	"total_itens": 1,
	"current_page": 1,
	"has_page": false,
	"per_page": 10,
	"clients": [
		{
			"hash_id": "1-Ocfqag6lh0GoBglZwmCff7R1UEoDAo9m16kNGjXKZWCIVKy6Xs",
			"document": "80459436023",
			"name": "Rai Moreira",
			"email": "[email protected]",
			"gender": "M",
			"birth_date": "1990-01-01",
			"zipcode": "63100-020",
			"address": "Rua José Carvalho",
			"number_address": "123",
			"complement_address": null,
			"district": "Centro",
			"city": "Crato",
			"state": "CE",
			"phone": "88997137063",
			"type": "pf",
			"charges_overdue": 0,
			"charges_paid": 0
		}
	]
}
                

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

Valor	Tipo	Descrição
page*	Integer	Número da página que deseja retornar.
search	String	Buscar cobranças de clientes específico. O campo search pode ser o CPF, nome do cliente, endereço ou e-mail.

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 'Authorization: Bearer 1|123' \
  --header 'Content-Type: application/json' \
  --data '{
	"page":1
}'
                

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

Exemplo de retorno :

{
	"last_page": 1,
	"total_itens": 1,
	"current_page": 1,
	"has_page": false,
	"per_page": 10,
	"charges": [
		{
			"hash_id": "1-mwifwHHpujxh0MxcJcQizYfmlglz9cr3XpHIuXvZuVoD0UtuBI",
			"product": {
				"id": 1,
				"description": "Nexus 24 Horas",
				"link": null,
				"amount": "45.00",
				"active": true,
				"coupon_application": true,
				"prorata": false,
				"enable_due_date": false,
				"recurrence_interval": "monthly",
				"file": [
					"https:\/\/bitplus.sfo3.digitaloceanspaces.com\/sandbox\/01123456000190\/file\/product\/pV1iQb2ghnzJPPXtZ424MCsZaiM9MWI0Z1r3koOk.png"
				]
			},
			"seller": {
				"hash_id": "2-rHeyzNZeJp3d6VidcuBW9S2Lo8KVHWAmXx4EwBjgzn06RHIYUh",
				"name": "Luciano Antunes",
				"email": "[email protected]",
				"document":"xxxxxxxxxxx",
				"address": "Rua Baltazar Lisboa",
				"number_address": "148",
				"complement_address": "507",
				"district": "Vila Mariana",
				"city": "São Paulo",
				"state": null,
				"phone": "51998843216",
				"active": true,
				"ghost": false
			},
			"description": "Venda BitPlus - Nexus 24 Horas",
			"amount": "45.00",
			"code_coupon": "",
			"type_coupon": "",
			"amount_coupon": "",
			"method": "Boleto",
			"status": "pending",
			"due_date": "2024-11-06",
			"client": {
				"hash_id": "1-Ocfqag6lh0GoBglZwmCff7R1UEoDAo9m16kNGjXKZWCIVKy6Xs",
				"document": "80459436023",
				"name": "Rai Moreira",
				"email": "[email protected]",
				"gender": "M",
				"birth_date": "1990-01-01",
				"zipcode": "63100-020",
				"address": "Rua José Carvalho",
				"number_address": "123",
				"complement_address": null,
				"district": "Centro",
				"city": "Crato",
				"state": "CE",
				"phone": "88997137063",
				"type": "pf",
				"charges_overdue": 0,
				"charges_paid": 0
			},
			"payments": [
				{
					"hash_id": "1-4nHgtmrgF6hihigkEqHUXOhznxXlNO3IagWgmJaF6M1MfjILDQ",
					"description": "Venda BitPlus - Nexus 24 Horas",
					"amount_original": "45.00",
					"amount_paid": "0.00",
					"due_date": "2024-11-06",
					"installments": 1,
					"status": "pending",
					"paid_at": "",
					"method": "ticket",
					"created_at": "05\/11\/2024 05:55",
					"updated_at": "05\/11\/2024 05:56"
				}
			],

			"hierarchy": [],
			"comissions": [],
		}
	]
}
                

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

Valor	Tipo	Descrição
page*	Integer	Número da página que deseja retornar.
search	String	Buscar cobranças de clientes específico. O campo search pode ser o CPF, nome do cliente, endereço ou e-mail.
from	Date	Filtra as cobranças com vencimento a partir da data informada.
to	Date	Filtra as cobranças com vencimento até a data informada.
status	String	Filtra as cobranças com base em seus status: (processing,pending,paid,cancelled,overdue,error,received,chargedback)

Buscar uma cobrança específica

# Exemplo de requisição CURL para listagem de cobranças
curl --request GET \
  --url {URL_BASE}/charge/{hash_id} \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 1|123' \
  --header 'Content-Type: application/json' \
 '
                

Para realizar a visualização de uma cobrança específica, deve-se realizar a seguinte requisição GET:
{URL_BASE}/charge/{hash_id}

Exemplo de retorno :

{
	"charge": {
		"hash_id": "1-mwifwHHpujxh0MxcJcQizYfmlglz9cr3XpHIuXvZuVoD0UtuBI",
		"product": {
			"id": 1,
			"description": "Nexus 24 Horas",
			"link": null,
			"amount": "45.00",
			"active": true,
			"coupon_application": true,
			"prorata": false,
			"enable_due_date": false,
			"recurrence_interval": "monthly",
			"file": [
				"https:\/\/bitplus.sfo3.digitaloceanspaces.com\/sandbox\/01123456000190\/file\/product\/pV1iQb2ghnzJPPXtZ424MCsZaiM9MWI0Z1r3koOk.png"
			]
		},
		"seller": {
			"hash_id": "2-rHeyzNZeJp3d6VidcuBW9S2Lo8KVHWAmXx4EwBjgzn06RHIYUh",
			"name": "Luciano Antunes",
			"email": "[email protected]",
			"document":"xxxxxxxxxxx",
			"address": "Rua Baltazar Lisboa",
			"number_address": "148",
			"complement_address": "507",
			"district": "Vila Mariana",
			"city": "São Paulo",
			"state": null,
			"phone": "51998843216",
			"active": true,
			"ghost": false,
			"role": [
				"seller"
			]
		},
		"description": "Venda BitPlus - Nexus 24 Horas",
		"amount": "45.00",
		"code_coupon": "",
		"type_coupon": "",
		"amount_coupon": "",
		"method": "Boleto",
		"status": "pending",
		"due_date": "2024-11-06",
		"client": {
			"hash_id": "1-Ocfqag6lh0GoBglZwmCff7R1UEoDAo9m16kNGjXKZWCIVKy6Xs",
			"document": "80459436023",
			"name": "Rai Moreira",
			"email": "[email protected]",
			"gender": "M",
			"birth_date": "1990-01-01",
			"zipcode": "63100-020",
			"address": "Rua José Carvalho",
			"number_address": "123",
			"complement_address": null,
			"district": "Centro",
			"city": "Crato",
			"state": "CE",
			"phone": "88997137063",
			"type": "pf",
			"charges_overdue": 0,
			"charges_paid": 0
		},
		"payments": [
			{
				"hash_id": "1-4nHgtmrgF6hihigkEqHUXOhznxXlNO3IagWgmJaF6M1MfjILDQ",
				"description": "Venda BitPlus - Nexus 24 Horas",
				"amount_original": "45.00",
				"amount_paid": "0.00",
				"due_date": "2024-11-06",
				"installments": 1,
				"status": "pending",
				"paid_at": "",
				"method": "ticket",
				"created_at": "05\/11\/2024 05:55",
				"updated_at": "05\/11\/2024 05:56"
			}
		],
		"hierarchy": [],
		"comissions": []
	}
}
                

Parâmetros visualização cobrança única (* = campos obrigatórios)

Valor	Tipo	Descrição
Hash id*	String	Identificador único de cada cobrança.

Listagem de recorrências

# Exemplo de requisição CURL para listagem de recorrências
curl --request GET \
  --url {URL_BASE}/recurrence \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 1|123' \
  --header 'Content-Type: application/json' \
  --data '{
	"page":1
}'
                

Para realizar a listagem de recorrências, deve-se realizar a seguinte requisição GET:
{URL_BASE}/recurrence

Exemplo de retorno :

{
	"last_page": 1,
	"total_itens": 1,
	"current_page": 1,
	"has_page": false,
	"per_page": 10,
	"recurrences": [
		{
			"hash_id": "1-NmApgBIZRVHzdvUq6iPLPEtdEnLnT2x365svE68URRtCqCLhI3",
			"description": "Venda recorrente BitPlus - Por Luciano Antunes",
			"amount": "45.00",
			"first_due_date": "2024-11-05",
			"expiration_day": 5,
			"total_installment": 0,
			"current_installment": 1,
			"recurrence_interval": "monthly",
			"method_payment": "ticket",
			"type_coupon": "",
			"amount_coupon": "",
			"code_coupon": "",
			"observation": "",
			"status": "pending",
			"total_charge_generate": 1,
			"total_charge_paid": 0,
			"total_charge_overdue": 0,
			"seller": {
				"hash_id": "2-rHeyzNZeJp3d6VidcuBW9S2Lo8KVHWAmXx4EwBjgzn06RHIYUh",
				"name": "Luciano Antunes",
				"email": "[email protected]",
				"address": "Rua Baltazar Lisboa",
				"number_address": "148",
				"complement_address": "507",
				"district": "Vila Mariana",
				"city": "São Paulo",
				"state": null,
				"phone": "51998843216",
				"active": true,
				"ghost": false
			},
			"client": {
				"hash_id": "1-Ocfqag6lh0GoBglZwmCff7R1UEoDAo9m16kNGjXKZWCIVKy6Xs",
				"document": "80459436023",
				"name": "Rai Moreira",
				"email": "[email protected]",
				"gender": "M",
				"birth_date": "1990-01-01",
				"zipcode": "63100-020",
				"address": "Rua José Carvalho",
				"number_address": "123",
				"complement_address": null,
				"district": "Centro",
				"city": "Crato",
				"state": "CE",
				"phone": "88997137063",
				"type": "pf",
				"charges_overdue": 0,
				"charges_paid": 0
			},
			"charges": [
				{
					"hash_id": "1-mwifwHHpujxh0MxcJcQizYfmlglz9cr3XpHIuXvZuVoD0UtuBI",
					"product": {
						"id": 1,
						"description": "Nexus 24 Horas",
						"link": null,
						"amount": "45.00",
						"active": true,
						"coupon_application": true,
						"prorata": false,
						"enable_due_date": false,
						"recurrence_interval": "monthly",
						"file": [
							"https:\/\/bitplus.sfo3.digitaloceanspaces.com\/sandbox\/01123456000190\/file\/product\/pV1iQb2ghnzJPPXtZ424MCsZaiM9MWI0Z1r3koOk.png"
						]
					},
					"seller": {
						"hash_id": "2-rHeyzNZeJp3d6VidcuBW9S2Lo8KVHWAmXx4EwBjgzn06RHIYUh",
						"name": "Luciano Antunes",
						"email": "[email protected]",
						"document":"xxxxxxxxxxx",
						"address": "Rua Baltazar Lisboa",
						"number_address": "148",
						"complement_address": "507",
						"district": "Vila Mariana",
						"city": "São Paulo",
						"state": null,
						"phone": "51998843216",
						"active": true,
						"ghost": false
					},
					"description": "Venda BitPlus - Nexus 24 Horas",
					"amount": "45.00",
					"code_coupon": "",
					"type_coupon": "",
					"amount_coupon": "",
					"method": "Boleto",
					"status": "pending",
					"due_date": "2024-11-06",
					"client": {
						"hash_id": "1-Ocfqag6lh0GoBglZwmCff7R1UEoDAo9m16kNGjXKZWCIVKy6Xs",
						"document": "80459436023",
						"name": "Rai Moreira",
						"email": "[email protected]",
						"gender": "M",
						"birth_date": "1990-01-01",
						"zipcode": "63100-020",
						"address": "Rua José Carvalho",
						"number_address": "123",
						"complement_address": null,
						"district": "Centro",
						"city": "Crato",
						"state": "CE",
						"phone": "88997137063",
						"type": "pf",
						"charges_overdue": 0,
						"charges_paid": 0
					},
					"payments": [
						{
							"hash_id": "1-4nHgtmrgF6hihigkEqHUXOhznxXlNO3IagWgmJaF6M1MfjILDQ",
							"description": "Venda BitPlus - Nexus 24 Horas",
							"amount_original": "45.00",
							"amount_paid": "0.00",
							"due_date": "2024-11-06",
							"installments": 1,
							"status": "pending",
							"paid_at": "",
							"method": "ticket",
							"created_at": "05\/11\/2024 05:55",
							"updated_at": "05\/11\/2024 05:56"
						}
					]
				}
			]
		}
	]
}
                

Parâmetros da listagem de recorrências (* = campos obrigatórios)

Valor	Tipo	Descrição
page*	Integer	Número da página que deseja retornar.
search	String	Buscar assinaturas de clientes específico. O campo search pode ser o CPF, nome do cliente, endereço ou e-mail.
from	Date	Filtra as assinaturas criadas a partir da data informada.
to	Date	Filtra as assinaturas criadas até a data informada.
status	String	Filtra as assinaturas com base em seus status: (pending,completed,error)

Listagem de produtos

# Exemplo de requisição CURL para listagem de produtos
curl --request GET \
  --url {URL_BASE}/product \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 1|123' \
  --header 'Content-Type: application/json' \
  --data '{
	"page":1
}'
                

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

Exemplo de retorno :

{
	"last_page": 1,
	"total_itens": 1,
	"current_page": 1,
	"has_page": false,
	"per_page": 10,
	"products": [
		{
			"id": 1,
			"description": "Nexus 24 Horas",
			"link": null,
			"amount": "45.00",
			"active": true,
			"coupon_application": true,
			"prorata": false,
			"enable_due_date": false,
			"recurrence_interval": "monthly",
			"file": [
				"https:\/\/bitplus.sfo3.digitaloceanspaces.com\/sandbox\/01123456000190\/file\/product\/pV1iQb2ghnzJPPXtZ424MCsZaiM9MWI0Z1r3koOk.png"
			]
		}
	]
}
                

Parâmetros da listagem de produtos (* = campos obrigatórios)

Valor	Tipo	Descrição
page*	Integer	Número da página que deseja retornar.
search	String	Buscar produtos específicos. O campo search pode deve ser a descrição do produto por completo ou apenas uma parte.

Listagem de cupons

# Exemplo de requisição CURL para listagem de cupons
curl --request GET \
  --url {URL_BASE}/coupon \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 1|123' \
  --header 'Content-Type: application/json' \
  --data '{
	"page":1
}'
                

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

Exemplo de retorno :

{
	"last_page": 1,
	"total_itens": 1,
	"current_page": 1,
	"has_page": false,
	"per_page": 10,
	"coupons": [
		{
			"hash_id": "1-5krGJcgNRAvF3iSboukMXfbKu5fzeSez8ypUUfjvYbLtph0cEg",
			"code": "10off",
			"limit": 100,
			"date_end": "2025-01-01",
			"type": "p",
			"amount": "10.00",
			"use": "Apenas na 1ª cobrança",
			"status": 1
		}
	]
}
                

Parâmetros da listagem de produtos (* = campos obrigatórios)

Valor	Tipo	Descrição
page*	Integer	Número da página que deseja retornar.
search	String	Buscar cupons específicos. O campo search pode deve ser o código do cupom por completo ou apenas uma parte.