Skip to main content

​
Overview

The Partner integrating with Ripio via API shall be responsible for ensuring that their customers explicitly accept Ripio’s Terms and Conditions (T&C) prior to performing any on-ramp or off-ramp operations.

​
How it works

When T&C acceptance is required, attempting to create an on-ramp or off-ramp session without a prior acceptance will return an error: 
{
  "code": 20039,
  "type": "TermsAndConditionsNotAcceptedException",
  "detail": {
    "message": "Customer '<external_ref> - <email>' has not accepted the current Terms and Conditions."
  },
  "status": 400
}

​
Acceptance Flow

​
1. Get the active Terms and Conditions

Retrieve the current active T&C for your account’s country. This returns a termsId that you’ll need in the next step. 
GET /api/v1/termsAndConditions/
Response example: 
{
  "termsId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "country": "AR",
  "version": "1.0",
  "url": "https://example.com/terms/v1.0"
}
Show the T&C document (via url) to the customer and collect their acceptance.

​
2. Record the customer’s acceptance

Once the customer has accepted, send the acceptance record to the API including the termsId, the customer’s IP address, and optionally their user agent. 
POST /api/v1/customers/{customerId}/acceptTerms/
Request body: 
{
  "termsId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ipAddress": "192.168.1.100",
  "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36"
}
Response example (201 Created): 
{
  "termsId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ipAddress": "192.168.1.100",
  "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
  "acceptedAt": "2024-06-01T12:00:00Z"
}
After a successful acceptance, the customer can proceed with on-ramp and off-ramp operations normally.