Get deposits

get https://api.cert.zerohash.com/deposits

Retrieves a list of deposits made by you and your customers. Results are limited to the last 2 months.

Note: The include_customer_deposits field will default to true unless a participant_code is provided, in which case the results for the provided participant_code will supercede and be returned.

Query Params

page

string

Filters for a specific page (pagination)

asset

string

Filters for deposits made with a specific asset

include_customer_deposits

boolean

Filters for customer deposits, defaults to true

participant_code

string

Filters for deposits made by a specific participant_code
Note: the participant_code parameter cannot be used simultaneously with the include_customer_deposits parameter

account_label

string

Filters for deposits made into an account with a specific account label

settle_timestamp[gt]

number

Filters for deposits made into an account where the settle timestamp is greater than the provided value in milliseconds

Headers

X-SCX-SIGNED

string

Defaults to [WEB] auto-generated on fly

Signature for your request.

X-SCX-TIMESTAMP

string

Defaults to [WEB] auto-generated on fly

UNIX timestamp.

Responses

Response body

object

message

array of objects

message

object

settle_timestamp

number

The timestamp for when the deposit was credited to the participant - this is also the movement_timestamp

account_id

string

Unique ID of the specific account

movement_id

string

A unique ID for the specific account update

participant_code

string

The participant that was credited with the deposit, e.g. ABCDEF

account_group

string

The account group associated with the account_id that received the deposit, e.g. 00SCXM for the Seed Digital Commodities Market account group

account_label

string

The account label associated with the account

asset

string

The asset code for the request, e.g. BTC

amount

string

The amount that was deposited into the account

reference_id

string

This is an external identifier associated with the deposit, which is context-specific depending on the asset type and deposit source - wire, transfer or on-chain transaction ID

source

string

The bank into which the fiat deposit was made or the blockchain address from which the crypto deposit came

received_address

string

The address where funds were received

run_id

string

A unique ID for the particular run

page

number

page_size

number

total_pages

number

count

number

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.cert.zerohash.com/deposits \
3
     --header 'X-SCX-SIGNED: [WEB] auto-generated on fly' \
4
     --header 'X-SCX-TIMESTAMP: [WEB] auto-generated on fly' \
5
     --header 'accept: application/json'


xxxxxxxxxx
22
 
1
{
2
  "message": [
3
    {
4
      "settle_timestamp": 1590663417000,
5
      "account_id": "80289ce5-072b-4739-929d-dcc5ccc542f3",
6
      "movement_id": "21bdbb11-712f-4cb7-a178-4f277c80cde0",
7
      "participant_code": "ABC123",
8
      "account_group": "00SCXM",
9
      "account_label": "general",
10
      "asset": "BTC",
11
      "amount": "4.0000",
12
      "reference_id": "408482348dcb0e0331a9148d50f8c76db08138f63fb1586fcfc45200a91ccc5f",
13
      "source": "0x73dFE6E1696FB1cf4648B954aB608a593a382B8G",
14
      "received_address": "0xB38CeBE03b2b6705744795F36921DE27c70A7C62",
15
      "run_id": "12613"
16
    }
17
  ],
18
  "page": 1,
19
  "page_size": 15,
20
  "total_pages": 1,
21
  "count": 1
22
}

200

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable