Financial API

Operaciones de la API Financial.

Conciliación de Pagos

GET payments

Devuelve una lista de pagos filtrados por tienda y por período de pago con información del comerciante y detalles de cada pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/payments

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada.
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas
payment_id:eqXEl payment_id debe ser igual a su valor
expected_execution_date:gteXEl expected_execution_date debe ser mayor o igual a su valor
expect_execution_date:lteXEl confirmed_payment_date debe ser menor o igual a su valor
confirmed_payment_date:gteXEl confirmed_payment_date debe ser mayor o igual a su valor
confirmed_payment_date:lteXEl confirmed_payment_date debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/payments

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/payments"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "id": 1000, "status": "string", "period_date_start": "2023-11-07T22:02:47.009Z", "period_date_end": "2023-11-07T22:02:47.009Z", "expected_execution_date": "2023-11-07T22:02:47.009Z", "confirmed_payment_date": "2023-11-07T22:02:47.009Z", "total_amount": 0, "payment_reference": "string", "frequecy_type": "string", "frequecy_type_descripcion": "string", "balance_request_id": "string", "bank_account": { "bank_name": "string", "account_number": "string", "bank_code": "string", "account_type": "string", "ispb": "string", "document": { "identification_type": "string", "identification_number": "string", "holder_name": "string" } }, "consolidated_stores": [1000] } ] }

GET orders

Devuelve una lista de pedidos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/orders

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada.
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas.
order_date:gteXEl order_date debe ser mayor o igual a su valor
order_date:lteXEl order_date debe ser menor o igual a su valor
order_status:eqXEl order_status debe ser igual a su valor
payment_id:eqXEl payment_id debe ser igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/orders

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/orders"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "payment_id": 0, "order_date": "2023-11-07T23:01:44.394Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "is_prime": "string", "items": [ { "name": "string", "units": "string" } ], "amount": 0, "billing": { "total_order": 0, "comission_product": 0, "cofins": 0, "pis": 0, "iss": 0, "income_tax": 0, "compensation": 0, "discount_by_marketplace_in_cash": 0, "total_order_whim": 0, "free_shipping": 0, "other_discounts": 0, "meal_voucher": 0, "marketplace_fee_no_cash": 0, "global_offer_coupon": 0, "paid_by_user": 0, "commission_whim": 0, "rappi_credits_cash_back": 0, "service_fee": 0, "shipping_partner_no_limit": 0, "shipping_partner_limit": 0, "marketplace_charge": 0 } } ] }

GET order_adjusments

Devuelve una lista de ajustes de pedidos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/order_adjusments

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada.
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas
order_date:gteXEl order_date debe ser mayor o igual a su valor
order_date:lteXEl order_date debe ser menor o igual a su valor
order_status:eqXEl order_status debe ser igual a su valor
payment_id:eqXEl payment_id debe ser igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint.:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/order_adjusments

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/order_adjusments"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "payment_id": 0, "order_date": "2023-11-07T23:03:55.722Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "is_prime": "string", "items": [ { "name": "string", "units": "string" } ], "amount": 0, "billing": { "total_order": 0, "comission_product": 0, "cofins": 0, "pis": 0, "iss": 0, "income_tax": 0, "compensation": 0, "discount_by_marketplace_in_cash": 0, "total_order_whim": 0, "free_shipping": 0, "other_discounts": 0, "meal_voucher": 0, "marketplace_fee_no_cash": 0, "global_offer_coupon": 0, "paid_by_user": 0, "commission_whim": 0, "rappi_credits_cash_back": 0, "service_fee": 0, "shipping_partner_no_limit": 0, "shipping_partner_limit": 0, "marketplace_charge": 0 }, "descriptionAdjustment": "string" } ] }

GET charged_cancellations

Devuelve una lista de cancelaciones (pedidos) y su detalle por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/charged_cancellations

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada.
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas
payment_id:eqXEl payment_id debe ser igual a su valor
order_date:gteXEl order_date debe ser mayor o igual a su valor
order_date:lteXEl order_date debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/charged_cancellations

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/charged_cancellations"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta.:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "payment_id": 0, "order_date": "2023-11-07T23:09:48.153Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "is_prime": "string", "items": [ { "name": "string", "units": "string" } ], "amount": 0, "billing": { "total_order": 0, "comission_product": 0, "cofins": 0, "pis": 0, "iss": 0, "income_tax": 0, "compensation": 0, "discount_by_marketplace_in_cash": 0, "total_order_whim": 0, "free_shipping": 0, "other_discounts": 0, "meal_voucher": 0, "marketplace_fee_no_cash": 0, "global_offer_coupon": 0, "paid_by_user": 0, "commission_whim": 0, "rappi_credits_cash_back": 0, "service_fee": 0, "shipping_partner_no_limit": 0, "shipping_partner_limit": 0, "marketplace_charge": 0 }, "cancellatioPercentage": "string", "descriptionCancellation": "string", "cancellation_code": "string", "cancellation_description": "string" } ] }

GET store_adjustments

Devuelve una lista de ajustes de tienda por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/store_adjustments

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada.
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas.
payment_id:eqXEl payment_id debe ser igual a su valor
created_at:gteXEl created_at debe ser mayor o igual a su valor
created_at:lteXEl created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/store_adjustments

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/store_adjustments"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "description": "string", "amount": 0, "created_at": "2023-11-07", "payment_id": 0, "store_id": 0, "description_reason": "string" } ] }

GET loans

Devuelve una lista de cuotas de préstamos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/loans

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas
payment_id:eqXEl payment_id debe ser igual a su valor
created_at:gteXEl created_at debe ser mayor o igual a su valor
created_at:lteXEl created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/loans

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/loans"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "description_type": "string", "balance": 0, "frequency": 0, "created_at": "2023-11-07", "currency": "string", "disbursement_date": "2023-11-07", "disbursement_amount": 0, "deadline": "2023-11-07", "reason": "string", "stores": ["string"], "type": "string", "installment_amount": 0, "installment_percentage": 0, "lastCollection_date": "2023-11-07", "amortization": "string", "installments": { "installment_amount": 0, "installment_created_at": "2023-11-07", "store_id": 0, "payment_id": 0 } } ] }

GET debts

Devuelve información de deudas pendientes de periodos pasados por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/debts

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas
payment_id:eqXThe payment_id debe ser igual a su valor
created_at:gteXThe created_at debe ser mayor o igual a su valor
created_at:lteXThe created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/debts

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/debts"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "description": "string", "payment_debt": 0, "payment_paid": 0, "store_id": "string", "amount": 0, "created_at": "2023-11-07" } ] }

GET extras

Devuelve un listado de cargos extras (tarifas, descuentos, otros) por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/extras

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas
payment_id:eqXThe payment_id debe ser igual a su valor
created_at:gteXThe created_at debe ser mayor o igual a su valor
created_at:lteXThe created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/extras

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/extras"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "reason": "string", "description": "string", "amount": 0, "store_id": 0, "payment_id": 0, "created_at": "2023-11-07" } ] }

GET taxes

Devuelve una lista de impuestos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/taxes

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas
payment_id:eqXEl payment_id debe ser igual a su valor
created_at:gteXEl created_at debe ser mayor o igual a su valor
created_at:lteXEl created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/taxes

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/taxes"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "reason": "string", "description": "string", "amount": 0, "store_id": 0, "payment_id": 0, "created_at": "2023-11-07", "flow_name": "string" } ] }

GET compensations

Devuelve una lista de compensaciones y su detalle por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/compensations

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas
created_at:gteXEl created_at debe ser mayor o igual a su valor
created_at:lteXEl created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/compensations

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/compensations"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "payment_id": 0, "order_date": "2023-11-07", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "amount": 0, "comments": "string", "created_at": "2023-11-07", "order_id": 0, "product_ids": [ { "product_id": 0, "units": "string" } ], "reason": "string" } ] }

GET cancellations

Devuelve una lista de cancelaciones (pedidos) por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/cancellations

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas
cancellation_date:gteXEl cancellation_date debe ser mayor o igual a su valor
cancellation_date:lteXEl cancellation_date debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/cancellations

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/cancellations"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "order_id": 0, "cancellation_date": "2023-11-07T23:35:38.537Z", "order_date": "2023-11-07T23:35:38.537Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "cancellation_code": "string", "cancellation_description": "string", "amount": 0, "is_prime": "string" } ] }

GET agreements

Devuelve información sobre las condiciones del contrato que subyacen a los importes cobrados por cada concepto dentro de un pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/agreements

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuestaJSON
Requisitos de autenticaciónToken

Parámetros

Este endpoint admite los siguientes parámetros:

ParámetroPathQueryDescripción
store_idXEl identificador único de la tienda solicitada
page_numberXNúmero de páginas que desea obtener
page_sizeXEl tamaño máximo de entradas en respuestas paginadas
created_at:gteXEl created_at debe ser mayor o igual a su valor
created_at:lteXEl created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/agreements

este es un ejemplo de la solicitud:

URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/agreements"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("User-Agent", "Mozilla/5.0"); connection.setRequestProperty("Content-Type", "application/json"); connection.setRequestProperty("Accept", "application/json"); connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN"); try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) { StringBuilder response = new StringBuilder(); String responseLine; while ((responseLine = br.readLine()) != null) { response.append(responseLine.trim()); } System.out.println("Response body: " + response.toString()); } System.out.println("Response Code : " + connection.getResponseCode());



Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{ "page_number": 1, "page_size": 10, "order_by": "string", "order_type": "string", "total_pages": 0, "total_entries": 0, "entries": [ { "contracted_plan": "string", "application_fnfo": { "name": "string", "document_number": "string", "corporate_name": "string", "state_registration": "string", "municipal_registration": "string", "address": { "country": "string", "state": "string", "city": "string", "district": "string", "street": "string", "number": "string", "zipCode": "string", "complement": "string", "reference": "string" }, "contact_fnfo": { "contact_email": "user@example.com", "contact_phone": "string", "contact_name": "string" } }, "store_info": { "store_id": "string", "type": "string", "document": "string", "name": "string", "corporate_name": "string", "is_marketplace": true, "address": { "city": "string" } }, "contract_info": { "frequency_type": "string", "contract_term": { "start_date": "2023-11-07", "end_date": "2023-11-07" } }, "conditions": [ { "name": "string", "commision": "string" } ] } ] }