Withdrawals

Create Withdrawal

This endpoint allows the creation of a withdrawal. It will debit from the end user's currency's balance and credit the amount in the destination address.

post/api/v1/withdrawals/

Request

  • Base URL: https://sandbox-b2b.ripio.com
  • URL: https://sandbox-b2b.ripio.com/api/v1/withdrawals/
  • Auth: OAuth 2 (client credentials, token URL https://sandbox-b2b.ripio.com/oauth2/token/)

Request body

end_userstring

End use's external ref

currencystring

Currency of the amount to be withdrwaled

addressstring

Destination address

networkstring

Blockchain network to operate

amountnumber

Amount to withdrawal. Is the amount that the destination address will receive.

external_refstring

An external identifier, usually a unique UUID

withdrawal_fee_idstring

Indicates the withdrawal fee id to use in order to define the applied fees on this withdrawal.

Response

Created

idstring uuid

UUID used as withdrawal identifier.

created_atstring date-time

Indicates the withdrawal request creation date.

confirmation_datestring date-time nullable

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

txn_hashstring hash nullable

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

end_user_idstring

Identifies the user that owns this operation.

currencystring

Indicates the asset name involved in the withdrawal.

amountnumber

Indicates the amount withdrawed.

addressstring

Identifies the destination address.

network_name'BITCOIN' | 'ETHEREUM'
statusstring

Specifies the withdrawal status.

transaction_idstring

The ID of the associated transaction object

provisory_transaction_hashstring nullable

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

risk_scorestring nullable

indicates the risk score of the withdrawal

is_blockedboolean

indicates if the withdrawal was blocked

reasonstring

indicates the block reason if the withdrawal was blocked

external_refstring

Withdrawal external_ref defined in creation request

debited_amountstring

The withdrawal amount plus the withdrawal fee amount

Changes

No recorded changes to this operation across all 1 revision of this API.