Transactions

Transactions involve shifting amounts from one account to another.

Attribute	Description
amount	The amount to transfer from the sender account.
reference	A reference for the transaction.

Relationship	Description
sender	The account to send this transaction from.
recipient	The account to send this transaction to.

Meta	Description
exchangeRate	The exchange rate of the transaction, if applicable.
createdAt	The timestamp (UTC) (ISO8601) when the transaction was created.

• meta.exchangeRate will be omitted if the two accounts are the same currency.

---

---

Create transaction

POSThttps://api.testbank.dev/transactions

Body

application/json

data*object

Response

200401403404500

Created transaction

Body

application/json

data*TransactionResource

Request

JavaScriptCurlPython

const response = await fetch('https://api.testbank.dev/transactions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": {
        "type": "transactions",
        "attributes": {
          "amount": "100.00",
          "reference": "text"
        }
      }
    }),
});
const data = await response.json();

Response

200401403404500

{
  "data": {
    "type": "transactions",
    "id": "c3d4e5f6g7",
    "attributes": {
      "amount": "100.00",
      "reference": "text"
    },
    "relationships": {
      "sender": {
        "data": {
          "type": "accounts",
          "id": "a1b2c3d4e5"
        }
      },
      "recipient": {
        "data": {
          "type": "accounts",
          "id": "a1b2c3d4e5"
        }
      }
    },
    "meta": {
      "exchangeRate": 1,
      "createdAt": "2023-07-12T19:00:00.000Z"
    }
  }
}

• You cannot edit or delete a transaction after created.

---

---

Examples

Crediting your account

• You can credit your account by specifying "ROOT" as the sender account ID, and one of your accounts as the recipient.

• This is a Create event, similar to minting new coin, where you receive "funds" from nothing.

• Yes, you can credit your account insane amounts (but it's not real!).

POST /transactions HTTP/1.1
Content-Type: application/json
{
  "data": {
    "type": "transactions",
    "attributes": {
      "amount": "100.00",
      "reference": "Opening account"
    },
    "relationships": {
      // Specify ROOT as the sender
      "sender": { "data": { "type": "accounts", "id": "ROOT" } },
      // Specify one of your accounts as the recipient
      "recipient": { "data": { "type": "accounts", "id": "a1b2c3d4e5" } }
    },
    "meta": {
      "externalId": "b20e7841-39f4-4581-b858-c023c51ab463"
    }
  }
}

HTTP/1.1 201 Created
Content-Type: application/json
{
  "data": {
    "type": "transactions",
    "id": "01H5B3X62ENSWZBV0ZNXW7H9A4",
    "attributes": {
      "amount": "100.00",
      "reference": "Opening account"
    },
    "relationships": {
      "sender": { "data": { "type": "accounts", "id": "ROOT" } },
      "recipient": { "data": { "type": "accounts", "id": "a1b2c3d4e5" } }
    },
    "meta": {
      "externalId": "b20e7841-39f4-4581-b858-c023c51ab463"
    }
  }
}

Emptying your account

• You can empty your account by specifying "ROOT" as the recipient account ID.

• This is a Destroy event, where you send "funds" into nothing.

POST /transactions HTTP/1.1
Content-Type: application/json
{
  "data": {
    "type": "transactions",
    "attributes": {
      "amount": "100.00",
      "reference": "Closing account"
    },
    "relationships": {
      // Specify one of your accounts as the sender
      "sender": { "data": { "type": "accounts", "id": "a1b2c3d4e5" } },
      // Specify ROOT as the recipient
      "recipient": { "data": { "type": "accounts", "id": "ROOT" } }
    },
    "meta": {
      "externalId": "b20e7841-39f4-4581-b858-c023c51ab463"
    }
  }
}

HTTP/1.1 201 Created
Content-Type: application/json
{
  "data": {
    "type": "transactions",
    "id": "01H5B3X62ENSWZBV0ZNXW7H9A4",
    "attributes": {
      "amount": "100.00",
      "reference": "Closing account"
    },
    "relationships": {
      "sender": { "data": { "type": "accounts", "id": "ROOT" } },
      "recipient": { "data": { "type": "accounts", "id": "a1b2c3d4e5" } }
    },
    "meta": {
      "externalId": "b20e7841-39f4-4581-b858-c023c51ab463"
    }
  }
}

Transfer between 2 accounts

You can transfer funds between 2 accounts by specifying the relevant recipient account ID.

POST /transactions HTTP/1.1
Content-Type: application/json
{
  "data": {
    "type": "transactions",
    "attributes": {
      "amount": "100.00",
      "reference": "Lunch money"
    },
    "relationships": {
      // Specify one of your accounts as the sender
      "sender": { "data": { "type": "accounts", "id": "a1b2c3d4e5" } },
      // Specify another of your accounts as the sender
      "recipient": { "data": { "type": "accounts", "id": "f6g7h8i9j0" } }
    },
    "meta": {
      "externalId": "b20e7841-39f4-4581-b858-c023c51ab463"
    }
  }
}

HTTP/1.1 201 Created
Content-Type: application/json
{
  "data": {
    "type": "transactions",
    "id": "01H5B3X62ENSWZBV0ZNXW7H9A4",
    "attributes": {
      "amount": "100.00",
      "reference": "Lunch money"
    },
    "relationships": {
      "sender": { "data": { "type": "accounts", "id": "a1b2c3d4e5" } },
      "recipient": { "data": { "type": "accounts", "id": "a1b2c3d4e5" } }
    },
    "meta": {
      "externalId": "b20e7841-39f4-4581-b858-c023c51ab463"
    }
  }
}

• You can transfer from any of your accounts.

• You can transfer to any of your accounts, or any public/unlisted account.

As of now, you cannot transfer between accounts of different currencies.

Currency conversion will be addressed in a future version of this API.