Financial API operations.

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
expected_execution_date:gte		X	The expected_execution_date must be greather than or equal its value
expect_execution_date:lte		X	The confirmed_payment_date must be less than or equal its value
confirmed_payment_date:gte		X	The confirmed_payment_date must be greather than or equal its value
confirmed_payment_date:lte		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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]
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
order_date:gte		X	The order_date must be greather than or equal its value
order_date:lte		X	The order_date must be less than or equal its value
order_status:eq		X	The order_status must equal its value
payment_id:eq		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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
      }
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
order_date:gte		X	The order_date must be greather than or equal its value
order_date:lte		X	The order_date must be less than or equal its value
order_status:eq		X	The order_status must equal its value
payment_id:eq		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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"
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
order_date:gte		X	The order_date must be greather than or equal its value
order_date:lte		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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"
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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"
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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
      }
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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"
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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"
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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"
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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"
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
cancellation_date:gte		X	The cancellation_date must be greather than or equal its value
cancellation_date:lte		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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"
    }
  ]
}

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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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

this is an example of the request:

javanodepythongo
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());

Sample Response

This is an example of the response:

{
  "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"
        }
      ]
    }
  ]
}

The v2 endpoints share the same parameters, status codes, and response structure as v1. The key difference is that authentication is handled through multi-store credentials, enabling consolidated financial queries.

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
expected_execution_date:gte		X	The expected_execution_date must be greather than or equal its value
expect_execution_date:lte		X	The confirmed_payment_date must be less than or equal its value
confirmed_payment_date:gte		X	The confirmed_payment_date must be greather than or equal its value
confirmed_payment_date:lte		X	The 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/v2/stores/1234/payments

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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,
  "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]
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique payment identifier
status	string	Payment status
period_date_start	datetime	Payment period start date
period_date_end	datetime	Payment period end date
expected_execution_date	datetime	Expected payment execution date
confirmed_payment_date	datetime	Confirmed payment date
total_amount	number	Total payment amount
payment_reference	string	Payment reference
frequecy_type	string	Payment frequency type
frequecy_type_descripcion	string	Frequency type description
balance_request_id	string	Balance request ID
bank_account	object	Bank account information
bank_account.bank_name	string	Bank name
bank_account.account_number	string	Account number
bank_account.bank_code	string	Bank code
bank_account.account_type	string	Account type
bank_account.ispb	string	ISPB code (Brazil)
bank_account.document.identification_type	string	Identification document type
bank_account.document.identification_number	string	Document number
bank_account.document.holder_name	string	Account holder name
consolidated_stores	array	List of stores consolidated in the payment

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
order_date:gte		X	The order_date must be greather than or equal its value
order_date:lte		X	The order_date must be less than or equal its value
order_status:eq		X	The order_status must equal its value
payment_id:eq		X	The 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/v2/stores/1234/orders

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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());

Sample Response

This is an example of the response:

{
  "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
      }
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique order identifier
payment_id	integer	Associated payment ID
order_date	datetime	Order date
store_id	integer	Store ID
store_name	string	Store name
store_type	string	Store type
order_status	string	Order status
payment_method	string	Payment method used
is_prime	string	Indicates if the order is from a Prime user
items	array	List of order products
items[].name	string	Product name
items[].units	string	Number of units
amount	number	Order amount
billing.total_order	number	Order total
billing.comission_product	number	Product commission
billing.cofins	number	COFINS tax (Brazil)
billing.pis	number	PIS tax (Brazil)
billing.iss	number	ISS tax (Brazil)
billing.income_tax	number	Income tax
billing.compensation	number	Applied compensation
billing.discount_by_marketplace_in_cash	number	Marketplace discount in cash
billing.total_order_whim	number	Whim order total
billing.free_shipping	number	Free shipping applied
billing.other_discounts	number	Other discounts
billing.meal_voucher	number	Meal voucher
billing.marketplace_fee_no_cash	number	Marketplace fee (non-cash)
billing.global_offer_coupon	number	Global offer coupon
billing.paid_by_user	number	Amount paid by user
billing.commission_whim	number	Whim commission
billing.rappi_credits_cash_back	number	Rappi credits cashback
billing.service_fee	number	Service fee
billing.shipping_partner_no_limit	number	Partner shipping without limit
billing.shipping_partner_limit	number	Partner shipping with limit
billing.marketplace_charge	number	Marketplace charge

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
order_date:gte		X	The order_date must be greather than or equal its value
order_date:lte		X	The order_date must be less than or equal its value
order_status:eq		X	The order_status must equal its value
payment_id:eq		X	The 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/v2/stores/1234/order_adjusments

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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());

Sample Response

This is an example of the response:

{
  "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"
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique order identifier
payment_id	integer	Associated payment ID
order_date	datetime	Order date
store_id	integer	Store ID
store_name	string	Store name
store_type	string	Store type
order_status	string	Order status
payment_method	string	Payment method used
is_prime	string	Indicates if the order is from a Prime user
items	array	List of order products
items[].name	string	Product name
items[].units	string	Number of units
amount	number	Order amount
billing.total_order	number	Order total
billing.comission_product	number	Product commission
billing.cofins	number	COFINS tax (Brazil)
billing.pis	number	PIS tax (Brazil)
billing.iss	number	ISS tax (Brazil)
billing.income_tax	number	Income tax
billing.compensation	number	Applied compensation
billing.discount_by_marketplace_in_cash	number	Marketplace discount in cash
billing.total_order_whim	number	Whim order total
billing.free_shipping	number	Free shipping applied
billing.other_discounts	number	Other discounts
billing.meal_voucher	number	Meal voucher
billing.marketplace_fee_no_cash	number	Marketplace fee (non-cash)
billing.global_offer_coupon	number	Global offer coupon
billing.paid_by_user	number	Amount paid by user
billing.commission_whim	number	Whim commission
billing.rappi_credits_cash_back	number	Rappi credits cashback
billing.service_fee	number	Service fee
billing.shipping_partner_no_limit	number	Partner shipping without limit
billing.shipping_partner_limit	number	Partner shipping with limit
billing.marketplace_charge	number	Marketplace charge
descriptionAdjustment	string	Description of the adjustment applied to the order

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
order_date:gte		X	The order_date must be greather than or equal its value
order_date:lte		X	The 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/v2/stores/1234/charged_cancellations

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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());

Sample Response

This is an example of the response:

{
  "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"
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique order identifier
payment_id	integer	Associated payment ID
order_date	datetime	Order date
store_id	integer	Store ID
store_name	string	Store name
store_type	string	Store type
order_status	string	Order status
payment_method	string	Payment method used
is_prime	string	Indicates if the order is from a Prime user
items	array	List of order products
items[].name	string	Product name
items[].units	string	Number of units
amount	number	Order amount
billing.total_order	number	Order total
billing.comission_product	number	Product commission
billing.cofins	number	COFINS tax (Brazil)
billing.pis	number	PIS tax (Brazil)
billing.iss	number	ISS tax (Brazil)
billing.income_tax	number	Income tax
billing.compensation	number	Applied compensation
billing.discount_by_marketplace_in_cash	number	Marketplace discount in cash
billing.total_order_whim	number	Whim order total
billing.free_shipping	number	Free shipping applied
billing.other_discounts	number	Other discounts
billing.meal_voucher	number	Meal voucher
billing.marketplace_fee_no_cash	number	Marketplace fee (non-cash)
billing.global_offer_coupon	number	Global offer coupon
billing.paid_by_user	number	Amount paid by user
billing.commission_whim	number	Whim commission
billing.rappi_credits_cash_back	number	Rappi credits cashback
billing.service_fee	number	Service fee
billing.shipping_partner_no_limit	number	Partner shipping without limit
billing.shipping_partner_limit	number	Partner shipping with limit
billing.marketplace_charge	number	Marketplace charge
cancellatioPercentage	string	Cancellation percentage charged
descriptionCancellation	string	Cancellation description
cancellation_code	string	Cancellation code
cancellation_description	string	Cancellation code description

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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/v2/stores/1234/store_adjustments

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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,
  "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"
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique adjustment identifier
description	string	Adjustment description
amount	number	Adjustment amount
created_at	date	Creation date
payment_id	integer	Associated payment ID
store_id	integer	Store ID
description_reason	string	Adjustment reason

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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/v2/stores/1234/loans

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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,
  "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
      }
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique loan identifier
description_type	string	Loan type
balance	number	Outstanding balance
frequency	integer	Collection frequency
created_at	date	Creation date
currency	string	Currency
disbursement_date	date	Disbursement date
disbursement_amount	number	Disbursed amount
deadline	date	Payment deadline
reason	string	Loan reason
stores	array	Stores associated with the loan
type	string	Type
installment_amount	number	Installment amount
installment_percentage	number	Installment percentage
lastCollection_date	date	Last collection date
amortization	string	Amortization type
installments.installment_amount	number	Each installment amount
installments.installment_created_at	date	Installment creation date
installments.store_id	integer	Installment store ID
installments.payment_id	integer	Installment payment ID

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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/v2/stores/1234/debts

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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,
  "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"
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique debt identifier
description	string	Debt description
payment_debt	number	Debt amount
payment_paid	number	Amount paid on debt
store_id	string	Store ID
amount	number	Total amount
created_at	date	Creation date

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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/v2/stores/1234/extras

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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,
  "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"
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique extra charge identifier
reason	string	Charge reason
description	string	Charge description
amount	number	Charge amount
store_id	integer	Store ID
payment_id	integer	Associated payment ID
created_at	date	Creation date

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
payment_id:eq		X	The payment_id must equal its value
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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/v2/stores/1234/taxes

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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,
  "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"
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique tax identifier
reason	string	Tax reason
description	string	Tax description
amount	number	Tax amount
store_id	integer	Store ID
payment_id	integer	Associated payment ID
created_at	date	Creation date
flow_name	string	Fiscal flow/concept name

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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/v2/stores/1234/compensations

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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,
  "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"
    }
  ]
}

Response Fields

Field	Type	Description
id	integer	Unique compensation identifier
payment_id	integer	Associated payment ID
order_date	date	Order date
store_id	integer	Store ID
store_name	string	Store name
store_type	string	Store type
order_status	string	Order status
amount	number	Compensation amount
comments	string	Comments
created_at	date	Creation date
order_id	integer	Associated order ID
product_ids[].product_id	integer	Product ID
product_ids[].units	string	Product units
reason	string	Compensation reason

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
cancellation_date:gte		X	The cancellation_date must be greather than or equal its value
cancellation_date:lte		X	The 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/v2/stores/1234/cancellations

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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,
  "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"
    }
  ]
}

Response Fields

Field	Type	Description
order_id	integer	Cancelled order ID
cancellation_date	datetime	Cancellation date
order_date	datetime	Original order date
store_id	integer	Store ID
store_name	string	Store name
store_type	string	Store type
order_status	string	Order status
payment_method	string	Payment method
cancellation_code	string	Cancellation code
cancellation_description	string	Cancellation description
amount	number	Cancellation amount
is_prime	string	If the order was from a Prime user

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/v2/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 formats	JSON
Authentication requirements	Token

Parameters

This endpoint admits the following parameters:

Parameter	Path	Query	Description
store_id	X		The unique identifier of store in request
page_number		X	Number of pages that you want to get
page_size		X	The maximum size of entries in paginated responses
created_at:gte		X	The created_at must be greather than or equal its value
created_at:lte		X	The 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/v2/stores/1234/agreements

this is an example of the request:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/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,
  "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"
        }
      ]
    }
  ]
}

Response Fields

Field	Type	Description
contracted_plan	string	Contracted plan
application_fnfo.name	string	Applicant name
application_fnfo.document_number	string	Document number
application_fnfo.corporate_name	string	Corporate name
application_fnfo.state_registration	string	State registration
application_fnfo.municipal_registration	string	Municipal registration
application_fnfo.address.country	string	Country
application_fnfo.address.state	string	State/Department
application_fnfo.address.city	string	City
application_fnfo.address.district	string	District
application_fnfo.address.street	string	Street
application_fnfo.address.number	string	Number
application_fnfo.address.zipCode	string	Zip code
application_fnfo.address.complement	string	Address complement
application_fnfo.address.reference	string	Reference
application_fnfo.contact_fnfo.contact_email	string	Contact email
application_fnfo.contact_fnfo.contact_phone	string	Contact phone
application_fnfo.contact_fnfo.contact_name	string	Contact name
store_info.store_id	string	Store ID
store_info.type	string	Store type
store_info.document	string	Store document
store_info.name	string	Store name
store_info.corporate_name	string	Store corporate name
store_info.is_marketplace	boolean	If it is marketplace
store_info.address.city	string	Store city
contract_info.frequency_type	string	Payment frequency type
contract_info.contract_term.start_date	date	Contract start date
contract_info.contract_term.end_date	date	Contract end date
conditions[].name	string	Condition name
conditions[].commision	string	Commission percentage