Search…
Deposits
To initiate a deposit, create a deposit object via the /deposits endpoint. If you want to create an ACH type deposit, you need to have created at least one transfer method in order to make a deposit.
ENDPOINTS
1
POST /deposits
2
GET /deposits/:id
3
GET /deposits
Copied!

The deposit object

The deposit object represents a request for depositing fiat into the blockchain. You can create or retrieve an identityId's deposits via request to the API. Or, if you manage multiple identities in the network, you can also retrieve a list of deposits for all of them.
Deposits are identified by a unique, random id, and relate to a user's identityId
DEPOSITS OBJECT
1
{
2
"id": "3305af3a-e3c8-4f73-a46b-58c0d6376825",
3
"identityId": "971c3241-9876-471e-b0b3-40040893efd0",
4
"amount": "12",
5
"currency": "USD",
6
"blockchainAddress": "0x359f194ce353b1415abff5fcb07baf59f0bda0de",
7
"transferMethodInformation": {
8
"transferType": "wire"
9
},
10
"status": "pending",
11
"reference": null,
12
"createdAt": "2021-02-17T18:02:50.365Z",
13
"updatedAt": "2021-02-17T18:02:50.365Z"
14
}
Copied!
post
[ENVIRONMENT HOSTNAME]
/deposits
POST /deposits
Note: The transferInformation object needs specific information depending on the kind of deposit you intend to create. In the example bellow, you can find the information necessary to create all the deposit types.

Example Call

Request
Curl
Response
1
POST [ENVIRONMENT HOSTNAME]/deposits
2
3
// BODY for Wire deposits
4
5
{
6
"amount": "11",
7
"currency": "USD",
8
"identityId": "{{identityId}}",
9
"blockchainAddress": "{{identityId}}",
10
"transferInformation": {
11
"transferType": "wire"
12
}
13
}
14
15
// BODY for International Wire deposits
16
17
{
18
"amount": "11",
19
"currency": "USD",
20
"identityId": "{{identityId}}",
21
"blockchainAddress": "{{blockchainAddress}}",
22
"transferInformation": {
23
"transferType": "internationalWire"
24
}
25
}
26
27
// BODY for USDC deposits
28
29
{
30
"amount": "11",
31
"currency": "USD",
32
"identityId": "{{identityId}}",
33
"blockchainAddress": "{{blockchainAddress}}",
34
"transferInformation": {
35
"transferType": "scUsdc"
36
}
37
}
Copied!
1
curl -X POST \
2
[ENVIRONMENT HOSTNAME]/deposits \
3
-H 'Content-Type: application/json' \
4
-H 'apikey: {INSERT API KEY HERE}' \
5
-d '{
6
"amount": "12",
7
"currency": "USD",
8
"identityId": "e65dde2c-4379-42c7-a665-3f476cebb691",
9
"blockchainAddress": "0xA4597E696a55fD76430945e0940DA17c72337ccC",
10
"transferInformation": {
11
"transferType": "wire"
12
}
13
}'
Copied!
1
{
2
"id": "3305af3a-e3c8-4f73-a46b-58c0d6376825",
3
"identityId": "971c3241-9876-471e-b0b3-40040893efd0",
4
"amount": "12",
5
"currency": "USD",
6
"blockchainAddress": "0x359f194ce353b1415abff5fcb07baf59f0bda0de",
7
"transferMethodInformation": {
8
"transferType": "wire"
9
},
10
"status": "waiting",
11
"reference": null,
12
"createdAt": "2021-02-17T18:02:50.365Z",
13
"updatedAt": "2021-02-17T18:02:50.365Z"
14
}
Copied!
On the Sandbox environment, you can use the settle deposit endpoint to simulate and settle the deposit request you created.
On the Sandbox environment, you can use the approve KYC endpoint to simulate and approve the identity you created.
get
[ENVIRONMENT HOSTNAME]
/deposits/:id
GET /deposits/:id

Example Call

Request
Curl
Response
1
GET [ENVIRONMENT HOSTNAME]/deposits/b22d80d9-0e14-4e4f-8101-881dd7138bc5
Copied!
1
curl -X GET \
2
[ENVIRONMENT HOSTNAME]/deposits/7b6bbb41-b0e0-4058-b59e-ea3181f854ec \
Copied!
1
{
2
"id": "3305af3a-e3c8-4f73-a46b-58c0d6376825",
3
"identityId": "971c3241-9876-471e-b0b3-40040893efd0",
4
"amount": "12",
5
"currency": "USD",
6
"blockchainAddress": "0x359f194ce353b1415abff5fcb07baf59f0bda0de",
7
"transferMethodInformation": {
8
"transferType": "wire"
9
},
10
"status": "waiting",
11
"reference": null,
12
"createdAt": "2021-02-17T18:02:50.365Z",
13
"updatedAt": "2021-02-17T18:02:50.365Z"
14
}
Copied!
get
[ENVIRONMENT HOSTNAME]
/deposits
GET /deposits

Example Call

Request
Curl
Response
1
GET [ENVIRONMENT HOSTNAME]/deposits
2
3
// PAGINATED
4
5
GET [ENVIRONMENT HOSTNAME]/deposits?page[number]=1&page[size]=1
Copied!
1
curl -X GET \
2
[ENVIRONMENT HOSTNAME]/deposits/7b6bbb41-b0e0-4058-b59e-ea3181f854ec \
3
-H 'apikey: {INSERT API KEY HERE}'
4
Copied!
1
{
2
"total": 1,
3
"data": [
4
{
5
"id": "3305af3a-e3c8-4f73-a46b-58c0d6376825",
6
"identityId": "971c3241-9876-471e-b0b3-40040893efd0",
7
"amount": "12",
8
"currency": "USD",
9
"blockchainAddress": "0x359f194ce353b1415abff5fcb07baf59f0bda0de",
10
"transferMethodInformation": {
11
"transferType": "wire"
12
},
13
"status": "waiting",
14
"reference": null,
15
"createdAt": "2021-02-17T18:02:50.365Z",
16
"updatedAt": "2021-02-17T18:02:50.365Z"
17
}]
18
}
Copied!