Transfer request status

It is possible to get the status of already submitted transfer requests. Calling the GET endpoint will return the request details including the status of each transfer.

This request currently returns all transfer requests. The ability to filter and limit results will be added soon

In the case of failed payment, the failureMessage and failureCode will be populated with the relevant details of why the payment failed

GET//api/v1/transfers

Authorization

api_key

Query parameters

Header parameters

Response

200401403404422500504

Ok

Body

application/json

transfers*array of GeneralTransferResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('//api/v1/transfers', {
    method: 'GET',
    headers: {
      "entity-id": "text"
    },
});
const data = await response.json();

Response

200401403404422500504

{
  "transfers": [
    {
      "invoiceId": "text",
      "amount": "1212",
      "token": "text",
      "usd": true,
      "itemId": "1234-5678-9012",
      "status": 3,
      "networkId": 1,
      "source": 3,
      "paymentTypeId": 1,
      "batchId": "1234-5678-9012",
      "tags": [
        "Salaries",
        "Marketing"
      ],
      "notes": "This is July's payment",
      "transferId": "1234-5678-9012",
      "entityId": "1234-5678-9012",
      "toAddress": "1234-5678-9012",
      "fromAddress": "1234-5678-9012",
      "billDate": "1701974672",
      "billDateTime": "2024-04-04T13:54:05.000Z",
      "failureMessage": "Not enough balance",
      "failureCode": "0x00000000",
      "datePaid": "1701974672",
      "datePaidDateTime": "2024-04-04T13:54:05.000Z",
      "dateCreated": "1664096943",
      "transactionHash": "0x12345998023",
      "feeAmount": "100",
      "feePaid": "1",
      "decodedSignature": {
        "s": "text",
        "r": "text",
        "v": 0
      },
      "agreementId": "a836e7ac-5bfe-4eed-aa71-7864b82bd8eb"
    }
  ]
}