Skip to main content
GET
/
api
/
v1
/
deposits
/
{deposit_id}
Retrieve Deposit
curl --request GET \
  --url https://sandbox-b2b.ripio.com/api/v1/deposits/{deposit_id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "fa14c963-1afb-4f0d-af0d-e622e0c50297",
  "hash": "4f87d009d88524e627b60c6fbe4ebe671a99lk9ad72aab17e0963c5fbef118e2",
  "index": 0,
  "amount": "2.29999999",
  "create_date": "2017-10-12T22:40:08.273Z",
  "confirmation_date": "2017-10-12T22:40:08.273Z",
  "update_date": "2017-10-12T22:40:08.273Z",
  "currency_code": "BTC",
  "address_destination": "ajxS9ne12qx9pS9VojpwU5xtRd4T7X7ZUt",
  "address_origin": "BJxS9ne12qx9pS9VojpwU5xtRd4T7X7Z43t",
  "end_user_id": "CUST_2",
  "status": "PENDING",
  "network": "BTC",
  "risk_score": "MEDIUM",
  "is_blocked": false,
  "reason": ""
}

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

​
deposit_id
string
required

Response

200 - application/json

OK

​
hash
string
required

Indicates TXN Hash in the blockchain. This hash is not unique, several outputs may exist on a single transaction. Read index field description.

​
address_origin
string
required
​
create_date
string
required

Indicates the creation date of the deposit in the blockchain.

Minimum string length: 1
​
update_date
string
required

Indicates the creation date of the deposit in the blockchain.

Minimum string length: 1
​
confirmation_date
string | null
required

Indicates the confirmation date of the deposit in the blockchain.

Minimum string length: 1
​
currency_code
string
required

Indicates the currency that has been deposited.

Minimum string length: 1
​
address_destination
string
required

Indicates the deposit's destination address.

​
end_user_id
string
required

Indicates the end user that has received the deposit.

​
amount
string
required

Indicates the amount deposited.

​
id
string

Unique ID for this deposit.

​
index
integer

Indicates the index on the output transaction. This is unique within a hash.

​
network
string

The crypto network

​
status
enum<string>
Available options:
PENDING,
COMPLETED,
ERROR
​
risk_score
enum<string>
Available options:
LOW,
MEDIUM,
HIGH,
SEVERE
​
is_blocked
boolean
default:false

Indicates if the deposit is blocked.

​
reason
string
default:""

If the deposit is blocked this field will contain the reason.