Financial API

Financial API operations.

Payment Conciliation

GET payments

Return a list of payments filtered by store and by payment period with merchant information and details of each payment.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
payment_id:eqXThe payment_id must equal its value
expected_execution_date:gteXThe expected_execution_date must be greather than or equal its value
expect_execution_date:lteXThe confirmed_payment_date must be less than or equal its value
confirmed_payment_date:gteXThe confirmed_payment_date must be greather than or equal its value
confirmed_payment_date:lteXThe confirmed_payment_date must be less than or equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



Sample Response

This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "payment_id": 1000, "status": "string", "period_date_start": "2024-02-20T14:54:59.892Z", "period_date_end": "2024-02-20T14:54:59.892Z", "expected_execution_date": "2024-02-20T14:54:59.892Z", "confirmed_payment_date": "2024-02-20T14:54:59.892Z", "total_amount": 0, "payment_reference": "string", "frequecy_type": "string", "frequecy_type_descripcion": "string", "balance_request_id": "string", "bank_account": { "bank_name": "string", "bank_number": "string", "bank_code": "string", "account_type": "string", "ispb": "string", "document": { "type_identification": "string", "number_identification": "string", "holder_name": "string" } }, "stores_consolidated": [1000] } ] }

GET orders

Returns a list of orders by payment or by store and a payment period.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
order_date:gteXThe order_date must be greather than or equal its value
order_date:lteXThe order_date must be less than or equal its value
order_status:eqXThe order_status must equal its value
payment_id:eqXThe payment_id must equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "order_id": 0, "payment_id": 0, "order_date": "2024-02-20T15:11:47.747Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "items": [ { "name": "string", "units": "string" } ], "amount": 0, "billing": { "total_order": 0, "comission_product": 0, "cofins": 0, "piss": 0, "discount_by_market_place_in_cash": 0, "total_order_whim": 0, "shipping_partner_no_limit": 0, "shipping_partner_limit": 0, "marketplace_charge": 0, "commission_whim": 0, "free_shipping": 0, "other_discounts": 0, "meal_vouchers_total": 0, "iss": 0, "market_place_fee_no_cash": 0, "global_offer_coupon": 0, "paid_by_user": 0, "amount_rt_cpg": 0, "income_tax_br": 0, "compensation": 0, "sale_per_product": 0, "commission_per_product": 0, "overpayment_collect": 0, "order_discount_sale_cpg": 0, "order_discount_commission_cpg": 0, "rappi_credits_cashback": 0, "commission_payless": 0, "service_fee": 0, "cargo_service": 0 } } ] }
  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "order_id": 0, "payment_id": 0, "order_date": "2024-02-20T15:12:36.295Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "items": [ { "name": "string", "units": "string" } ], "amount": 0, "billing": { "total_order": 0, "comission_product": 0, "sale_tax": 0, "retention_retefuente": 0, "retention_ica": 0, "retention_retefuente_cc_dc": 0, "retention_ica_cc_dc": 0, "bank_spending": 0, "reteica_cc_dc_without_impoconsumo": 0, "refuente_cc_dc_without_impoconsumo": 0, "compensation": 0, "discount_by_marketplace_in_cash": 0, "total_order_whim": 0, "commission_product_without_impoconsumo": 0, "shipping_partner_no_limit": 0, "shipping_partner_limit": 0, "reteiva": 0, "marketplace_charge": 0, "commission_whim": 0, "commission_whim_without_impoconsumo": 0, "rt_pay": 0, "free_shipping": 0, "other_discounts": 0, "market_place_fee_no_cash": 0, "global_offer_coupon": 0, "paid_by_user": 0, "withhold_taxes_campaign_charges": 0, "amount_rt_cpg": 0, "commission_acquisition": 0, "commission_checkout": 0, "commission_delivery": 0, "commission_pickup": 0, "iva_commission_per_product": 0, "sale_per_product": 0, "commission_per_product": 0, "product_returns": 0, "order_discount_sale_cpg": 0, "order_discount_commission_cpg": 0, "service_fee": 0, "sale_tax_service_fee": 0, "service_fee_retefuente": 0, "cargo_service": 0, "cargo_rt_earning": 0, "sale_tax_cargo": 0, "rete_fuente_cargo": 0 } } ] }

GET order_adjusments

Returns a list of order adjustments by payment or by store and a payment period.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
order_date:gteXThe order_date must be greather than or equal its value
order_date:lteXThe order_date must be less than or equal its value
order_status:eqXThe order_status must equal its value
payment_id:eqXThe payment_id must equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "order_id": 0, "payment_id": 0, "order_date": "2024-02-20T15:21:39.653Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "items": [ { "name": "string", "units": "string" } ], "description_adjustment": "string", "amount": 0, "billing": { "total_order": 0, "comission_product": 0, "sale_tax": 0, "retention_retefuente": 0, "retention_ica": 0, "retention_retefuente_cc_dc": 0, "retention_ica_cc_dc": 0, "bank_spending": 0, "reteica_cc_dc_without_impoconsumo": 0, "refuente_cc_dc_without_impoconsumo": 0, "compensation": 0, "discount_by_marketplace_in_cash": 0, "total_order_whim": 0, "commission_product_without_impoconsumo": 0, "shipping_partner_no_limit": 0, "shipping_partner_limit": 0, "reteiva": 0, "marketplace_charge": 0, "commission_whim": 0, "commission_whim_without_impoconsumo": 0, "rt_pay": 0, "free_shipping": 0, "other_discounts": 0, "market_place_fee_no_cash": 0, "global_offer_coupon": 0, "paid_by_user": 0, "withhold_taxes_campaign_charges": 0, "amount_rt_cpg": 0, "commission_acquisition": 0, "commission_checkout": 0, "commission_delivery": 0, "commission_pickup": 0, "iva_commission_per_product": 0, "sale_per_product": 0, "commission_per_product": 0, "product_returns": 0, "order_discount_sale_cpg": 0, "order_discount_commission_cpg": 0, "service_fee": 0, "sale_tax_service_fee": 0, "service_fee_retefuente": 0, "cargo_service": 0, "cargo_rt_earning": 0, "sale_tax_cargo": 0, "rete_fuente_cargo": 0, "adjustments_order": 0, "adjustments_no_order": 0, "adjustment_commission_modification_order": 0 } } ] }
  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "order_id": 0, "payment_id": 0, "order_date": "2024-02-20T15:21:39.653Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "items": [ { "name": "string", "units": "string" } ], "description_adjustment": "string", "amount": 0, "billing": { "total_order": 0, "comission_product": 0, "sale_tax": 0, "retention_retefuente": 0, "retention_ica": 0, "retention_retefuente_cc_dc": 0, "retention_ica_cc_dc": 0, "bank_spending": 0, "reteica_cc_dc_without_impoconsumo": 0, "refuente_cc_dc_without_impoconsumo": 0, "compensation": 0, "discount_by_marketplace_in_cash": 0, "total_order_whim": 0, "commission_product_without_impoconsumo": 0, "shipping_partner_no_limit": 0, "shipping_partner_limit": 0, "reteiva": 0, "marketplace_charge": 0, "commission_whim": 0, "commission_whim_without_impoconsumo": 0, "rt_pay": 0, "free_shipping": 0, "other_discounts": 0, "market_place_fee_no_cash": 0, "global_offer_coupon": 0, "paid_by_user": 0, "withhold_taxes_campaign_charges": 0, "amount_rt_cpg": 0, "commission_acquisition": 0, "commission_checkout": 0, "commission_delivery": 0, "commission_pickup": 0, "iva_commission_per_product": 0, "sale_per_product": 0, "commission_per_product": 0, "product_returns": 0, "order_discount_sale_cpg": 0, "order_discount_commission_cpg": 0, "service_fee": 0, "sale_tax_service_fee": 0, "service_fee_retefuente": 0, "cargo_service": 0, "cargo_rt_earning": 0, "sale_tax_cargo": 0, "rete_fuente_cargo": 0, "adjustments_order": 0, "adjustments_no_order": 0, "adjustment_commission_modification_order": 0 } } ] }

GET charged_cancellations

Returns a list of cancellations (orders) and its details by payment or by store and a payment period.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
payment_id:eqXThe payment_id must equal its value
order_date:gteXThe order_date must be greather than or equal its value
order_date:lteXThe order_date must be less than or equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "order_id": 0, "payment_id": 0, "order_date": "2024-02-20T15:27:46.754Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "items": [ { "name": "string", "units": "string" } ], "cancellatioPercentage": "string", "descriptionCancellation": "string", "cancellation_code": "string", "cancellation_description": "string", "amount": 0, "billing": { "total_order": 0, "comission_product": 0, "cofins": 0, "piss": 0, "discount_by_market_place_in_cash": 0, "total_order_whim": 0, "shipping_partner_no_limit": 0, "shipping_partner_limit": 0, "marketplace_charge": 0, "commission_whim": 0, "free_shipping": 0, "other_discounts": 0, "meal_vouchers_total": 0, "iss": 0, "market_place_fee_no_cash": 0, "global_offer_coupon": 0, "paid_by_user": 0, "amount_rt_cpg": 0, "income_tax_br": 0, "compensation": 0, "sale_per_product": 0, "commission_per_product": 0, "overpayment_collect": 0, "order_discount_sale_cpg": 0, "order_discount_commission_cpg": 0, "rappi_credits_cashback": 0, "commission_payless": 0, "service_fee": 0, "cargo_service": 0 } } ] }
  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "order_id": 0, "payment_id": 0, "order_date": "2024-02-20T15:28:01.926Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "items": [ { "name": "string", "units": "string" } ], "cancellatioPercentage": "string", "descriptionCancellation": "string", "cancellation_code": "string", "cancellation_description": "string", "amount": 0, "billing": { "total_order": 0, "comission_product": 0, "sale_tax": 0, "retention_retefuente": 0, "retention_ica": 0, "retention_retefuente_cc_dc": 0, "retention_ica_cc_dc": 0, "bank_spending": 0, "reteica_cc_dc_without_impoconsumo": 0, "refuente_cc_dc_without_impoconsumo": 0, "compensation": 0, "discount_by_marketplace_in_cash": 0, "total_order_whim": 0, "commission_product_without_impoconsumo": 0, "shipping_partner_no_limit": 0, "shipping_partner_limit": 0, "reteiva": 0, "marketplace_charge": 0, "commission_whim": 0, "commission_whim_without_impoconsumo": 0, "rt_pay": 0, "free_shipping": 0, "other_discounts": 0, "market_place_fee_no_cash": 0, "global_offer_coupon": 0, "paid_by_user": 0, "withhold_taxes_campaign_charges": 0, "amount_rt_cpg": 0, "commission_acquisition": 0, "commission_checkout": 0, "commission_delivery": 0, "commission_pickup": 0, "iva_commission_per_product": 0, "sale_per_product": 0, "commission_per_product": 0, "product_returns": 0, "order_discount_sale_cpg": 0, "order_discount_commission_cpg": 0, "service_fee": 0, "sale_tax_service_fee": 0, "service_fee_retefuente": 0, "cargo_service": 0, "cargo_rt_earning": 0, "sale_tax_cargo": 0, "rete_fuente_cargo": 0, "cancellation_percentage": 0 } } ] }

GET store_adjustments

Returns a list of store adjustments by payment or by store and a payment period.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
payment_id:eqXThe payment_id must equal its value
created_at:gteXThe created_at must be greather than or equal its value
created_at:lteXThe created_at must be less than or equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



Sample Response

This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "description": "string", "amount": 0, "created_at": "2024-02-20", "payment_id": 0, "store_id": 0, "description_reason": "string" } ] }

GET loans

Returns a list of loans installments by payment or by store and a payment period.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
payment_id:eqXThe payment_id must equal its value
created_at:gteXThe created_at must be greather than or equal its value
created_at:lteXThe created_at must be less than or equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



Sample Response

This is an example of the response:

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

GET debts

Returns information of outstanding debts from past periods by payment or by store and a payment period.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
payment_id:eqXThe payment_id must equal its value
created_at:gteXThe created_at must be greather than or equal its value
created_at:lteXThe created_at must be less than or equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



Sample Response

This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "description": "string", "payment_debt": 0, "payment_paid": 0, "store_id": "string", "amount": 0, "created_at": "2024-02-20" } ] }

GET extras

Returns a list of extra charges (fees, discounts, others) by payment or by store and a payment period.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
payment_id:eqXThe payment_id must equal its value
created_at:gteXThe created_at must be greather than or equal its value
created_at:lteXThe created_at must be less than or equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



Sample Response

This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "reason": "string", "description": "string", "amount": 0, "store_id": 0, "payment_id": 0, "created_at": "2024-02-20" } ] }

GET taxes

Returns a list of taxes by payment or by store and a payment period.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
payment_id:eqXThe payment_id must equal its value
created_at:gteXThe created_at must be greather than or equal its value
created_at:lteXThe created_at must be less than or equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



Sample Response

This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "reason": "string", "description": "string", "amount": 0, "store_id": 0, "payment_id": 0, "created_at": "2024-02-20" } ] }

GET compensations

Returns a list of compensations and its details by payment or by store and a payment period.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
created_at:gteXThe created_at must be greather than or equal its value
created_at:lteXThe created_at must be less than or equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



Sample Response

This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "id": 0, "payment_id": 0, "order_date": "2024-02-20", "store_id": 0, "amount": 0, "comments": "string", "created_at": "2024-02-20", "order_id": 0, "product_ids": [0], "product_names": ["string"], "reason": "string", "user_details": "string", "amount_order": 0, "broken_package": true } ] }

GET cancellations

Returns a list of cancellations (orders) by store and a payment period.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
cancellation_date:gteXThe cancellation_date must be greather than or equal its value
cancellation_date:lteXThe cancellation_date must be less than or equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



Sample Response

This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "order_id": 0, "cancellation_date": "2024-02-20T16:17:21.346Z", "order_date": "2024-02-20T16:17:21.346Z", "store_id": 0, "store_name": "string", "store_type": "string", "order_status": "string", "payment_method": "string", "cancellation_code": "string", "cancellation_description": "string", "amount": 0, "cancellation_reason": "string", "who_canceled": "string" } ] }

GET agreements

Returns information about the contract conditions that underlie the charged amounts for each concept within a payment.

Endpoint URL

Use this URL to make a request with this endpoint:

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

{COUNTRY_DOMAIN}: This is your Rappi Country Domain. See the list of Country Domains.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

Parameters

This endpoint admits the following parameters:

ParameterPathQueryDescription
store_idXThe unique identifier of store in request
page_numberXNumber of pages that you want to get
page_sizeXThe maximum size of entries in paginated responses
created_at:gteXThe created_at must be greather than or equal its value
created_at:lteXThe created_at must be less than or equal its value

Status Codes

These are the possible status codes of the response for this endpoint:

Sample Request

This is an example of an API request using this endpoint:

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

Get a different request example depending on the country or language selected:

  • Brazil
URL url = new URL("https://api.rappi.com.br/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());



  • Colombia
URL url = new URL("https://api.rappi.com.co/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());



Sample Response

This is an example of the response:

{ "page_number": 1, "page_size": 10, "total_pages": 0, "total_entries": 0, "entries": [ { "contracted_plan": "string", "application_fnfo": { "store_id": "string", "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_info": { "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": "2024-02-20", "end_date": "2024-02-20" } }, "conditions": [ { "name": "string", "value": "string" } ] } ] }