Transfers

Transfers

GET /transfers

const getTransfers = () => {
  const timestamp = Math.round(Date.now() / 1000)
  const payload = timestamp + 'GET' + '/transfers' + '{}'
  const decodedSecret = Buffer.from(apiSecret, 'base64')
  const hmac = crypto.createHmac('sha256', decodedSecret)
  const signedPayload = hmac.update(payload).digest('base64')

  // SET HEADERS
  const headers = {
    'X-NDAX-API-KEY': 'public_key',
    'X-NDAX-SIGNED': signedPayload,
    'X-NDAX-TIMESTAMP': timestamp,
    'X-NDAX-PASSPHRASE': 'passphrase'
  }
  const options = {
    headers,
    body,
    json: true
  }

  return request.get('https://api.ndax.in/transfers', options)
}

Sample Response

{
  "message": [
    {
      "id": 39,
      "client_transfer_id" : "5fed7a1d-1cd3-4be7-9d63-dd67805d441d",
      "created_at": "2020-09-01T20:53:31.653Z",
      "updated_at": "2020-09-01T20:53:31.653Z",
      "status": "settled",
      "from_participant_code": "ABC123",
      "from_account_group": "UNALLOCATED",
      "from_account_label": "general",
      "to_participant_code": "DEMO01",
      "to_account_group": null,
      "to_account_label": "general",
      "asset": "BTC",
      "amount": "20.00",
      "movement_id": "1902a0eb-a925-4d08-bcad-ea8ed4696a24",
      "admin_transfer": true
    },
    {
      "id": 38,
      "client_transfer_id": null,
      "created_at": "2020-09-01T20:53:31.406Z",
      "updated_at": "2020-09-01T20:53:31.406Z",
      "status": "approved",
      "from_participant_code": "ABC123",
      "from_account_group": "UNALLOCATED",
      "from_account_label": "general",
      "to_participant_code": "ABC123",
      "to_account_group": "XYZ456",
      "to_account_label": "general",
      "asset": "e₹",
      "amount": "100.00",
      "movement_id": null,
      "admin_transfer": false
    }
  ],
  "page": 1,
  "total_pages": 1
}

Returns an array of all transfers requests made to or from your participant, or to or from your platform's account group.

Response:

Parameter	Description	Type
id	The transfer request ID	number
client_transfer_id	Optional unique identifier for the transfer. Note: this must be unique, per platform, per 72 hour period	string
created_at	The timestamp when the transfer request was requested	timestamp
updated_at	The timestamp when the transfer request was last updated	timestamp
status	The current status of the transfer request	string
from_participant_code	The source participant for the transfer to, e.g. ABCDEF	string
from_account_group	The source account group for the transfer, e.g. ABCDEF Note: this may be null if the requesting participant is not authorized to see the source account group	string
from_account_label	The source account label for the transfer, e.g. general	string
to_participant_code	The destination participant for the transfer, e.g. ABCDEF	string
to_account_group	The destination account group for the transfer, e.g. ABCDEF Note: this may be null if the requesting participant is not authorized to see the destination account group	string
to_account_label	The destination account label for the transfer, e.g. general	string
asset	The asset code for the request, e.g. e₹	string
amount	The amount or quantity transferred, e.g. 100	string
movement_id	A unique ID for the specific account update Note: this will be null until the transfer updates to settled	string

Transfer Request Status

Status	Description
pending	The request has been created and is pending approval from users
approved	The request is approved but not settled
canceled	The request is canceled and in a terminal state
rejected	The request is rejected and in a terminal state
settled	The request was settled and is in a terminal state