Skip to main content
GET
Retrieve Withdrawal

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/

Path Parameters

withdrawal_id
string
required

Response

200 - application/json

Successful Response

id
string<uuid>

UUID used as withdrawal identifier.

created_at
string<date-time>

Indicates the withdrawal request creation date.

update_date
string<date-time>

Indicates the last time the withdrawal was updated, for example when it moves from PENDING to COMPLETED or when the blockchain hash is set. Alias of updated_at, kept for consistency with the deposits response.

updated_at
string<date-time>

Indicates the last time the withdrawal was updated. Same value as update_date.

confirmation_date
string<date-time> | null

Identifies the withdrawal confirmation date. This field will be null if the withdrawal is still pending.

txn_hash
string<hash> | null

Indicates the hash of the blockchain transaction, once completed. This field will be null if the withdrawal is still pending.

end_user_id
string

Identifies the user that owns this operation.

currency
string

Indicates the asset name involved in the withdrawal.

amount
number<decimal>

Indicates the amount withdrawed.

address
string

Identifies the destination address.

Maximum string length: 128
network_name
enum<string>
Available options:
BITCOIN,
ETHEREUM
status
enum<string>

Specifies the withdrawal status. Possible values: COMPLETED (successfully completed), PENDING (being processed), ERROR (failed due to external error), CANCELLED (cancelled due to internal reason), BLOCKED_LIMIT_EXCEEDED (blocked due to exceeding withdrawal limits).

Available options:
COMPLETED,
PENDING,
ERROR,
CANCELLED,
BLOCKED_LIMIT_EXCEEDED
transaction_id
string

The ID of the associated transaction object

provisory_txn_hash
string | null

Indicates the provisory hash of the blockchain transaction, could be different to txn_hash

risk_score
string | null

indicates the risk score of the withdrawal

is_blocked
boolean

indicates if the withdrawal was blocked

reason
string

indicates the block reason if the withdrawal was blocked

external_ref
string

Withdrawal external_ref defined in creation request

memo
string | null

Destination tag or memo the withdrawal was sent with. Only networks that use one, such as XRP or Stellar, carry a value here; it is null on every other network.

debited_amount
string

The withdrawal amount plus the withdrawal fee amount