3.3 - Queries

Search by Payment Orders

API Method = GetPaymentOrder

Through this method, the customer is able to query Payment Orders by TaxNumbe, by its Identifier applied by the customer in its emission (Identifier), by its Document Number generated after the successfull emission of the payment order (PaymentOrderId), by its status (PaymentOrderStatus) or by its payment date (PaymentDate).

It is also possible to organize how the search results can be presented, using the Index and PageSize fields.

{
     "Method": "GetPaymentOrder",
     "PartnerId": 30750,
     "BusinessUnitId": 61799,
     "TaxNumber": "77708946034",
     "PaymentDate": null,
     "PaymentOrderId": null,
     "PaymentOrderStatus": null,
     "Identifier": null,
     "Index": 0,
     "PageSize": 10
}

{
  "success": true,
  "paymentOrderList": [
    {
      "PaymentOrderId": 17841525,
      "Name": "Monica Santos",
      "TaxNumber": "77708946034",
      "Status": "Settled",
      "PaymentDate": "2023/06/02",
      "Type": "SPEI",
      "Identifier": "GWi6x30230602783950708790000631",
      "ReasonCode": null
    }
  ]
}

Description:

Parameters	Description	Mandatory	Type
Method	API method to be used	YES	STRING
PartnerId	Partner ID provided by Fitbank	YES	INT64
BusinessUnitId	Business Unit ID provided by Fitbank	YES	INT64
TaxNumber	User's Social Security Number	NO	STRING
PaymentDate	Date of the operation	NO	STRING
PaymentOrderId	Payment order identification	NO	INT64
PaymentOrderStatus	Operation status	NO	INTEGER
Identifier	External identifier	NO	STRING
Index	Reference of which page will be accessed	NO	INTEGER
PageSize	Number of results that will be displayed on the same page	NO	INTEGER

In addition to the required fields, it is necessary to inform some transaction data in order to obtain a result.

Json return from GetPaymentOrder

Parameters	Description	Comments	Type
PaymentOrderId	Payment order identification	None	LONG (NUMBER)
Name	Beneficiary's name	None	STRING (TEXT)
TaxNumber	User's Social Security Number	None	STRING (TEXT)
Status	Operation status	None	STRING (TEXT)
PaymentDate	Date of operation	None	STRING (TEXT)
Type	Operation type	None	STRING (TEXT)
Identifier	External identifier	None	STRING (TEXT)
ReasonCode	Reason for canceling the payment order	If the payment order is not canceled it will appear as null	STRING (TEXT)

PaymentOrder Status

Status	Title	Description
0	Created	Created Payment Order
2	Settled	Payment concluded either by SPEI or Internal
3	Canceled	Cancel reason description
4	Registered	Registered after transaction validations

Updated 4 months ago

What’s Next

1.5 Webhooks