> ## Documentation Index > Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a single activity by type and ID > Returns a single activity (transaction, payment, order, or transaction box) for a given account, type, and ID. ## OpenAPI ````yaml /autogenerated/openapi/transactions.openapi.json get /activity/{type}/{id} openapi: 3.1.0 info: title: Transactions API version: 2.0.0 description: Version 2 license: name: UNLICENSED url: https://docs.equalsmoney.com servers: - url: https://api.equalsmoney.com/v2 description: Production - url: https://api-sandbox.equalsmoney.com/v2 description: Sandbox security: [] paths: /activity/{type}/{id}: get: tags: - Transaction activity summary: Get a single activity by type and ID description: >- Returns a single activity (transaction, payment, order, or transaction box) for a given account, type, and ID. operationId: findActivityByTypeAndId parameters: - name: type in: path required: true schema: description: The type of activity to retrieve. type: - string enum: - transaction - payment - order - boxTransaction - name: id in: path required: true schema: description: >- The ID of the activity to retrieve (transactionId for transaction, paymentId for payment, originOrderId for order, boxTransactionId for boxTransaction). type: - string - name: accountId in: query schema: type: - string description: The ID of the account to work with. example: F50091 required: true - name: include in: query schema: description: >- Controls which optional properties should be attached to the response. `forwardDetails` attaches the forward contract's payments, events, deposits and drawdowns to forwardContract rows. oneOf: - type: - string - type: - array items: type: - string enum: - bankFeedDetails - annotations - attachments - forwardDetails enum: - bankFeedDetails - annotations - attachments - forwardDetails example: bankFeedDetails,annotations - name: personId in: query schema: description: >- The ID of the person to work with. Use commas to pass multiple values. Has to be URL encoded. oneOf: - type: - string - type: - array items: type: - string format: uuid responses: '200': description: OK content: application/json: schema: oneOf: - type: - object properties: resourceType: type: - string enum: - payment - currencyPurchase description: >- Used to identify this particular type of Order. E.g. when it's part of the "activity" stream. Exchange payments return "currencyPurchase". example: payment id: type: - integer description: The ID of the Payment. example: 42782085 orderId: type: - integer description: The ID of the Order the Payment belongs to. example: 1380 userId: type: - string - 'null' maxLength: 36 description: >- The ID of the User that the Payment belongs to. Can be NULL (PAY Payment for example). example: 34edaf73-49be-4669-83ee-1b1f8c680d26 companyId: type: - string maxLength: 36 description: The ID of the Company that the Payment belongs to. example: F50072 originId: type: - string maxLength: 36 description: >- The ID of the Payment on the origin platform. PAY for example example: 9a623439-8275-4230-a157-6c623a2ea7b8 originOrderId: type: - string maxLength: 36 description: >- The order ID of the Order the Payment belongs to on the origin platform. PAY for example example: EKOBEPVFJ budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 status: type: - string enum: - needsApproval - fundsRequired - pending - complete - declined - reverted - refunded - cancelled - open - cardCheck - fundsSettled description: >- The status of the Payment. Currently always the same as the parent Order status. example: orderCancelled isMultiBeneficiary: type: - boolean description: Whether this is a single or multi beneficiary payment. budget: default: companyBalance type: - string enum: - companyBalance description: Always returns "companyBalance" as the Budget. beneficiaryId: type: - string maxLength: 256 description: The unique ID of the beneficiary example: ben90944601 beneficiaryName: type: - string maxLength: 256 description: Name of the Person receiving the Payment. example: Nichole Grant beneficiaryAddress: type: - string description: Address of the Person receiving the Payment. example: 46315 Bailey MillSouth CamilleNiue beneficiaryAccountNumber: type: - string maxLength: 32 description: Bank account number to send the Payment to. example: '10387899' beneficiarySortCode: type: - string maxLength: 32 description: Sort code of the bank to send the Payment to. example: 12-34-56 beneficiaryIban: type: - string maxLength: 34 description: Iban of the bank to send the Payment to. example: PT72105510150936500020992 beneficiaryBankCode: type: - string maxLength: 256 description: Bank code of the bank to send the Payment to. example: QHKEMKK1 beneficiaryBankAddress: type: - string description: Address of the bank the Payment is being made to. example: 883 Bernie MountainNew EstachesterVietnam beneficiaryCountryCode: type: - string description: >- The ISO country code for the country the beneficiary is registered to. example: GB beneficiaryRoutingInfo: type: - string description: >- Extra payment information as to how a payment will be routed. example: >- Payment will be routed from Barclays Bank and then through Lloyds bank remitterName: type: - string - 'null' maxLength: 256 description: Name of the Person send in the Payment. example: Joseph Bloggs reference: type: - string description: Handy reference to describe the Order. example: >- withdrawal transaction at Osinski, Zboncak and Bayer using card ending with ***3963 for IDR 670.50 in account ***32418758 amount: type: - number description: >- The amount the Payment was for. Maximum amount is 9999999999.99. example: 773.08 currency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD sellCurrency: type: - string - 'null' enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD buyCurrency: type: - string - 'null' enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD settlementAmount: type: - number - 'null' description: >- When isMultiBeneficiary = false. The amount of the currency being bought including our Fee. Maximum amount is 9999999999.99. example: 33920.34 settlementFee: type: - number - 'null' description: >- When isMultiBeneficiary = false. The total fee we took for the facilitating the purchase. example: 1.34 settlementAmountWithoutFee: type: - number - 'null' description: >- When isMultiBeneficiary = false. The amount of the currency being bought excluding our Fee. Maximum amount is 9999999999.99. example: 33920.34 customerRate: type: - number - 'null' description: >- When isMultiBeneficiary = false. The rate at which the buy currency was bought including any margin. This is the rate the customer sees example: 0.8637052 customerInverseRate: type: - number - 'null' description: >- When isMultiBeneficiary = false. The rate at which the sell currency was sold including any margin example: 0.71942446043 confirmationKey: type: - string - 'null' description: >- When isMultiBeneficiary = false. The key used to identify a pdf confirmation for an order. example: F36555/pdf/F36555-000265963.pdf uniqueId: type: - string maxLength: 256 description: The unique ID of the beneficiary on MTS example: 69e4a1e8-db35-4301-b5a8-67a2cb063609 type: type: - string - 'null' enum: - exchange - payment - cardPayment - deposit - forwardContract - drawdown - load - fee description: The type of the Payment. order: type: - object properties: id: type: - integer description: The ID of the Order. example: 1380 companyId: type: - string maxLength: 36 description: The ID of the Company that the Order belongs to. example: F50072 events: type: - array items: {} description: Array of events associated with the Order. originId: type: - string maxLength: 36 description: The ID of the Order on the origin platform. example: 9a623439-8275-4230-a157-6c623a2ea7b8 status: type: - string maxLength: 25 description: The status of the Order. example: complete type: type: - string maxLength: 25 description: The type of the Order. example: payment userId: type: - string - 'null' maxLength: 36 description: The ID of the User that the Order belongs to. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 userName: type: - string - 'null' maxLength: 256 description: The name of the User that the Order belongs to. example: John Doe lastSourceEventDatetime: type: - string - 'null' format: date-time description: The last source event datetime. orderSource: type: - string - 'null' description: The order source. parentOriginId: type: - string - 'null' description: The parent origin ID. settlementDate: type: - string - 'null' description: The settlement date. initiator: type: - string - 'null' description: >- The identifier of the entity that initiated the order. example: John Doe createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. metadata: type: - object additionalProperties: type: - string description: Metadata attached to the order. example: '{ paymentsCount: 1 }' required: - id - companyId - originId - status - type - userId - userName - lastSourceEventDatetime - orderSource - parentOriginId - settlementDate - createdAt - updatedAt description: The parent Order the Payment was made as part of. deleted: type: - boolean - 'null' description: >- Used to show if a payment has been deleted (when received from PAY). budgetName: type: - string description: The name of the budget. transactionGroupId: type: - string - 'null' description: The transaction group ID. example: 1c0547bd-30e6-4d14-b82e-78cd128fbfd9 transactionBoxes: type: - array items: type: - object properties: id: type: - string description: The ID of the transaction box. example: 2af0e603-0c72-4a7c-8020-52916d7a9960 accountId: type: - string description: The ID of the account to work with. example: F50091 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 transactionId: type: - string - 'null' description: The transaction ID. example: '42782085' transactionBoxableId: type: - string description: The transaction boxable ID. example: '42782085' transactionBoxableType: type: - string description: The transaction boxable type. example: payment paymentId: type: - integer - 'null' description: The payment ID. example: 42782085 orderId: type: - string description: The order ID. example: E61BG8PJCXQ4-Fee eventSource: type: - string description: >- The system or process that triggered this transaction. example: Orders chargeBearer: type: - string - 'null' description: Indicates who bears the transaction charges. blockId: type: - string - 'null' description: >- The unique identifier for the block this transaction belongs to. example: '454' blockTag: type: - string - 'null' description: >- A tag used to group related blocked transactions. example: abd8d22e-d701-45c4-960a-d198e0e16a14 blockFriendlyId: type: - string - 'null' maxLength: 36 description: >- The customer-facing UUID identifier for the block. example: abd8d22e-d701-45c4-960a-d198e0e16a14 paymentType: type: - string - 'null' description: The payment scheme used for this transaction. example: UK.OBIE.BalanceTransfer creditDebitIndicator: type: - string - 'null' enum: - Debit - Credit description: The credit and debit indicator. example: Debit thirdPartyReference: type: - string - 'null' maxLength: 50 description: >- A reference provided by the third party system that initiated this transaction. example: abd8d22e-d701-45c4-960a-d198e0e16a14-FEE internalAccountTransferId: type: - string - 'null' description: The internal account transfer id. example: BR89 affectsLedgerBalance: type: - boolean - 'null' description: >- A boolean to indicate if the ledger balance is affected. example: false isCurrencyAlignment: type: - boolean - 'null' description: >- Indicates if this is a currency alignment transaction. example: false runningBalance: type: - string - 'null' description: >- The balance after this transaction was processed. example: '957.92' transactionReference: type: - string - 'null' description: The transaction reference. example: '' statementReference: type: - string - 'null' description: The statement reference. example: '' debtorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name creditorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name fx: type: - object - 'null' properties: sourceCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD sourceAmount: type: - string description: The source amount of the FX. example: '1.16' destinationCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD destinationAmount: type: - string description: The destination amount of the FX. example: '1.00' rate: type: - string description: The rate of the FX. example: '0.8621' required: - sourceCurrency - sourceAmount - destinationCurrency - destinationAmount - rate debitId: type: - number - 'null' description: >- The unique identifier for the debit leg of this transaction. example: 1097 creditId: type: - number - 'null' description: >- The unique identifier for the credit leg of this transaction. example: 1098 boxTransactionId: type: - number - 'null' description: >- The unique id of the transaction generated in boxes. example: 17098 budget: type: - object - 'null' properties: accountId: type: - string description: The ID of the account to work with. example: F50091 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 budgetName: type: - string - 'null' description: The name of the budget to work with. example: Account Balance boxId: type: - string - 'null' maxLength: 36 description: The ID of the box collection. example: 5426d2ca50 required: - accountId - budgetId - budgetName - boxId description: The budget details. type: type: - string - 'null' enum: - credit - debit - block - internalPayment description: The type of transaction. example: credit marqetaTransactionToken: type: - string - 'null' maxLength: 50 description: >- Unique identifier for the transaction in Marqeta. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 boxId: type: - string - 'null' maxLength: 36 description: Unique identifier for the Box. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 marqetaTransactionIdentifier: type: - string - 'null' description: >- Unique numerical identifier as string for the transaction in Marqeta. example: '940' directDebitId: type: - string - 'null' format: uuid maxLength: 36 description: >- The ID of the direct debit mandate associated with this transaction. amount: type: - number - 'null' description: >- The transaction amount in the specified currency. example: 20 currency: type: - string - 'null' enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD valueDateTime: type: - string - 'null' format: date-time description: The time and date of the Box. example: '2021-01-30T08:30:00Z' bankFeedTransactions: type: - array items: {} description: Array of bank feed transactions. transactionCreditorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name transactionDebtorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - budgetId - transactionId - transactionBoxableId - transactionBoxableType - paymentId - orderId - eventSource - chargeBearer - blockId - blockTag - blockFriendlyId - paymentType - creditDebitIndicator - thirdPartyReference - type - marqetaTransactionToken - boxId - marqetaTransactionIdentifier - amount - currency - valueDateTime - createdAt - updatedAt description: >- Array of all the box events which belongs to a Payment. annotationGroup: type: - object - 'null' properties: id: type: - string format: uuid description: The id of the Annotation Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 transactionGroupId: type: - string - 'null' format: uuid description: The id of the Transaction Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: type: - number - 'null' description: The id of the Payment example: 1234 status: type: - string enum: - approved - draft - exported - submitted description: The status of the Annotation Group example: draft annotations: type: - array items: type: - object properties: id: type: - string format: uuid description: The id of the Annotation example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 annotationGroupId: type: - string format: uuid description: The id of the Annotation Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 amount: type: - number description: The amount of the Annotation example: 100 annotationValues: type: - array items: {} description: >- Array of annotationValue objects (see annotationValue.dto). Each contains the annotation field id plus resolved field metadata (annotationFieldTitle, annotationFieldType) and one populated typed value (booleanValue | textValue | unsignedIntegerValue | decimalValue | uuidValue). Dropdown values additionally resolve dropdownValue and dropdownCode. createdBy: type: - string - 'null' format: uuid description: ID of the User who created the resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: type: - string - 'null' format: uuid description: >- ID of the User who lastly modified the resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - annotationGroupId - accountId - amount - annotationValues - createdBy - updatedBy - createdAt - updatedAt description: An array of annotations createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - transactionGroupId - paymentId - status - annotations attachment: type: - object - 'null' properties: id: type: - string format: uuid description: The id of the Attachment example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 isLost: type: - boolean description: >- Indicates whether the attachment corresponding to this transaction has been lost. example: false note: type: - string - 'null' maxLength: 280 description: >- Free text field where to state reason why the attachment was lost. example: >- I did not lose the file to attach so I do not need to fill in this field. transactionGroupId: type: - string - 'null' format: uuid description: >- The id of the transaction thats associated to this attachment example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: type: - number - 'null' description: >- The id of the transaction thats associated to this attachment example: 1234 count: type: - integer minimum: 0 maximum: 255 description: >- This points to the last attachment file. It's used internally to name files. example: 2 attachmentFiles: type: - array items: type: - object properties: id: type: - string format: uuid description: The id of the Attachment File example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 attachmentId: type: - string format: uuid description: >- The ID of the Attachment to which this Attachment File belongs example: c32ba075-f6e9-45db-aae8-a8f1aeaa14b3 productId: type: - string format: uuid maxLength: 36 description: The ID of the product to work with. example: 3ef24d53-6e22-4103-a16b-d268e4f7346d fileName: type: - string maxLength: 256 description: >- The name of the file corresponding to this attachment file. example: >- 2021-09-01T13:04:57Z_288946aa-0469-4518-a962-40e9be858d1e_2.pdf year: type: - string maxLength: 4 minLength: 4 pattern: ^\d+$ description: >- The year of the Transaction Group of this Attachment. example: '2021' month: type: - string maxLength: 2 minLength: 1 pattern: ^\d+$ description: >- The month of the Transaction Group of this Attachment. example: '9' file: oneOf: - default: true type: - boolean - 'null' description: Boolean indicating if file exists. - type: - object properties: url: type: - string - 'null' description: >- The url from where this file can be visualised or downloaded. Will be null if the file is no longer available. example: >- http://127.0.0.1:8080/v1/transactions-api/accounts/F50091/transactions/group/288946aa-0469-4518-a962-40e9be858d1e/attachment/files/8ae07ba6-d2b0-4665-9158-2f33d0852a4f unavailable: type: - boolean - 'null' description: >- Indicates if the file is no longer available. required: - url - unavailable description: Contains the file url to retrieve it. type: type: - string - 'null' enum: - heic - pdf - jpg - jpeg - png description: The file type. example: pdf createdBy: type: - string format: uuid description: >- ID of the User who lastly modified a resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: type: - string format: uuid description: >- ID of the User who lastly modified a resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - attachmentId - productId - fileName - year - month - type - createdBy - updatedBy - createdAt - updatedAt description: All the files attached to this Attachment createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - isLost - note - transactionGroupId - paymentId - count - attachmentFiles forwardDetails: type: - object - 'null' properties: payments: type: - array items: {} description: >- Payments tied to the forward contract (drawdown payments and deposit payments). events: type: - array items: {} description: >- Timeline events for the forward contract inspector. currencyPurchases: type: - array items: {} description: >- CurrencyPurchase rows for the forward order itself — carries deposit metadata (depositStatus, depositPercentage, depositAmountRequired, depositCurrency, etc.), customerRate / customerSpread / fundsSource / fundsDestination / bankEntity / fundsRequired and remainingBalance that the PWA forwards page reads. deposits: type: - array items: {} description: >- Nested deposit orders, each with their own payments and currencyPurchases. drawdowns: type: - array items: {} description: >- Nested drawdown orders, each with their own payments. required: - payments - events - currencyPurchases - deposits - drawdowns description: >- Nested forward-contract details. Only populated when include=forwardDetails is requested for forwardContract rows. teams: oneOf: - type: - string - type: - array items: type: - string description: >- Comma-separated list of team names associated with the payment initiator. Only present when include=teams is specified. createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - resourceType - id - orderId - userId - companyId - originId - originOrderId - budgetId - status - isMultiBeneficiary - beneficiaryId - beneficiaryName - beneficiaryAddress - beneficiaryAccountNumber - beneficiarySortCode - beneficiaryIban - beneficiaryBankCode - beneficiaryBankAddress - beneficiaryCountryCode - beneficiaryRoutingInfo - remitterName - reference - amount - currency - sellCurrency - buyCurrency - settlementAmount - settlementFee - settlementAmountWithoutFee - customerRate - customerInverseRate - confirmationKey - uniqueId - type - order - budgetName - transactionGroupId - transactionBoxes - createdAt - updatedAt - type: - object properties: resourceType: default: card type: - string enum: - card description: >- Used to identify this particular type of Transaction. E.g. when it's part of the "activity" stream. example: card id: type: - string description: The ID of the Transaction. example: 87c87d2d-a895-4e7e-a522-5f9950b98b71 accountId: type: - string description: The ID of the account to work with. example: F50091 transactionDate: type: - string format: date-time description: >- The date of the transaction. ISO 8601 format without milliseconds. example: '2021-01-30T08:30:00Z' cardTransaction: type: - object properties: id: type: - string description: The ID of the card transaction. example: 6fcae7ba-e64d-470d-9089-54cb379d69f9 identifier: type: - number - 'null' description: >- Unique identifier for the transaction passed by Marqeta. example: '940' localAmount: type: - number - 'null' description: The amount charged for the transaction. example: '33920.34' localAmountCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD feeAmount: type: - number - 'null' description: The fee paid for the transaction. example: '33920.34' feeCurrency: type: - string - 'null' enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD exchangeRate: type: - number - 'null' description: The exchange rate for the transaction. example: '0.7812346' exchangeRateInverse: type: - number - 'null' description: The inverse exchange rate for the transaction. example: '1.2800252' total: type: - number - 'null' description: The total for the transaction. example: '34920.34' cardId: type: - string description: The ID of the card. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 cardProductToken: type: - string - 'null' format: uuid description: >- The card product token corresponding to the card used. example: d6ee9cb4-f3c7-4217-b0bc-1c2ac37ee78d cardType: type: - string enum: - VIRTUAL_PAN - PHYSICAL_MSR - PHYSICAL_COMBO description: Type of card. example: PHYSICAL_MSR cardLastDigits: type: - string description: The last 4 digits of the card number. example: '1234' status: type: - string enum: - pending - complete - declined - reverted - unknown description: The transaction status. example: pending type: type: - string enum: - card - cardCheck - cardRefund - cashWithdrawal - fee - unknown description: The transaction type. example: card approvalCode: type: - number - 'null' description: >- Unique identifier assigned to a given authorization. Is printed on the receipt at point of sale. example: '1234' acquirerInstitutionIdCode: type: - string - 'null' description: ID code of the merchant financial institution. example: '014979' acquirerReferenceNumber: type: - string - 'null' description: >- Contains data regarding clearing events that can be used to tie a clearing event back to the card network. example: arn1665069145275 cardName: type: - string maxLength: 75 description: The name assigned to the card. example: Test card chargedAmount: type: - number - 'null' description: The amount which is charged. example: 100 chargedTotalAmount: type: - number - 'null' description: The amount which is charged along with fee. example: 110 chargedCurrency: type: - string - 'null' maxLength: 3 description: Currency code. ISO-4217 format. example: USD baseCurrency: type: - string maxLength: 3 description: >- The base currency of the account in ISO 4217 format. example: GBP paymentChannel: type: - string description: >- The channel through which the payment was made (e.g., ECOMMERCE, POS). example: ECOMMERCE pos: type: - object properties: cardDataInputCapability: type: - string description: Card data input capability. example: UNKNOWN cardHolderPresence: type: - boolean description: Card holder presence. example: true cardPresence: type: - boolean description: Card presence. example: true cardholderAuthenticationMethod: type: - string description: Cardholder authentication method. example: PIN description: >- Point of sale terminal information for in-person transactions. precedingRelatedTransactionToken: type: - string description: Preceding related transaction token. example: 5df33953-63a6-4124-a3cb-f8c898f36b96 runningBalance: type: - string description: The balance after this transaction was processed. example: '2000.49' settlementAmount: type: - number description: The settlement amount. example: 100.5 settlementAmountCurrency: type: - string maxLength: 3 description: The settlement amount currency. example: GBP transactionId: type: - string description: The transaction ID. example: d3c69842-838a-45cd-9ae3-c53a46b3aa75 transactionType: type: - string description: The transaction type. example: authorization response: type: - object properties: code: type: - string - 'null' maxLength: 10 description: Transaction response code. example: '1922' memo: type: - string - 'null' maxLength: 256 description: Transaction response memo. example: Transaction cannot be completed required: - code - memo transactionCompletedAt: type: - string - 'null' format: date-time description: Date at which the transaction is completed. example: '2021-01-30T08:30:00Z' transactionCreatedAt: type: - string format: date-time description: Date at which the transaction is created. example: '2021-01-30T08:30:00Z' transactionToken: type: - string - 'null' maxLength: 50 description: Unique identifier in Marqeta for transaction. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 boxesResponse: type: - string - 'null' maxLength: 256 description: Response from call to Boxes. example: pass updatedAtBoxTransaction: type: - string format: date-time description: The update date for box transaction. example: '2021-01-30T08:30:00Z' createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - identifier - localAmount - localAmountCurrency - feeAmount - feeCurrency - exchangeRate - exchangeRateInverse - total - cardId - cardProductToken - cardType - cardLastDigits - status - type - approvalCode - acquirerInstitutionIdCode - acquirerReferenceNumber - cardName - chargedAmount - chargedTotalAmount - chargedCurrency - transactionCompletedAt - transactionCreatedAt - transactionToken - boxesResponse transactionGroup: type: - object properties: id: type: - string description: The ID of the transaction group example: 34edaf73-49be-4669-83ee-1b1f8c680d26 accountId: type: - string description: The ID of the account to work with. example: F50091 personId: type: - string - 'null' format: uuid maxLength: 36 description: The ID of the person to work with. example: 775596ae-2624-40af-a9dc-9756110a4a04 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 firstName: type: - string - 'null' description: The firstname of the user example: Jane lastName: type: - string - 'null' description: The lastname of the user example: Doe budgetName: type: - string description: The name of the budget example: companyBalance createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. annotationGroup: type: - object - 'null' properties: id: type: - string format: uuid description: The id of the Annotation Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 transactionGroupId: type: - string - 'null' format: uuid description: The id of the Transaction Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: type: - number - 'null' description: The id of the Payment example: 1234 status: type: - string enum: - approved - draft - exported - submitted description: The status of the Annotation Group example: draft annotations: type: - array items: type: - object properties: id: type: - string format: uuid description: The id of the Annotation example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 annotationGroupId: type: - string format: uuid description: The id of the Annotation Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 amount: type: - number description: The amount of the Annotation example: 100 annotationValues: type: - array items: {} description: >- Array of annotationValue objects (see annotationValue.dto). Each contains the annotation field id plus resolved field metadata (annotationFieldTitle, annotationFieldType) and one populated typed value (booleanValue | textValue | unsignedIntegerValue | decimalValue | uuidValue). Dropdown values additionally resolve dropdownValue and dropdownCode. createdBy: type: - string - 'null' format: uuid description: ID of the User who created the resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: type: - string - 'null' format: uuid description: >- ID of the User who lastly modified the resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - annotationGroupId - accountId - amount - annotationValues - createdBy - updatedBy - createdAt - updatedAt description: An array of annotations createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - transactionGroupId - paymentId - status - annotations attachment: type: - object - 'null' properties: id: type: - string format: uuid description: The id of the Attachment example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 isLost: type: - boolean description: >- Indicates whether the attachment corresponding to this transaction has been lost. example: false note: type: - string - 'null' maxLength: 280 description: >- Free text field where to state reason why the attachment was lost. example: >- I did not lose the file to attach so I do not need to fill in this field. transactionGroupId: type: - string - 'null' format: uuid description: >- The id of the transaction thats associated to this attachment example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: type: - number - 'null' description: >- The id of the transaction thats associated to this attachment example: 1234 count: type: - integer minimum: 0 maximum: 255 description: >- This points to the last attachment file. It's used internally to name files. example: 2 attachmentFiles: type: - array items: type: - object properties: id: type: - string format: uuid description: The id of the Attachment File example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 attachmentId: type: - string format: uuid description: >- The ID of the Attachment to which this Attachment File belongs example: c32ba075-f6e9-45db-aae8-a8f1aeaa14b3 productId: type: - string format: uuid maxLength: 36 description: The ID of the product to work with. example: 3ef24d53-6e22-4103-a16b-d268e4f7346d fileName: type: - string maxLength: 256 description: >- The name of the file corresponding to this attachment file. example: >- 2021-09-01T13:04:57Z_288946aa-0469-4518-a962-40e9be858d1e_2.pdf year: type: - string maxLength: 4 minLength: 4 pattern: ^\d+$ description: >- The year of the Transaction Group of this Attachment. example: '2021' month: type: - string maxLength: 2 minLength: 1 pattern: ^\d+$ description: >- The month of the Transaction Group of this Attachment. example: '9' file: oneOf: - default: true type: - boolean - 'null' description: Boolean indicating if file exists. - type: - object properties: url: type: - string - 'null' description: >- The url from where this file can be visualised or downloaded. Will be null if the file is no longer available. example: >- http://127.0.0.1:8080/v1/transactions-api/accounts/F50091/transactions/group/288946aa-0469-4518-a962-40e9be858d1e/attachment/files/8ae07ba6-d2b0-4665-9158-2f33d0852a4f unavailable: type: - boolean - 'null' description: >- Indicates if the file is no longer available. required: - url - unavailable description: Contains the file url to retrieve it. type: type: - string - 'null' enum: - heic - pdf - jpg - jpeg - png description: The file type. example: pdf createdBy: type: - string format: uuid description: >- ID of the User who lastly modified a resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: type: - string format: uuid description: >- ID of the User who lastly modified a resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - attachmentId - productId - fileName - year - month - type - createdBy - updatedBy - createdAt - updatedAt description: All the files attached to this Attachment createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - isLost - note - transactionGroupId - paymentId - count - attachmentFiles bankFeedTransactions: type: - array items: {} description: Array of bank feed transactions. totals: type: - object properties: authorised: type: - number description: Total authorised amount settled: type: - number description: Total settled amount description: Transaction totals required: - id - accountId - personId - budgetId - firstName - lastName - budgetName - createdAt - updatedAt transactionBox: type: - object - 'null' properties: id: type: - string description: The ID of the transaction box. example: 2af0e603-0c72-4a7c-8020-52916d7a9960 accountId: type: - string description: The ID of the account to work with. example: F50091 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 transactionId: type: - string - 'null' description: The transaction ID. example: '42782085' transactionBoxableId: type: - string description: The transaction boxable ID. example: '42782085' transactionBoxableType: type: - string description: The transaction boxable type. example: payment paymentId: type: - integer - 'null' description: The payment ID. example: 42782085 orderId: type: - string description: The order ID. example: E61BG8PJCXQ4-Fee eventSource: type: - string description: >- The system or process that triggered this transaction. example: Orders chargeBearer: type: - string - 'null' description: Indicates who bears the transaction charges. blockId: type: - string - 'null' description: >- The unique identifier for the block this transaction belongs to. example: '454' blockTag: type: - string - 'null' description: A tag used to group related blocked transactions. example: abd8d22e-d701-45c4-960a-d198e0e16a14 blockFriendlyId: type: - string - 'null' maxLength: 36 description: The customer-facing UUID identifier for the block. example: abd8d22e-d701-45c4-960a-d198e0e16a14 paymentType: type: - string - 'null' description: The payment scheme used for this transaction. example: UK.OBIE.BalanceTransfer creditDebitIndicator: type: - string - 'null' enum: - Debit - Credit description: The credit and debit indicator. example: Debit thirdPartyReference: type: - string - 'null' maxLength: 50 description: >- A reference provided by the third party system that initiated this transaction. example: abd8d22e-d701-45c4-960a-d198e0e16a14-FEE internalAccountTransferId: type: - string - 'null' description: The internal account transfer id. example: BR89 affectsLedgerBalance: type: - boolean - 'null' description: >- A boolean to indicate if the ledger balance is affected. example: false isCurrencyAlignment: type: - boolean - 'null' description: >- Indicates if this is a currency alignment transaction. example: false runningBalance: type: - string - 'null' description: The balance after this transaction was processed. example: '957.92' transactionReference: type: - string - 'null' description: The transaction reference. example: '' statementReference: type: - string - 'null' description: The statement reference. example: '' debtorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name creditorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name fx: type: - object - 'null' properties: sourceCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD sourceAmount: type: - string description: The source amount of the FX. example: '1.16' destinationCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD destinationAmount: type: - string description: The destination amount of the FX. example: '1.00' rate: type: - string description: The rate of the FX. example: '0.8621' required: - sourceCurrency - sourceAmount - destinationCurrency - destinationAmount - rate debitId: type: - number - 'null' description: >- The unique identifier for the debit leg of this transaction. example: 1097 creditId: type: - number - 'null' description: >- The unique identifier for the credit leg of this transaction. example: 1098 boxTransactionId: type: - number - 'null' description: >- The unique id of the transaction generated in boxes. example: 17098 budget: type: - object - 'null' properties: accountId: type: - string description: The ID of the account to work with. example: F50091 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 budgetName: type: - string - 'null' description: The name of the budget to work with. example: Account Balance boxId: type: - string - 'null' maxLength: 36 description: The ID of the box collection. example: 5426d2ca50 required: - accountId - budgetId - budgetName - boxId description: The budget details. type: type: - string - 'null' enum: - credit - debit - block - internalPayment description: The type of transaction. example: credit marqetaTransactionToken: type: - string - 'null' maxLength: 50 description: Unique identifier for the transaction in Marqeta. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 boxId: type: - string - 'null' maxLength: 36 description: Unique identifier for the Box. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 marqetaTransactionIdentifier: type: - string - 'null' description: >- Unique numerical identifier as string for the transaction in Marqeta. example: '940' directDebitId: type: - string - 'null' format: uuid maxLength: 36 description: >- The ID of the direct debit mandate associated with this transaction. amount: type: - number - 'null' description: The transaction amount in the specified currency. example: 20 currency: type: - string - 'null' enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD valueDateTime: type: - string - 'null' format: date-time description: The time and date of the Box. example: '2021-01-30T08:30:00Z' bankFeedTransactions: type: - array items: {} description: Array of bank feed transactions. transactionCreditorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name transactionDebtorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - budgetId - transactionId - transactionBoxableId - transactionBoxableType - paymentId - orderId - eventSource - chargeBearer - blockId - blockTag - blockFriendlyId - paymentType - creditDebitIndicator - thirdPartyReference - type - marqetaTransactionToken - boxId - marqetaTransactionIdentifier - amount - currency - valueDateTime - createdAt - updatedAt merchant: type: - object properties: id: type: - string description: The ID of the merchant. example: fed3437e-4f44-472c-b018-063eec393e3e name: type: - string - 'null' description: The merchant name example: Jane Doe description: type: - string - 'null' description: The merchant description example: Information about merchant address: type: - string - 'null' description: The merchants address example: 1 building city: type: - string - 'null' description: The merchants city example: Twickenham state: type: - string - 'null' description: The merchants state example: CA postalCode: type: - string - 'null' description: The merchants postal code example: TW3121 countryCode: type: - string - 'null' description: The merchants country code example: USA merchantCategoryId: type: - string - 'null' description: The merchants location address example: 1234 - Finance mid: type: - string - 'null' description: The merchant identification number example: '11111' subMerchantId: type: - string - 'null' description: >- The sub merchant identification number involved in the transaction example: '11111' website: type: - string - 'null' description: The merchants web address example: https://equalsmoney.com emoji: type: - string description: The merchant emoji. example: Test Merchant logo: type: - string description: The merchant logo. example: Test Merchant notes: type: - string description: The merchant notes. example: Test Merchant originalName: type: - string description: The original merchant name. example: original Merchant Name merchantCategory: type: - object properties: id: type: - string description: The ID of the merchant category. example: 440961a1-71d4-4b6d-a5c1-07fa6ddf2ee0 code: type: - string - 'null' description: The merchant category name example: f1111 description: type: - string description: The merchant category description. example: Test Merchant Category createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - code createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - name - description - address - city - state - postalCode - countryCode - merchantCategoryId - mid - subMerchantId - website - merchantCategory paymentChannel: type: - string - 'null' description: This tells if the transaction was done online or pos. example: ECOMMERCE status: type: - string enum: - needsApproval - fundsRequired - pending - complete - declined - reverted - refunded - cancelled - open - cardCheck - fundsSettled description: >- The status of the Payment. Currently always the same as the parent Order status. example: orderCancelled sourceGroupId: type: - string description: The source group ID. example: 8a2231ed-cfef-454b-bb34-e67a7a71c8e8 transactionGroupId: type: - string description: The transaction group ID. example: 1c0547bd-30e6-4d14-b82e-78cd128fbfd9 transactionType: type: - string description: The transaction type. example: Marqeta initiator: type: - object - 'null' properties: {} additionalProperties: true createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - transactionDate - cardTransaction - status - sourceGroupId - transactionGroupId - transactionType - initiator - createdAt - updatedAt - type: - object properties: resourceType: type: - string enum: - currencyPurchase description: >- Used to identify this particular type of Order. E.g. when it's part of the "activity" stream. example: currencyPurchase id: type: - integer - 'null' description: >- Our internal ID for the resource. Use this ID when dealing with the resource on an individual level. example: 1844 userId: type: - string - 'null' description: >- The ID of the User that the Order belongs to. Can be NULL (PAY Orders for example). example: 34edaf73-49be-4669-83ee-1b1f8c680d26 companyId: type: - string maxLength: 36 description: The ID of the Company that the Order belongs to. example: F50072 originOrderId: type: - string - 'null' maxLength: 36 description: >- The order ID of the Order the Currency Purchase belongs to on the origin platform. PAY for example. example: EKOBEPVFJ status: type: - string enum: - needsApproval - fundsRequired - pending - complete - declined - reverted - refunded - cancelled - open - cardCheck - fundsSettled description: >- The status of the Payment. Currently always the same as the parent Order status. example: orderCancelled sellCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD buyAmount: type: - number description: >- The amount of the currency being bought. Maximum amount is 9999999999.99. example: 33920.34 buyCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD settlementAmountWithoutFee: type: - number - 'null' description: >- The amount of the currency being bought excluding our Fee. Maximum amount is 9999999999.99. example: 33920.34 settlementAmount: type: - number - 'null' description: >- The amount of the currency being bought including our Fee. Maximum amount is 9999999999.99. example: 33920.34 settlementFee: type: - number - 'null' description: >- The total fee we took for the facilitating the purchase. example: 1.34 settlementDate: type: - string - 'null' description: The final date of the settlement. example: '2021-03-30' remainingBalance: type: - number - 'null' description: The remaining balance required to pay. example: 22003.34 depositPercentage: type: - number - 'null' description: >- The deposit percentage the customer had to pay for this order. example: 10 depositAmountRequired: type: - number - 'null' description: Total amount of deposit required to pay. example: 100.32 depositSettlementDate: type: - string - 'null' description: The date the deposit needs to be paid by. example: '2021-03-30' customerSpread: type: - string maxLength: 256 description: >- The amount of commission taken on the exchange including any margin. example: '0.01' customerRate: type: - number - 'null' description: >- The rate at which the buy currency was bought including any margin. This is the rate the customer sees. example: 0.8637052 customerInverseRate: type: - number - 'null' description: >- The rate at which the sell currency was sold including any margin. example: 0.71942446043 confirmationKey: type: - string - 'null' description: >- The key used to identify a pdf confirmation for an order. example: F36555/pdf/F36555-000265963.pdf budget: default: companyBalance type: - string enum: - companyBalance description: Always returns "companyBalance" as the Budget. type: type: - string - 'null' enum: - exchange - payment - deposit - forwardContract - drawdown - load - fee description: The type of the Currency Purchase. fundsSource: type: - string - 'null' enum: - balance - bank - boxes_funds_held - cash - accounts receivable - card - cheque - internal funds transfer description: The source of the funds. fundsDestination: type: - string - 'null' enum: - balance - payment - multiple - unknown - forward - fee description: The destination of the funds. bankEntity: type: - string - 'null' enum: - BARC - CITI - RBS - CROWN - BARCEU description: Bank where fund will be settled. example: BARC orderId: type: - integer description: The ID of the Order the currency purchase belongs to. example: 1428 order: type: - object properties: id: type: - integer description: The ID of the Order. example: 1380 companyId: type: - string maxLength: 36 description: The ID of the Company that the Order belongs to. example: F50072 events: type: - array items: {} description: Array of events associated with the Order. originId: type: - string maxLength: 36 description: The ID of the Order on the origin platform. example: 9a623439-8275-4230-a157-6c623a2ea7b8 status: type: - string maxLength: 25 description: The status of the Order. example: complete type: type: - string maxLength: 25 description: The type of the Order. example: payment userId: type: - string - 'null' maxLength: 36 description: The ID of the User that the Order belongs to. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 userName: type: - string - 'null' maxLength: 256 description: The name of the User that the Order belongs to. example: John Doe lastSourceEventDatetime: type: - string - 'null' format: date-time description: The last source event datetime. orderSource: type: - string - 'null' description: The order source. parentOriginId: type: - string - 'null' description: The parent origin ID. settlementDate: type: - string - 'null' description: The settlement date. initiator: type: - string - 'null' description: >- The identifier of the entity that initiated the order. example: John Doe createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. metadata: type: - object additionalProperties: type: - string description: Metadata attached to the order. example: '{ paymentsCount: 1 }' required: - id - companyId - originId - status - type - userId - userName - lastSourceEventDatetime - orderSource - parentOriginId - settlementDate - createdAt - updatedAt description: The parent Order the Payment was made as part of. depositCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD depositStatus: type: - string maxLength: 25 description: The deposit status. example: complete fundsRequired: type: - number description: The funds required. example: 100 forwardDetails: type: - object - 'null' properties: payments: type: - array items: {} description: >- Payments tied to the forward contract (drawdown payments and deposit payments). events: type: - array items: {} description: >- Timeline events for the forward contract inspector. currencyPurchases: type: - array items: {} description: >- CurrencyPurchase rows for the forward order itself — carries deposit metadata (depositStatus, depositPercentage, depositAmountRequired, depositCurrency, etc.), customerRate / customerSpread / fundsSource / fundsDestination / bankEntity / fundsRequired and remainingBalance that the PWA forwards page reads. deposits: type: - array items: {} description: >- Nested deposit orders, each with their own payments and currencyPurchases. drawdowns: type: - array items: {} description: >- Nested drawdown orders, each with their own payments. required: - payments - events - currencyPurchases - deposits - drawdowns description: >- Nested forward-contract details. Only populated when include=forwardDetails is requested for forwardContract rows. createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - resourceType - userId - companyId - originOrderId - status - sellCurrency - buyCurrency - settlementAmountWithoutFee - settlementAmount - settlementFee - customerRate - customerInverseRate - confirmationKey - type - orderId - order - depositCurrency - createdAt - updatedAt - type: - object properties: resourceType: default: box type: - string enum: - box description: >- Used to identify this particular type of Transaction. E.g. when it's part of the "activity" stream. example: box id: type: - string description: The ID of the Transaction. example: a2438691-5300-4aef-b299-93c28f678a4d accountId: type: - string description: The ID of the account to work with. example: F50091 createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. initiator: type: - object - 'null' properties: {} additionalProperties: true sourceGroupId: type: - string description: The source group ID. example: d4a1e2d8-d21f-47b0-8e7d-1d01d163d523 status: type: - string enum: - needsApproval - fundsRequired - pending - complete - declined - reverted - refunded - cancelled - open - cardCheck - fundsSettled description: >- The status of the Payment. Currently always the same as the parent Order status. example: orderCancelled transactionDate: type: - string format: date-time description: >- The date of the transaction. ISO 8601 format without milliseconds. example: '2023-01-30T11:12:15.000Z' transactionGroup: type: - object properties: id: type: - string description: The ID of the transaction group example: 34edaf73-49be-4669-83ee-1b1f8c680d26 accountId: type: - string description: The ID of the account to work with. example: F50091 personId: type: - string - 'null' format: uuid maxLength: 36 description: The ID of the person to work with. example: 775596ae-2624-40af-a9dc-9756110a4a04 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 firstName: type: - string - 'null' description: The firstname of the user example: Jane lastName: type: - string - 'null' description: The lastname of the user example: Doe budgetName: type: - string description: The name of the budget example: companyBalance createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. annotationGroup: type: - object - 'null' properties: id: type: - string format: uuid description: The id of the Annotation Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 transactionGroupId: type: - string - 'null' format: uuid description: The id of the Transaction Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: type: - number - 'null' description: The id of the Payment example: 1234 status: type: - string enum: - approved - draft - exported - submitted description: The status of the Annotation Group example: draft annotations: type: - array items: type: - object properties: id: type: - string format: uuid description: The id of the Annotation example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 annotationGroupId: type: - string format: uuid description: The id of the Annotation Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 amount: type: - number description: The amount of the Annotation example: 100 annotationValues: type: - array items: {} description: >- Array of annotationValue objects (see annotationValue.dto). Each contains the annotation field id plus resolved field metadata (annotationFieldTitle, annotationFieldType) and one populated typed value (booleanValue | textValue | unsignedIntegerValue | decimalValue | uuidValue). Dropdown values additionally resolve dropdownValue and dropdownCode. createdBy: type: - string - 'null' format: uuid description: ID of the User who created the resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: type: - string - 'null' format: uuid description: >- ID of the User who lastly modified the resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - annotationGroupId - accountId - amount - annotationValues - createdBy - updatedBy - createdAt - updatedAt description: An array of annotations createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - transactionGroupId - paymentId - status - annotations attachment: type: - object - 'null' properties: id: type: - string format: uuid description: The id of the Attachment example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 isLost: type: - boolean description: >- Indicates whether the attachment corresponding to this transaction has been lost. example: false note: type: - string - 'null' maxLength: 280 description: >- Free text field where to state reason why the attachment was lost. example: >- I did not lose the file to attach so I do not need to fill in this field. transactionGroupId: type: - string - 'null' format: uuid description: >- The id of the transaction thats associated to this attachment example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: type: - number - 'null' description: >- The id of the transaction thats associated to this attachment example: 1234 count: type: - integer minimum: 0 maximum: 255 description: >- This points to the last attachment file. It's used internally to name files. example: 2 attachmentFiles: type: - array items: type: - object properties: id: type: - string format: uuid description: The id of the Attachment File example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 attachmentId: type: - string format: uuid description: >- The ID of the Attachment to which this Attachment File belongs example: c32ba075-f6e9-45db-aae8-a8f1aeaa14b3 productId: type: - string format: uuid maxLength: 36 description: The ID of the product to work with. example: 3ef24d53-6e22-4103-a16b-d268e4f7346d fileName: type: - string maxLength: 256 description: >- The name of the file corresponding to this attachment file. example: >- 2021-09-01T13:04:57Z_288946aa-0469-4518-a962-40e9be858d1e_2.pdf year: type: - string maxLength: 4 minLength: 4 pattern: ^\d+$ description: >- The year of the Transaction Group of this Attachment. example: '2021' month: type: - string maxLength: 2 minLength: 1 pattern: ^\d+$ description: >- The month of the Transaction Group of this Attachment. example: '9' file: oneOf: - default: true type: - boolean - 'null' description: Boolean indicating if file exists. - type: - object properties: url: type: - string - 'null' description: >- The url from where this file can be visualised or downloaded. Will be null if the file is no longer available. example: >- http://127.0.0.1:8080/v1/transactions-api/accounts/F50091/transactions/group/288946aa-0469-4518-a962-40e9be858d1e/attachment/files/8ae07ba6-d2b0-4665-9158-2f33d0852a4f unavailable: type: - boolean - 'null' description: >- Indicates if the file is no longer available. required: - url - unavailable description: Contains the file url to retrieve it. type: type: - string - 'null' enum: - heic - pdf - jpg - jpeg - png description: The file type. example: pdf createdBy: type: - string format: uuid description: >- ID of the User who lastly modified a resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: type: - string format: uuid description: >- ID of the User who lastly modified a resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - attachmentId - productId - fileName - year - month - type - createdBy - updatedBy - createdAt - updatedAt description: All the files attached to this Attachment createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - isLost - note - transactionGroupId - paymentId - count - attachmentFiles bankFeedTransactions: type: - array items: {} description: Array of bank feed transactions. totals: type: - object properties: authorised: type: - number description: Total authorised amount settled: type: - number description: Total settled amount description: Transaction totals required: - id - accountId - personId - budgetId - firstName - lastName - budgetName - createdAt - updatedAt transactionGroupId: type: - string description: The transaction group ID. example: 0163e923-11d0-4a3d-ba79-ad8ef1dc4675 transactionType: type: - string description: The transaction type. example: Boxes transactionBox: type: - object - 'null' properties: id: type: - string description: The ID of the transaction box. example: 2af0e603-0c72-4a7c-8020-52916d7a9960 accountId: type: - string description: The ID of the account to work with. example: F50091 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 transactionId: type: - string - 'null' description: The transaction ID. example: '42782085' transactionBoxableId: type: - string description: The transaction boxable ID. example: '42782085' transactionBoxableType: type: - string description: The transaction boxable type. example: payment paymentId: type: - integer - 'null' description: The payment ID. example: 42782085 orderId: type: - string description: The order ID. example: E61BG8PJCXQ4-Fee eventSource: type: - string description: >- The system or process that triggered this transaction. example: Orders chargeBearer: type: - string - 'null' description: Indicates who bears the transaction charges. blockId: type: - string - 'null' description: >- The unique identifier for the block this transaction belongs to. example: '454' blockTag: type: - string - 'null' description: A tag used to group related blocked transactions. example: abd8d22e-d701-45c4-960a-d198e0e16a14 blockFriendlyId: type: - string - 'null' maxLength: 36 description: The customer-facing UUID identifier for the block. example: abd8d22e-d701-45c4-960a-d198e0e16a14 paymentType: type: - string - 'null' description: The payment scheme used for this transaction. example: UK.OBIE.BalanceTransfer creditDebitIndicator: type: - string - 'null' enum: - Debit - Credit description: The credit and debit indicator. example: Debit thirdPartyReference: type: - string - 'null' maxLength: 50 description: >- A reference provided by the third party system that initiated this transaction. example: abd8d22e-d701-45c4-960a-d198e0e16a14-FEE internalAccountTransferId: type: - string - 'null' description: The internal account transfer id. example: BR89 affectsLedgerBalance: type: - boolean - 'null' description: >- A boolean to indicate if the ledger balance is affected. example: false isCurrencyAlignment: type: - boolean - 'null' description: >- Indicates if this is a currency alignment transaction. example: false runningBalance: type: - string - 'null' description: The balance after this transaction was processed. example: '957.92' transactionReference: type: - string - 'null' description: The transaction reference. example: '' statementReference: type: - string - 'null' description: The statement reference. example: '' debtorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name creditorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name fx: type: - object - 'null' properties: sourceCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD sourceAmount: type: - string description: The source amount of the FX. example: '1.16' destinationCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD destinationAmount: type: - string description: The destination amount of the FX. example: '1.00' rate: type: - string description: The rate of the FX. example: '0.8621' required: - sourceCurrency - sourceAmount - destinationCurrency - destinationAmount - rate debitId: type: - number - 'null' description: >- The unique identifier for the debit leg of this transaction. example: 1097 creditId: type: - number - 'null' description: >- The unique identifier for the credit leg of this transaction. example: 1098 boxTransactionId: type: - number - 'null' description: >- The unique id of the transaction generated in boxes. example: 17098 budget: type: - object - 'null' properties: accountId: type: - string description: The ID of the account to work with. example: F50091 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 budgetName: type: - string - 'null' description: The name of the budget to work with. example: Account Balance boxId: type: - string - 'null' maxLength: 36 description: The ID of the box collection. example: 5426d2ca50 required: - accountId - budgetId - budgetName - boxId description: The budget details. type: type: - string - 'null' enum: - credit - debit - block - internalPayment description: The type of transaction. example: credit marqetaTransactionToken: type: - string - 'null' maxLength: 50 description: Unique identifier for the transaction in Marqeta. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 boxId: type: - string - 'null' maxLength: 36 description: Unique identifier for the Box. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 marqetaTransactionIdentifier: type: - string - 'null' description: >- Unique numerical identifier as string for the transaction in Marqeta. example: '940' directDebitId: type: - string - 'null' format: uuid maxLength: 36 description: >- The ID of the direct debit mandate associated with this transaction. amount: type: - number - 'null' description: The transaction amount in the specified currency. example: 20 currency: type: - string - 'null' enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD valueDateTime: type: - string - 'null' format: date-time description: The time and date of the Box. example: '2021-01-30T08:30:00Z' bankFeedTransactions: type: - array items: {} description: Array of bank feed transactions. transactionCreditorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name transactionDebtorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - budgetId - transactionId - transactionBoxableId - transactionBoxableType - paymentId - orderId - eventSource - chargeBearer - blockId - blockTag - blockFriendlyId - paymentType - creditDebitIndicator - thirdPartyReference - type - marqetaTransactionToken - boxId - marqetaTransactionIdentifier - amount - currency - valueDateTime - createdAt - updatedAt required: - id - accountId - createdAt - updatedAt - initiator - sourceGroupId - status - transactionDate - transactionGroupId - transactionType - type: - object properties: resourceType: default: bvnk type: - string enum: - bvnk description: >- Used to identify this particular type of Transaction. E.g. when it's part of the "activity" stream. example: bvnk id: type: - string description: The ID of the Transaction. example: d2366889-7513-4908-b2e1-d0b936d901b0 accountId: type: - string description: The ID of the account to work with. example: F50091 initiator: type: - object - 'null' properties: {} additionalProperties: true sourceGroupId: type: - string description: The source group ID. example: f7a8256e-f45b-4150-9a70-64918dea2792 status: type: - string enum: - needsApproval - fundsRequired - pending - complete - declined - reverted - refunded - cancelled - open - cardCheck - fundsSettled description: >- The status of the Payment. Currently always the same as the parent Order status. example: orderCancelled transactionDate: type: - string format: date-time description: >- The date of the transaction. ISO 8601 format without milliseconds. example: '2023-01-30T11:12:15.000Z' transactionGroup: type: - object properties: id: type: - string description: The ID of the transaction group example: 34edaf73-49be-4669-83ee-1b1f8c680d26 accountId: type: - string description: The ID of the account to work with. example: F50091 personId: type: - string - 'null' format: uuid maxLength: 36 description: The ID of the person to work with. example: 775596ae-2624-40af-a9dc-9756110a4a04 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 firstName: type: - string - 'null' description: The firstname of the user example: Jane lastName: type: - string - 'null' description: The lastname of the user example: Doe budgetName: type: - string description: The name of the budget example: companyBalance createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. annotationGroup: type: - object - 'null' properties: id: type: - string format: uuid description: The id of the Annotation Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 transactionGroupId: type: - string - 'null' format: uuid description: The id of the Transaction Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: type: - number - 'null' description: The id of the Payment example: 1234 status: type: - string enum: - approved - draft - exported - submitted description: The status of the Annotation Group example: draft annotations: type: - array items: type: - object properties: id: type: - string format: uuid description: The id of the Annotation example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 annotationGroupId: type: - string format: uuid description: The id of the Annotation Group example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 amount: type: - number description: The amount of the Annotation example: 100 annotationValues: type: - array items: {} description: >- Array of annotationValue objects (see annotationValue.dto). Each contains the annotation field id plus resolved field metadata (annotationFieldTitle, annotationFieldType) and one populated typed value (booleanValue | textValue | unsignedIntegerValue | decimalValue | uuidValue). Dropdown values additionally resolve dropdownValue and dropdownCode. createdBy: type: - string - 'null' format: uuid description: ID of the User who created the resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: type: - string - 'null' format: uuid description: >- ID of the User who lastly modified the resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - annotationGroupId - accountId - amount - annotationValues - createdBy - updatedBy - createdAt - updatedAt description: An array of annotations createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - transactionGroupId - paymentId - status - annotations attachment: type: - object - 'null' properties: id: type: - string format: uuid description: The id of the Attachment example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 isLost: type: - boolean description: >- Indicates whether the attachment corresponding to this transaction has been lost. example: false note: type: - string - 'null' maxLength: 280 description: >- Free text field where to state reason why the attachment was lost. example: >- I did not lose the file to attach so I do not need to fill in this field. transactionGroupId: type: - string - 'null' format: uuid description: >- The id of the transaction thats associated to this attachment example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: type: - number - 'null' description: >- The id of the transaction thats associated to this attachment example: 1234 count: type: - integer minimum: 0 maximum: 255 description: >- This points to the last attachment file. It's used internally to name files. example: 2 attachmentFiles: type: - array items: type: - object properties: id: type: - string format: uuid description: The id of the Attachment File example: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: type: - string description: The ID of the account to work with. example: F50091 attachmentId: type: - string format: uuid description: >- The ID of the Attachment to which this Attachment File belongs example: c32ba075-f6e9-45db-aae8-a8f1aeaa14b3 productId: type: - string format: uuid maxLength: 36 description: The ID of the product to work with. example: 3ef24d53-6e22-4103-a16b-d268e4f7346d fileName: type: - string maxLength: 256 description: >- The name of the file corresponding to this attachment file. example: >- 2021-09-01T13:04:57Z_288946aa-0469-4518-a962-40e9be858d1e_2.pdf year: type: - string maxLength: 4 minLength: 4 pattern: ^\d+$ description: >- The year of the Transaction Group of this Attachment. example: '2021' month: type: - string maxLength: 2 minLength: 1 pattern: ^\d+$ description: >- The month of the Transaction Group of this Attachment. example: '9' file: oneOf: - default: true type: - boolean - 'null' description: Boolean indicating if file exists. - type: - object properties: url: type: - string - 'null' description: >- The url from where this file can be visualised or downloaded. Will be null if the file is no longer available. example: >- http://127.0.0.1:8080/v1/transactions-api/accounts/F50091/transactions/group/288946aa-0469-4518-a962-40e9be858d1e/attachment/files/8ae07ba6-d2b0-4665-9158-2f33d0852a4f unavailable: type: - boolean - 'null' description: >- Indicates if the file is no longer available. required: - url - unavailable description: Contains the file url to retrieve it. type: type: - string - 'null' enum: - heic - pdf - jpg - jpeg - png description: The file type. example: pdf createdBy: type: - string format: uuid description: >- ID of the User who lastly modified a resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: type: - string format: uuid description: >- ID of the User who lastly modified a resource. example: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - attachmentId - productId - fileName - year - month - type - createdBy - updatedBy - createdAt - updatedAt description: All the files attached to this Attachment createdAt: type: - string - 'null' format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string - 'null' format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - isLost - note - transactionGroupId - paymentId - count - attachmentFiles bankFeedTransactions: type: - array items: {} description: Array of bank feed transactions. totals: type: - object properties: authorised: type: - number description: Total authorised amount settled: type: - number description: Total settled amount description: Transaction totals required: - id - accountId - personId - budgetId - firstName - lastName - budgetName - createdAt - updatedAt transactionGroupId: type: - string description: The transaction group ID. example: 16eda44f-a2a3-49bf-8d26-0c2b66211586 transactionType: type: - string description: The transaction type. example: Bvnk transactionBox: type: - object - 'null' properties: id: type: - string description: The ID of the transaction box. example: 2af0e603-0c72-4a7c-8020-52916d7a9960 accountId: type: - string description: The ID of the account to work with. example: F50091 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 transactionId: type: - string - 'null' description: The transaction ID. example: '42782085' transactionBoxableId: type: - string description: The transaction boxable ID. example: '42782085' transactionBoxableType: type: - string description: The transaction boxable type. example: payment paymentId: type: - integer - 'null' description: The payment ID. example: 42782085 orderId: type: - string description: The order ID. example: E61BG8PJCXQ4-Fee eventSource: type: - string description: >- The system or process that triggered this transaction. example: Orders chargeBearer: type: - string - 'null' description: Indicates who bears the transaction charges. blockId: type: - string - 'null' description: >- The unique identifier for the block this transaction belongs to. example: '454' blockTag: type: - string - 'null' description: A tag used to group related blocked transactions. example: abd8d22e-d701-45c4-960a-d198e0e16a14 blockFriendlyId: type: - string - 'null' maxLength: 36 description: The customer-facing UUID identifier for the block. example: abd8d22e-d701-45c4-960a-d198e0e16a14 paymentType: type: - string - 'null' description: The payment scheme used for this transaction. example: UK.OBIE.BalanceTransfer creditDebitIndicator: type: - string - 'null' enum: - Debit - Credit description: The credit and debit indicator. example: Debit thirdPartyReference: type: - string - 'null' maxLength: 50 description: >- A reference provided by the third party system that initiated this transaction. example: abd8d22e-d701-45c4-960a-d198e0e16a14-FEE internalAccountTransferId: type: - string - 'null' description: The internal account transfer id. example: BR89 affectsLedgerBalance: type: - boolean - 'null' description: >- A boolean to indicate if the ledger balance is affected. example: false isCurrencyAlignment: type: - boolean - 'null' description: >- Indicates if this is a currency alignment transaction. example: false runningBalance: type: - string - 'null' description: The balance after this transaction was processed. example: '957.92' transactionReference: type: - string - 'null' description: The transaction reference. example: '' statementReference: type: - string - 'null' description: The statement reference. example: '' debtorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name creditorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name fx: type: - object - 'null' properties: sourceCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD sourceAmount: type: - string description: The source amount of the FX. example: '1.16' destinationCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD destinationAmount: type: - string description: The destination amount of the FX. example: '1.00' rate: type: - string description: The rate of the FX. example: '0.8621' required: - sourceCurrency - sourceAmount - destinationCurrency - destinationAmount - rate debitId: type: - number - 'null' description: >- The unique identifier for the debit leg of this transaction. example: 1097 creditId: type: - number - 'null' description: >- The unique identifier for the credit leg of this transaction. example: 1098 boxTransactionId: type: - number - 'null' description: >- The unique id of the transaction generated in boxes. example: 17098 budget: type: - object - 'null' properties: accountId: type: - string description: The ID of the account to work with. example: F50091 budgetId: type: - string format: uuid maxLength: 36 description: The ID of the budget to work with. example: 775596ae-2624-40af-a9dc-9756110a4a03 budgetName: type: - string - 'null' description: The name of the budget to work with. example: Account Balance boxId: type: - string - 'null' maxLength: 36 description: The ID of the box collection. example: 5426d2ca50 required: - accountId - budgetId - budgetName - boxId description: The budget details. type: type: - string - 'null' enum: - credit - debit - block - internalPayment description: The type of transaction. example: credit marqetaTransactionToken: type: - string - 'null' maxLength: 50 description: Unique identifier for the transaction in Marqeta. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 boxId: type: - string - 'null' maxLength: 36 description: Unique identifier for the Box. example: 34edaf73-49be-4669-83ee-1b1f8c680d26 marqetaTransactionIdentifier: type: - string - 'null' description: >- Unique numerical identifier as string for the transaction in Marqeta. example: '940' directDebitId: type: - string - 'null' format: uuid maxLength: 36 description: >- The ID of the direct debit mandate associated with this transaction. amount: type: - number - 'null' description: The transaction amount in the specified currency. example: 20 currency: type: - string - 'null' enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD valueDateTime: type: - string - 'null' format: date-time description: The time and date of the Box. example: '2021-01-30T08:30:00Z' bankFeedTransactions: type: - array items: {} description: Array of bank feed transactions. transactionCreditorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name transactionDebtorAccount: type: - object - 'null' properties: id: type: - string description: The ID of the account. example: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: type: - string - 'null' maxLength: 36 description: The owner ID. example: d6061bbee6 accountId: type: - string - 'null' description: The ID of the account to work with. example: F50091 schemeName: type: - string - 'null' description: The scheme name. example: UK.OBIE.SortCodeAccountNumber identification: type: - string - 'null' description: The identification. example: '23188474064478' name: type: - string - 'null' description: The name. example: Joe Bloggs 202106171735 address: type: - string description: The address. example: 21 test street institutionAddress: type: - string description: The institution address. example: 29 test street institutionBic: type: - string description: The institution BIC. example: '1' institutionName: type: - string description: The institution name. example: Test Name transactionBoxId: type: - string description: The transaction box ID. example: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef required: - ownerId - accountId - schemeName - identification - name createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - budgetId - transactionId - transactionBoxableId - transactionBoxableType - paymentId - orderId - eventSource - chargeBearer - blockId - blockTag - blockFriendlyId - paymentType - creditDebitIndicator - thirdPartyReference - type - marqetaTransactionToken - boxId - marqetaTransactionIdentifier - amount - currency - valueDateTime - createdAt - updatedAt bvnkTransaction: type: - object properties: id: type: - string description: The ID of the bvnk transaction. example: a020b6ff-6394-4abb-8dcb-abb131d6a650 externalId: type: - string description: The external ID of the bvnk transaction. example: 0f26ca68-ec91-41d1-977c-b2b7d5f4365b type: type: - string description: The type of the bvnk transaction. example: credit status: type: - string description: The status of the bvnk transaction. example: complete chargedAmount: type: - number description: The amount charged in the charged currency. example: 335.26 chargedCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD chargedTotalAmount: type: - number description: The total amount charged including all fees. example: 335.26 localAmount: type: - number description: >- The amount in the local currency where the transaction occurred. example: 100 localCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD settlementAmount: type: - number description: >- The amount that will be settled after currency conversion. example: 99 settlementCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD networkFeeAmount: type: - number description: The fee charged by the payment network. example: 0.05 networkFeeCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD partnerFeeAmount: type: - number description: The fee charged by the partner provider. example: 0.1 partnerFeeCurrency: type: - string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHN - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XAG - XAU - XCD - XOF - XPD - XPF - XPT - YER - ZAR - ZMK - ZMW - ZWD example: USD exchangeRate: type: - number description: The exchange rate. example: 1 exchangeRateInverse: type: - number description: The inverse exchange rate. example: 1 runningBalance: type: - string description: The balance after this transaction was processed. example: '2000.49' transactionAt: type: - string format: date-time description: The date and time when the transaction occurred. example: '2023-01-30T11:12:15.000Z' updatedAtBoxTransaction: type: - string description: The update date for box transaction. example: '2025-10-13T20:36:26.000Z' createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - externalId - type - status - chargedAmount - chargedCurrency - chargedTotalAmount - localAmount - localCurrency - settlementAmount - settlementCurrency - networkFeeAmount - networkFeeCurrency - partnerFeeAmount - partnerFeeCurrency - exchangeRate - exchangeRateInverse - runningBalance - transactionAt - updatedAtBoxTransaction - createdAt - updatedAt description: The bvnk transaction details. createdAt: type: - string format: date-time description: >- The date the Resource was initially created. ISO 8601 format without milliseconds. updatedAt: type: - string format: date-time description: >- The date the Resource was last modified. ISO 8601 format without milliseconds. required: - id - accountId - initiator - sourceGroupId - status - transactionDate - transactionGroupId - transactionType - bvnkTransaction - createdAt - updatedAt examples: Variant1: value: resourceType: payment id: 42782085 orderId: 1380 userId: 34edaf73-49be-4669-83ee-1b1f8c680d26 companyId: F50072 originId: 9a623439-8275-4230-a157-6c623a2ea7b8 originOrderId: EKOBEPVFJ budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 status: orderCancelled isMultiBeneficiary: true budget: companyBalance beneficiaryId: ben90944601 beneficiaryName: Nichole Grant beneficiaryAddress: 46315 Bailey MillSouth CamilleNiue beneficiaryAccountNumber: '10387899' beneficiarySortCode: 12-34-56 beneficiaryIban: PT72105510150936500020992 beneficiaryBankCode: QHKEMKK1 beneficiaryBankAddress: 883 Bernie MountainNew EstachesterVietnam beneficiaryCountryCode: GB beneficiaryRoutingInfo: >- Payment will be routed from Barclays Bank and then through Lloyds bank remitterName: Joseph Bloggs reference: >- withdrawal transaction at Osinski, Zboncak and Bayer using card ending with ***3963 for IDR 670.50 in account ***32418758 amount: 773.08 currency: USD sellCurrency: USD buyCurrency: USD settlementAmount: 33920.34 settlementFee: 1.34 settlementAmountWithoutFee: 33920.34 customerRate: 0.8637052 customerInverseRate: 0.71942446043 confirmationKey: F36555/pdf/F36555-000265963.pdf uniqueId: 69e4a1e8-db35-4301-b5a8-67a2cb063609 type: exchange order: id: 1380 companyId: F50072 events: - null originId: 9a623439-8275-4230-a157-6c623a2ea7b8 status: complete type: payment userId: 34edaf73-49be-4669-83ee-1b1f8c680d26 userName: John Doe lastSourceEventDatetime: '2019-08-24T14:15:22Z' orderSource: string parentOriginId: string settlementDate: string initiator: John Doe createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' metadata: '{ paymentsCount: 1 }' deleted: true budgetName: string transactionGroupId: 1c0547bd-30e6-4d14-b82e-78cd128fbfd9 transactionBoxes: - id: 2af0e603-0c72-4a7c-8020-52916d7a9960 accountId: F50091 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 transactionId: '42782085' transactionBoxableId: '42782085' transactionBoxableType: payment paymentId: 42782085 orderId: E61BG8PJCXQ4-Fee eventSource: Orders chargeBearer: string blockId: '454' blockTag: abd8d22e-d701-45c4-960a-d198e0e16a14 blockFriendlyId: abd8d22e-d701-45c4-960a-d198e0e16a14 paymentType: UK.OBIE.BalanceTransfer creditDebitIndicator: Debit thirdPartyReference: abd8d22e-d701-45c4-960a-d198e0e16a14-FEE internalAccountTransferId: BR89 affectsLedgerBalance: false isCurrencyAlignment: false runningBalance: '957.92' transactionReference: '' statementReference: '' debtorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef creditorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef fx: sourceCurrency: USD sourceAmount: '1.16' destinationCurrency: USD destinationAmount: '1.00' rate: '0.8621' debitId: 1097 creditId: 1098 boxTransactionId: 17098 budget: accountId: F50091 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 budgetName: Account Balance boxId: 5426d2ca50 type: credit marqetaTransactionToken: 34edaf73-49be-4669-83ee-1b1f8c680d26 boxId: 34edaf73-49be-4669-83ee-1b1f8c680d26 marqetaTransactionIdentifier: '940' directDebitId: 5f8cc678-7836-4c1d-9013-e247f3a50a84 amount: 20 currency: USD valueDateTime: '2021-01-30T08:30:00Z' bankFeedTransactions: - null transactionCreditorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef transactionDebtorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' annotationGroup: id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 transactionGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: 1234 status: draft annotations: - id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 annotationGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 amount: 100 annotationValues: - null createdBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' attachment: id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 isLost: false note: >- I did not lose the file to attach so I do not need to fill in this field. transactionGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: 1234 count: 2 attachmentFiles: - id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 attachmentId: c32ba075-f6e9-45db-aae8-a8f1aeaa14b3 productId: 3ef24d53-6e22-4103-a16b-d268e4f7346d fileName: >- 2021-09-01T13:04:57Z_288946aa-0469-4518-a962-40e9be858d1e_2.pdf year: '2021' month: '9' file: true type: pdf createdBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' forwardDetails: payments: - null events: - null currencyPurchases: - null deposits: - null drawdowns: - null teams: string createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' Variant2: value: resourceType: card id: 87c87d2d-a895-4e7e-a522-5f9950b98b71 accountId: F50091 transactionDate: '2021-01-30T08:30:00Z' cardTransaction: id: 6fcae7ba-e64d-470d-9089-54cb379d69f9 identifier: '940' localAmount: '33920.34' localAmountCurrency: USD feeAmount: '33920.34' feeCurrency: USD exchangeRate: '0.7812346' exchangeRateInverse: '1.2800252' total: '34920.34' cardId: 34edaf73-49be-4669-83ee-1b1f8c680d26 cardProductToken: d6ee9cb4-f3c7-4217-b0bc-1c2ac37ee78d cardType: PHYSICAL_MSR cardLastDigits: '1234' status: pending type: card approvalCode: '1234' acquirerInstitutionIdCode: '014979' acquirerReferenceNumber: arn1665069145275 cardName: Test card chargedAmount: 100 chargedTotalAmount: 110 chargedCurrency: USD baseCurrency: GBP paymentChannel: ECOMMERCE pos: cardDataInputCapability: UNKNOWN cardHolderPresence: true cardPresence: true cardholderAuthenticationMethod: PIN precedingRelatedTransactionToken: 5df33953-63a6-4124-a3cb-f8c898f36b96 runningBalance: '2000.49' settlementAmount: 100.5 settlementAmountCurrency: GBP transactionId: d3c69842-838a-45cd-9ae3-c53a46b3aa75 transactionType: authorization response: code: '1922' memo: Transaction cannot be completed transactionCompletedAt: '2021-01-30T08:30:00Z' transactionCreatedAt: '2021-01-30T08:30:00Z' transactionToken: 34edaf73-49be-4669-83ee-1b1f8c680d26 boxesResponse: pass updatedAtBoxTransaction: '2021-01-30T08:30:00Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' transactionGroup: id: 34edaf73-49be-4669-83ee-1b1f8c680d26 accountId: F50091 personId: 775596ae-2624-40af-a9dc-9756110a4a04 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 firstName: Jane lastName: Doe budgetName: companyBalance createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' annotationGroup: id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 transactionGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: 1234 status: draft annotations: - id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 annotationGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 amount: 100 annotationValues: - null createdBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' attachment: id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 isLost: false note: >- I did not lose the file to attach so I do not need to fill in this field. transactionGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: 1234 count: 2 attachmentFiles: - id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 attachmentId: c32ba075-f6e9-45db-aae8-a8f1aeaa14b3 productId: 3ef24d53-6e22-4103-a16b-d268e4f7346d fileName: >- 2021-09-01T13:04:57Z_288946aa-0469-4518-a962-40e9be858d1e_2.pdf year: '2021' month: '9' file: true type: pdf createdBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' bankFeedTransactions: - null totals: authorised: 0 settled: 0 transactionBox: id: 2af0e603-0c72-4a7c-8020-52916d7a9960 accountId: F50091 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 transactionId: '42782085' transactionBoxableId: '42782085' transactionBoxableType: payment paymentId: 42782085 orderId: E61BG8PJCXQ4-Fee eventSource: Orders chargeBearer: string blockId: '454' blockTag: abd8d22e-d701-45c4-960a-d198e0e16a14 blockFriendlyId: abd8d22e-d701-45c4-960a-d198e0e16a14 paymentType: UK.OBIE.BalanceTransfer creditDebitIndicator: Debit thirdPartyReference: abd8d22e-d701-45c4-960a-d198e0e16a14-FEE internalAccountTransferId: BR89 affectsLedgerBalance: false isCurrencyAlignment: false runningBalance: '957.92' transactionReference: '' statementReference: '' debtorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef creditorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef fx: sourceCurrency: USD sourceAmount: '1.16' destinationCurrency: USD destinationAmount: '1.00' rate: '0.8621' debitId: 1097 creditId: 1098 boxTransactionId: 17098 budget: accountId: F50091 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 budgetName: Account Balance boxId: 5426d2ca50 type: credit marqetaTransactionToken: 34edaf73-49be-4669-83ee-1b1f8c680d26 boxId: 34edaf73-49be-4669-83ee-1b1f8c680d26 marqetaTransactionIdentifier: '940' directDebitId: 5f8cc678-7836-4c1d-9013-e247f3a50a84 amount: 20 currency: USD valueDateTime: '2021-01-30T08:30:00Z' bankFeedTransactions: - null transactionCreditorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef transactionDebtorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' merchant: id: fed3437e-4f44-472c-b018-063eec393e3e name: Jane Doe description: Information about merchant address: 1 building city: Twickenham state: CA postalCode: TW3121 countryCode: USA merchantCategoryId: 1234 - Finance mid: '11111' subMerchantId: '11111' website: https://equalsmoney.com emoji: Test Merchant logo: Test Merchant notes: Test Merchant originalName: original Merchant Name merchantCategory: id: 440961a1-71d4-4b6d-a5c1-07fa6ddf2ee0 code: f1111 description: Test Merchant Category createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' paymentChannel: ECOMMERCE status: orderCancelled sourceGroupId: 8a2231ed-cfef-454b-bb34-e67a7a71c8e8 transactionGroupId: 1c0547bd-30e6-4d14-b82e-78cd128fbfd9 transactionType: Marqeta initiator: {} createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' Variant3: value: resourceType: currencyPurchase id: 1844 userId: 34edaf73-49be-4669-83ee-1b1f8c680d26 companyId: F50072 originOrderId: EKOBEPVFJ status: orderCancelled sellCurrency: USD buyAmount: 33920.34 buyCurrency: USD settlementAmountWithoutFee: 33920.34 settlementAmount: 33920.34 settlementFee: 1.34 settlementDate: '2021-03-30' remainingBalance: 22003.34 depositPercentage: 10 depositAmountRequired: 100.32 depositSettlementDate: '2021-03-30' customerSpread: '0.01' customerRate: 0.8637052 customerInverseRate: 0.71942446043 confirmationKey: F36555/pdf/F36555-000265963.pdf budget: companyBalance type: exchange fundsSource: balance fundsDestination: balance bankEntity: BARC orderId: 1428 order: id: 1380 companyId: F50072 events: - null originId: 9a623439-8275-4230-a157-6c623a2ea7b8 status: complete type: payment userId: 34edaf73-49be-4669-83ee-1b1f8c680d26 userName: John Doe lastSourceEventDatetime: '2019-08-24T14:15:22Z' orderSource: string parentOriginId: string settlementDate: string initiator: John Doe createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' metadata: '{ paymentsCount: 1 }' depositCurrency: USD depositStatus: complete fundsRequired: 100 forwardDetails: payments: - null events: - null currencyPurchases: - null deposits: - null drawdowns: - null createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' Variant4: value: resourceType: box id: a2438691-5300-4aef-b299-93c28f678a4d accountId: F50091 createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' initiator: {} sourceGroupId: d4a1e2d8-d21f-47b0-8e7d-1d01d163d523 status: orderCancelled transactionDate: '2023-01-30T11:12:15.000Z' transactionGroup: id: 34edaf73-49be-4669-83ee-1b1f8c680d26 accountId: F50091 personId: 775596ae-2624-40af-a9dc-9756110a4a04 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 firstName: Jane lastName: Doe budgetName: companyBalance createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' annotationGroup: id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 transactionGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: 1234 status: draft annotations: - id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 annotationGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 amount: 100 annotationValues: - null createdBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' attachment: id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 isLost: false note: >- I did not lose the file to attach so I do not need to fill in this field. transactionGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: 1234 count: 2 attachmentFiles: - id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 attachmentId: c32ba075-f6e9-45db-aae8-a8f1aeaa14b3 productId: 3ef24d53-6e22-4103-a16b-d268e4f7346d fileName: >- 2021-09-01T13:04:57Z_288946aa-0469-4518-a962-40e9be858d1e_2.pdf year: '2021' month: '9' file: true type: pdf createdBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' bankFeedTransactions: - null totals: authorised: 0 settled: 0 transactionGroupId: 0163e923-11d0-4a3d-ba79-ad8ef1dc4675 transactionType: Boxes transactionBox: id: 2af0e603-0c72-4a7c-8020-52916d7a9960 accountId: F50091 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 transactionId: '42782085' transactionBoxableId: '42782085' transactionBoxableType: payment paymentId: 42782085 orderId: E61BG8PJCXQ4-Fee eventSource: Orders chargeBearer: string blockId: '454' blockTag: abd8d22e-d701-45c4-960a-d198e0e16a14 blockFriendlyId: abd8d22e-d701-45c4-960a-d198e0e16a14 paymentType: UK.OBIE.BalanceTransfer creditDebitIndicator: Debit thirdPartyReference: abd8d22e-d701-45c4-960a-d198e0e16a14-FEE internalAccountTransferId: BR89 affectsLedgerBalance: false isCurrencyAlignment: false runningBalance: '957.92' transactionReference: '' statementReference: '' debtorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef creditorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef fx: sourceCurrency: USD sourceAmount: '1.16' destinationCurrency: USD destinationAmount: '1.00' rate: '0.8621' debitId: 1097 creditId: 1098 boxTransactionId: 17098 budget: accountId: F50091 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 budgetName: Account Balance boxId: 5426d2ca50 type: credit marqetaTransactionToken: 34edaf73-49be-4669-83ee-1b1f8c680d26 boxId: 34edaf73-49be-4669-83ee-1b1f8c680d26 marqetaTransactionIdentifier: '940' directDebitId: 5f8cc678-7836-4c1d-9013-e247f3a50a84 amount: 20 currency: USD valueDateTime: '2021-01-30T08:30:00Z' bankFeedTransactions: - null transactionCreditorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef transactionDebtorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' Variant5: value: resourceType: bvnk id: d2366889-7513-4908-b2e1-d0b936d901b0 accountId: F50091 initiator: {} sourceGroupId: f7a8256e-f45b-4150-9a70-64918dea2792 status: orderCancelled transactionDate: '2023-01-30T11:12:15.000Z' transactionGroup: id: 34edaf73-49be-4669-83ee-1b1f8c680d26 accountId: F50091 personId: 775596ae-2624-40af-a9dc-9756110a4a04 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 firstName: Jane lastName: Doe budgetName: companyBalance createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' annotationGroup: id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 transactionGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: 1234 status: draft annotations: - id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 annotationGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 amount: 100 annotationValues: - null createdBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' attachment: id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 isLost: false note: >- I did not lose the file to attach so I do not need to fill in this field. transactionGroupId: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 paymentId: 1234 count: 2 attachmentFiles: - id: c32ba075-f6e9-45db-aae8-a8f1aeaa13b6 accountId: F50091 attachmentId: c32ba075-f6e9-45db-aae8-a8f1aeaa14b3 productId: 3ef24d53-6e22-4103-a16b-d268e4f7346d fileName: >- 2021-09-01T13:04:57Z_288946aa-0469-4518-a962-40e9be858d1e_2.pdf year: '2021' month: '9' file: true type: pdf createdBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 updatedBy: f7aa80c9-4d4a-4a52-8ae2-b73638b3f2d8 createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' bankFeedTransactions: - null totals: authorised: 0 settled: 0 transactionGroupId: 16eda44f-a2a3-49bf-8d26-0c2b66211586 transactionType: Bvnk transactionBox: id: 2af0e603-0c72-4a7c-8020-52916d7a9960 accountId: F50091 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 transactionId: '42782085' transactionBoxableId: '42782085' transactionBoxableType: payment paymentId: 42782085 orderId: E61BG8PJCXQ4-Fee eventSource: Orders chargeBearer: string blockId: '454' blockTag: abd8d22e-d701-45c4-960a-d198e0e16a14 blockFriendlyId: abd8d22e-d701-45c4-960a-d198e0e16a14 paymentType: UK.OBIE.BalanceTransfer creditDebitIndicator: Debit thirdPartyReference: abd8d22e-d701-45c4-960a-d198e0e16a14-FEE internalAccountTransferId: BR89 affectsLedgerBalance: false isCurrencyAlignment: false runningBalance: '957.92' transactionReference: '' statementReference: '' debtorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef creditorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef fx: sourceCurrency: USD sourceAmount: '1.16' destinationCurrency: USD destinationAmount: '1.00' rate: '0.8621' debitId: 1097 creditId: 1098 boxTransactionId: 17098 budget: accountId: F50091 budgetId: 775596ae-2624-40af-a9dc-9756110a4a03 budgetName: Account Balance boxId: 5426d2ca50 type: credit marqetaTransactionToken: 34edaf73-49be-4669-83ee-1b1f8c680d26 boxId: 34edaf73-49be-4669-83ee-1b1f8c680d26 marqetaTransactionIdentifier: '940' directDebitId: 5f8cc678-7836-4c1d-9013-e247f3a50a84 amount: 20 currency: USD valueDateTime: '2021-01-30T08:30:00Z' bankFeedTransactions: - null transactionCreditorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef transactionDebtorAccount: id: ed8388b1-4d01-41e7-a04a-2be9a56adb68 ownerId: d6061bbee6 accountId: F50091 schemeName: UK.OBIE.SortCodeAccountNumber identification: '23188474064478' name: Joe Bloggs 202106171735 address: 21 test street institutionAddress: 29 test street institutionBic: '1' institutionName: Test Name transactionBoxId: 1ee51a67-d6ba-480e-9686-f2fadb1fa1ef createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' bvnkTransaction: id: a020b6ff-6394-4abb-8dcb-abb131d6a650 externalId: 0f26ca68-ec91-41d1-977c-b2b7d5f4365b type: credit status: complete chargedAmount: 335.26 chargedCurrency: USD chargedTotalAmount: 335.26 localAmount: 100 localCurrency: USD settlementAmount: 99 settlementCurrency: USD networkFeeAmount: 0.05 networkFeeCurrency: USD partnerFeeAmount: 0.1 partnerFeeCurrency: USD exchangeRate: 1 exchangeRateInverse: 1 runningBalance: '2000.49' transactionAt: '2023-01-30T11:12:15.000Z' updatedAtBoxTransaction: '2025-10-13T20:36:26.000Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' createdAt: '2019-08-24T14:15:22Z' updatedAt: '2019-08-24T14:15:22Z' security: - CommonAuth: - activities:read:any - activities:read:own - transactions:transactions:read:any - transactions:transactions:read:own - transactions:transactions:read x-codeSamples: - lang: Shell label: cURL source: |- curl --request GET \ --url 'https://api.equalsmoney.com/v2/activity/{type}/{id}?accountId={{accountId}}' \ --header 'Authorization: ' components: securitySchemes: CommonAuth: type: apiKey in: header name: Authorization ````