Retrieve Deposit
Endpoint that retrieves details of a received deposit by id.
Note:
We offer the capability to set a Webhook URL in order to be notified in real time. Please note that you should expect a payload format similar to the one below.
Authorizations
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
Response
Indicates TXN Hash in the blockchain. This hash is not unique, several outputs may exist on a single transaction. Read index field description.
Indicates the creation date of the deposit in the blockchain.
1
Indicates the creation date of the deposit in the blockchain.
1
Indicates the confirmation date of the deposit in the blockchain.
1
Indicates the currency that has been deposited.
1
Indicates the deposit's destination address.
Indicates the end user that has received the deposit.
Indicates the amount deposited.
Unique ID for this deposit.
Indicates the index on the output transaction. This is unique within a hash.
The crypto network
PENDING
, COMPLETED
, ERROR
LOW
, MEDIUM
, HIGH
, SEVERE
Indicates if the deposit is blocked.
If the deposit is blocked this field will contain the reason.