Skip to main content
GET
List Deposits

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

FlowClient Credentials
Token URL
https://sandbox-b2b.ripio.com/oauth2/token/

Query Parameters

create_date_lte
string

Filter deposits by create_date less than or equal to this date.

create_date_gte
string

Filter deposits by create_date greater than or equal to this date.

confirmation_date_lte
string

Filter deposits by confirmation_date less than or equal to this date.

confirmation_date_gte
string

Filter deposits by confirmation_date greater than or equal to this date.

end_user_id
string

End User that has received deposits.

currency_code_in
string[]

Currency codes that has been deposited.

page
integer

Page number to return. Starts at 1.

update_date_lte
string

Filter deposits by update_date less than or equal to this date.

update_date_gte
string

Filter deposits by update_date greater than or equal to this date.

ordering
enum<string>

Sort order. Prefix a field with - for descending order. Results with the same value keep their creation order, in the same direction. Defaults to creation order, oldest first. Combine ordering=updated_at with update_date_gte/update_date_lte to poll status changes within a time window.

Available options:
created_at,
-created_at,
updated_at,
-updated_at
page_size
integer
default:20

Number of deposits to return per page. Defaults to 20, up to 100; larger values return 100.

Required range: x <= 100

Response

200 - application/json
count
integer

Indicates total count of deposits.

Example:

123

next
string<uri> | null

Indicates next page by URL.

Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null

Indicates previous page by URL.

Example:

"http://api.example.org/accounts/?page=2"

results
object[]

List of fetched deposits.