Canceling transfer requests

Companies can cancel transfer requests sent to Loop. Canceling a transfer request does not remove a wallet's autopay authorization, it simply means Loop will not process the transfer request.

Multiple transfer requests can be cancelled in the same request.

PATCH//api/v1/transfers

Authorization

api_key

Header parameters

Body

application/json

transferId*string

The transfer ID

Example: "401bb7e7-a7f4-406d-b66c-ce769fdde7ca"

notesstring

Additional notes from the transfer initiator

billDatenumber (double)

The approximate time at which to process the given transfer request. This needs to be formatted as a Unix timestamp in seconds. If 0, the transfer request will be processed "immediately" (as soon as the Loop bot network picks it up)

Example: 1664096943

toAddressstring

The address receiving the transfer

Example: "0x0f2672BA12aed17BEe075F7AEabC24b98E3098Ca"

amountstring

The amount to transfer, denominated either in USD if field usd is set to true or the given token

Example: "1000000000"

usdboolean

Whether or not the amount is denominated in USD or the given token. If denominated in USD, the amount will be converted to the token amount at the time of processing. The exchange rate is retrieved from an on-chain Chainlink oracle. Conducting this conversion on-chain costs gas, thus consider only using this feature if converting from a non-stable coin (e.g. WETH).

Example: false

Response

200400401403422500504

Ok

Body

application/json

transfers*array of GeneralTransferResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('//api/v1/transfers', {
    method: 'PATCH',
    headers: {
      "entity-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "transferId": "401bb7e7-a7f4-406d-b66c-ce769fdde7ca"
      }
    ]),
});
const data = await response.json();

Response

200400401403422500504

{
  "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"
    }
  ]
}