GET
/
api
/
v1
/
opt-in
curl --request GET \
  --url https://sandbox-b2b.ripio.com/api/v1/opt-in/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "c468be09-3a1f-41aa-ad08-c7d715957105",
      "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb0e",
      "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf051",
      "asset": "ETH",
      "created_at": "2025-04-10T15:53:11.847992Z",
      "opt_out_at": null,
      "is_active": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow:

  • clientCredentials allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication.

Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (client id and client secret) that will be needed to generate a credential in order to negotiate an ephemeral access token.

Every request must be accompianed by an Authorization header with a value that follows the following schema: Bearer ACCESS_TOKEN

Query Parameters

​
end_user_id
string

Filter opt ins by end_user_id.

​
asset
string

Filter opt ins by asset symbol.

​
is_active
string

Filter opt ins by is_active status.

​
create_date_lte
string

Filter opt ins by create_date less than or equal to this date.

​
create_date_gte
string

Filter opt ins by create_date greater than or equal to this date.

Response

200 - application/json
Successful Response
​
count
integer

Indicates total count of opt ins.

Example:

1

​
next
string | null

Indicates next page by URL.

Example:

null

​
previous
string | null

Indicates previous page by URL.

Example:

null

​
results
object[]

List of fetched opt ins.

Was this page helpful?