Transações

Como solicitar um relatório de transações?

Lembrando que, para garantir o êxito da requisição, é essencial incluir o access_token. Este token é adquirido durante o processo de autenticação da conta e deve ser incorporado à solicitação.

Para requisitar um relatório de trasações, é necessário enviar uma solicitação do tipo GET para o endpoint indicado, incluindo os parâmetros de consulta necessários:

Transações

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

successful

No content

401

authorization failed

422

validation failed

500

unknown server error

get

/internal/api/v1/transactions

HTTPcURLJavaScriptPython

GET /internal/api/v1/transactions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Passando os seguinte parâmetros:

initialDate (string): "yyyy-mm-dd" ,

Para a data inicial que queira pesquisar a transação;

finalDate (string): "yyyy-mm-dd" ,

Para a data final que queira pesquisar a transação;

page (int): 1,

Para a quantidade de página da resquisição;

limit (int): 1

Para o limite de transações que você queira que apareça na busca;

A consulta gera um objeto JSON que apresenta detalhadamente as informações das transações relacionadas à conta consultada.

{
  "page": 1,
  "limit": "1",
  "size": 68,
  "data": {
	"balance": {
		"corporateName": "REVIVE CARE DESCARTAVEIS HOPITALARES DO BRASIL LTDA",
		"balance": 321.15,
		"credit": 1007.46,
		"debit": 686.31,
		"dtBalance": "2024-02-26T17:08:57.720Z"
	},
	"transactions": [
		{
		  "endToEnd": "E1116575620240223204013040677372",
		  "dtHrTransaction": "2024-02-23T17:40:13",
		  "owner": "REVIVE CARE DESCARTAVEIS HOPITALARES DO BRASIL LTDA",
		  "type": "D",
		  "subType": "PIX",
		  "description": "",
		  "name": "REVIVE CARE DESCARTAVEIS HOPITALARES DO BRASIL LTDA",
		  "document": null,
		  "amount": "0.01",
		  "status": "SUCCESS",
		  "taxId": "",
		  "documentPayer": "",
		  "documentReceiver": "",
		  "payer": {
			  "name": "REVIVE CARE DESCARTAVEIS HOPITALARES DO BRASIL LTDA",
			  "bank": "GLOBAL SCM LTDA",
			  "ispb": "11165756",
			  "agency": "2",
			  "accountNumber": "2",
			  "accountType": "CONTA_CORRENTE"
			},
			  "receiver": {
			  "name": "PAY4FUN IP S.A.",
			  "bank": "-",
			  "ispb": "20757199",
			  "agency": "1",
			  "accountNumber": "1",
			  "accountType": "CONTA_CORRENTE",
			  "key": "12560480034"
				}
			}
		]
	}
}

Descrição dos campos:

corporateName (string): Razão social da empresa.

balance (decimal): Saldo total da conta.

credit (decimal): valor creditado na conta.

debit (decimal): valor debitado na conta.

dtBalance (string): Data e hora do último saldo registrado.

transactions (list): irá mostrar os dados da transação.