POST
/
api
/
v1
/
opt-out
curl --request POST \
  --url https://sandbox-b2b.ripio.com/api/v1/opt-out/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf048"
}'
[
  {
    "id": "c56eb572-9435-4643-91aa-337c7058bc86",
    "transaction_id": "da0cbef0-4cb1-40e3-bdd1-65247739a5e5",
    "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf051",
    "opt_in_id": "c56eb572-9435-4643-91aa-337c7058bc86",
    "asset": "BTC",
    "created_at": "2025-04-10T15:57:28.780194Z"
  },
  {
    "id": "c56eb572-9435-4643-91aa-337c7058bc87",
    "transaction_id": "da0cbef0-4cb1-40e3-bdd1-65247739a5e6",
    "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf052",
    "opt_in_id": "c56eb572-9435-4643-91aa-337c7058bc87",
    "asset": "ETH",
    "created_at": "2025-04-10T15:57:28.780195Z"
  }
]

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

Body

application/json · any

The body is of type any.

Response

201
application/json
Successful Creation
​
id
string

UUID used as opt out identifier.

​
transaction_id
string

UUID used as opt out's transaction identifier.

​
end_user_id
string

Unique identifier used as end user's external ref.

​
opt_in_id
string

UUID identifier of the related opt in.

​
asset
string

Asset symbol.

​
created_at
string

ISO format creation datetime

Was this page helpful?