Financial API
This version consists of 12 endpoints, 10 "Payment Level" endpoint which together provides the values related to different types of transactions for a payment conciliation, 1 "Cancellation Level" endpoint which deliver details of cancellations that are not paid either considered in the "Payment Level" endpoints, and 1 "Contract Level" endpoint which provides informavtion of the contract and it's conditions which also can argue the charges related in the "Payment Level" endpoints.
To build a payment, first use the payments
endpoint, and upon receiving the payment identifier you wish to inquire about, use it to query the remaining "Payment Level" endpoints.
The contracts
endpoint will provide you with information about the configured conditions in Rappi that underlie the charged amounts for each concept within a payment.
To search using payment_id
, assume that payment_id
is only updated according to the payment frequency (weekly, biweekly, monthly). If the search is done before the last day of the payment period the data would be from the previous period and before. The most recent information is going to be available only one day after the end of the payment period (work days only).
You can use the operators in the query string, like in the request /v1/stores/12345/payments?confirmed_payment_date:lte=2023-01-01
, where the operator lte
is used. Notice that not all the operators are available in the API, see the documentation of each endpoint to learn what are the available fields and operators available.
Operator | Description |
---|---|
eq | The field have its value equal the request. |
lt | The field have its value less than the request. |
lte | The field have its value less than or equal to the request. |
gt | The field have its value greater than the request. |
gte | The field have its value greater than or equal to the request. |
not | The field have its value not equals the request. |
Financial API operations
Method | Endpoint | Description |
---|---|---|
GET | /v1/stores/{store_id}/payments | Return a list of payments filtered by store and by payment period with merchant information and details of each payment. |
GET | /v1/stores/{store_id}/orders | Returns a list of orders by payment or by store and a payment period. |
GET | /v1/stores/{store_id}/order_adjusments | Returns a list of order adjustments by payment or by store and a payment period. |
GET | /v1/stores/{store_id}/charged_cancellations | Returns a list of cancellations (orders) and its details by payment or by store and a payment period. |
GET | /v1/stores/{store_id}/store_adjustments | Returns a list of store adjustments by payment or by store and a payment period. |
GET | /v1/stores/{store_id}/loans | Returns a list of loans installments by payment or by store and a payment period. |
GET | /v1/stores/{store_id}/debts | Returns information of outstanding debts from past periods by payment or by store and a payment period. |
GET | /v1/stores/{store_id}/extras | Returns a list of extra charges (fees, discounts, others) by payment or by store and a payment period. |
GET | /v1/stores/{store_id}/taxes | Returns a list of taxes by payment or by store and a payment period. |
GET | /v1/stores/{store_id}/compensations | Returns a list of compensations and its details by payment or by store and a payment period. |
GET | /v1/stores/{store_id}/cancellations | Returns a list of cancellations (orders) by store and a payment period. |
GET | /v1/stores/{store_id}/agreements | Returns information about the contract conditions that underlie the charged amounts for each concept within a payment. |