Getting Started

To start using the Rappi API you must sing up as a Rappi ally.

After signing up as a Rappy ally, you receive your Rappi credentials that consist of the following:

  • client_id
  • client_secret
  • audience
  • grant_type

Use these Rappi Credentials to create your Access Token with the POST token.

After generating your Access Token, you can start using the Rappi API.

Sample Request

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


this is an example of the request:

URL url = new URL(""); 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] } ] }