Skip to main content
GET
/
api
/
v1
/
yield-credits
/
{yield_credit_id}
Retrieve Yield Credit
curl --request GET \
  --url https://sandbox-b2b.ripio.com/api/v1/yield-credits/{yield_credit_id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "c468be09-3a1f-41aa-ad08-c7d715957105",
  "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb0e",
  "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf051",
  "opt_in_id": "c56eb572-9435-4643-91aa-337c7058bc86",
  "asset": "ETH",
  "amount": 0.00001,
  "accrued_date": "2025-04-10T15:53:11.847992Z"
}

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

Path Parameters

​
yield_credit_id
string
required

Response

Successful Response

​
id
string<uuid>

UUID used as yield credit identifier.

​
transaction_id
string<uuid>

UUID used as yield credit's transaction identifier.

​
end_user_id
string<uuid>

Unique identifier used as end user's external ref.

​
opt_in_id
string<uuid>

UUID identifier of the related opt in.

​
asset
string

Asset symbol.

​
amount
number<decimal>

Yield credit amount.

​
created_at
string<date-time>

ISO format created datetime

​
accrued_date
string<date>

ISO format accrued date