View single transaction details - Equals Documentation

Get a single transaction

GET /v2/activity/{type}/{id}

Request

Use this request to get a single transaction for a given account, type, and ID. This endpoint allows you to retrieve a specific transaction by its ID and type.

Sample request

curl -i -X GET \
  'https://api.equalsmoney.com/v2/activity/payment/123456?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Request structure

curl -i -X GET \
  'https://api.equalsmoney.com/v2/activity/{type}/{id}?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Path parameters

string

required

The type of activity to retrieve.Allowable values: transaction, payment, order, boxTransaction Note: When using type=transaction, the API automatically determines the transaction subtype based on the transaction ID. It can return card transactions (Marqeta), BVNK transactions, or credit/debit transactions (Boxes) depending on the transaction’s transactionType.

string

required

The ID of the activity to retrieve. The ID format depends on the type: - For transaction: use the transactionId (UUID). The API will determine if it’s a card, BVNK, or credit/debit transaction based on the transaction’s type. - For payment: use the paymentId (integer) - For order: use the originOrderId (string, e.g., F6VOXCZ1AMND) - For boxTransaction: use the transactionBox.id (UUID)Allowable values: An existing ID for the specified type

Query parameters

string

required

The ID of the account that the transaction belongs to.Allowable values: An existing accountId

array of strings

Optional additional information to return in the results.Allowable values: bankFeedDetails, annotations, attachments, paymentFiles

array of strings (uuid)

The ID of the person to work with. Use commas to pass multiple values. Has to be URL encoded.Allowable values: An existing personId in UUID format (e.g., 34edaf73-49be-4669-83ee-1b1f8c680d29)

Response

If your request is successful, you’ll receive a 200 response containing a single transaction object.

Sample response (payment)

{
  "budget": "companyBalance",
  "resourceType": "payment",
  "id": 123456,
  "orderId": 654321,
  "userId": "4bf13dc8-d128-4521-99b8-4002b8987499",
  "originId": "0684fc07-4abc-46de-b664-da45ef3c4072",
  "originOrderId": "F6VOXCZ1AMND",
  "companyId": "F12345",
  "status": "complete",
  "transactionGroupId": null,
  "isMultiBeneficiary": false,
  "remitterName": null,
  "beneficiaryId": "7l2nks3eh",
  "beneficiaryName": "William Walker",
  "beneficiaryAddress": "68 Upper Thames St",
  "beneficiaryAccountNumber": "12345678",
  "beneficiarySortCode": "123456",
  "beneficiaryIban": "",
  "beneficiaryBankCode": "",
  "beneficiaryCountryCode": "GB",
  "beneficiaryBankAddress": "UPPER THAMES STREET, 68 VINTNERS PLACE FAIRFX FLOOR 3 LONDON EC4V 3BJ",
  "beneficiaryRoutingInfo": "Payment will be routed from Bank of England and then through Lloyds bank",
  "reference": "Invoice 3468 payment",
  "amount": 99.99,
  "currency": "GBP",
  "buyCurrency": "GBP",
  "sellCurrency": "GBP",
  "settlementAmountWithoutFee": 99.99,
  "settlementAmount": 99.99,
  "settlementFee": 0,
  "customerRate": 1,
  "customerInverseRate": 1,
  "uniqueId": "8233f929-94d3-4390-8d27-da92b733cafb",
  "confirmationKey": "F12345/pdf/F12345-F6VOXCZ1AMND.pdf",
  "type": "payment",
  "budgetId": "63f4b801-70d6-4bba-b3f3-7b9acd051633",
  "budgetName": "Account balance",
  "createdAt": "2022-11-14T10:55:28.000Z",
  "updatedAt": "2022-11-14T10:55:30.000Z",
  "order": {
    "id": 654321,
    "orderSource": "legacy",
    "companyId": "F12345",
    "originId": "F6VOXCZ1AMND",
    "parentOriginId": null,
    "userId": "d4fd55fe-836d-48d2-8d49-e5629bd508a6",
    "userName": "John Doe",
    "status": "complete",
    "type": "payment",
    "lastSourceEventDatetime": null,
    "createdAt": "2022-11-14T10:55:28.000Z",
    "updatedAt": "2022-11-14T10:55:30.000Z",
    "settlementDate": null,
    "events": [
      {
        "id": "beec0eb3-3e11-44a4-86de-65404510038a",
        "eventId": "4c191b59-685b-454b-bad7-e832505ee51c",
        "orderCreatedAt": "2022-11-14T10:55:28.000Z",
        "eventType": 0,
        "orderId": 654321,
        "title": "Order created",
        "description": "Payment to William Walker created",
        "createdAt": "2022-11-14T10:55:28.000Z",
        "referencedOriginOrderId": null
      }
    ]
  },
  "transactionBoxes": []
}

The response structure varies depending on the transaction type. For card transactions (resourceType: "card"), the response includes cardTransaction and merchant objects. For box transactions (resourceType: "box"), the response includes transaction box details. See the example responses below for complete structures for each type.

Examples

Get a payment transaction

Retrieve a payment transaction using the payment ID. Payment IDs are integers.

curl -i -X GET \
  'https://api.equalsmoney.com/v2/activity/payment/123456?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

This returns a payment transaction with details like beneficiary information, amount, currency, and order details.

Get a transaction by transaction ID

Retrieve a transaction using the transaction ID (UUID format). The API automatically determines the transaction type based on the transaction’s transactionType field. This can return:

Card transactions (transactionType: "Marqeta") - Returns resourceType: "card" with card transaction details, merchant information, and transaction group data
BVNK transactions (transactionType: "Bvnk") - Returns BVNK transaction details with transaction group and box transaction data
Credit/debit transactions (transactionType: "Boxes") - Returns credit/debit transaction details with transaction box information

curl -i -X GET \
  'https://api.equalsmoney.com/v2/activity/transaction/19bbf64b-ddfb-48ee-b125-66ed4455d534?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Example: Card transaction response - Returns a card transaction with details like merchant information, card details, local amount, and transaction status. Example: BVNK transaction response - Returns a BVNK transaction with details like remitter name, settlement amounts, and transaction group information. Example: Credit/debit transaction response - Returns a credit/debit transaction with transaction box details, creditor/debtor account information, and payment type.

Get an order by origin order ID

Retrieve an order transaction using the origin order ID (string format like F6VOXCZ1AMND). This returns the payment transaction associated with the specified order ID.

curl -i -X GET \
  'https://api.equalsmoney.com/v2/activity/order/F6VOXCZ1AMND?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

This returns a payment transaction (resourceType: "payment") that contains the order details, payment information, beneficiary details, and order events.

Get a box transaction

Retrieve a box transaction (internal account movement) using the box transaction ID (UUID format). Box transactions represent credits, debits, and internal transfers. Note: Box transactions can be accessed in two ways:

Using type=boxTransaction with the transactionBox.id (UUID) - This directly queries the TransactionBox table
Using type=transaction with a transaction ID where transactionType is “Boxes” - This returns credit/debit transactions through the Transaction model

curl -i -X GET \
  'https://api.equalsmoney.com/v2/activity/boxTransaction/992e9652-d313-4ea7-aa93-b96b247627c2?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

This returns a box transaction with details like transaction type (credit/debit), amount, currency, payment type, creditor/debtor account information, and running balance.

Get a transaction with additional details

Retrieve a payment transaction with optional additional information like annotations and attachments.

curl -i -X GET \
  'https://api.equalsmoney.com/v2/activity/payment/123456?accountId=F12345&include=annotations,attachments' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

This returns the standard payment transaction response, plus annotation details (if any) and attachment information with signed URLs for downloading attachments. When annotations is included, the transaction carries an annotationGroup whose annotationValues resolve the annotation field title and type inline — and, for dropdown fields, the selected option’s dropdownValue (name) and dropdownCode (your accountancy / general-ledger code):

annotationValue (dropdown field)

{
  "annotationFieldId": "77aa80c9-4d4a-4a52-8ae2-b73638b3f2d8",
  "annotationFieldTitle": "Chart of Accounts",
  "annotationFieldType": "dropdown",
  "uuidValue": { "value": "73a861f9-be02-4248-bdb9-0b03a6d394ac" },
  "dropdownValue": "Marketing",
  "dropdownCode": "G1239"
}

For the full annotation response shape and the mapping from annotationFieldType to its value property, see Annotations.

Example responses by type

Payment transaction response:

{
  "budget": "companyBalance",
  "resourceType": "payment",
  "id": 123456,
  "orderId": 654321,
  "userId": "4bf13dc8-d128-4521-99b8-4002b8987499",
  "originId": "0684fc07-4abc-46de-b664-da45ef3c4072",
  "originOrderId": "F6VOXCZ1AMND",
  "companyId": "F12345",
  "status": "complete",
  "transactionGroupId": null,
  "isMultiBeneficiary": false,
  "remitterName": null,
  "beneficiaryId": "7l2nks3eh",
  "beneficiaryName": "William Walker",
  "beneficiaryAddress": "68 Upper Thames St",
  "beneficiaryAccountNumber": "12345678",
  "beneficiarySortCode": "123456",
  "beneficiaryIban": "",
  "beneficiaryBankCode": "",
  "beneficiaryCountryCode": "GB",
  "beneficiaryBankAddress": "UPPER THAMES STREET, 68 VINTNERS PLACE FAIRFX FLOOR 3 LONDON EC4V 3BJ",
  "beneficiaryRoutingInfo": "Payment will be routed from Bank of England and then through Lloyds bank",
  "reference": "Invoice 3468 payment",
  "amount": 99.99,
  "currency": "GBP",
  "buyCurrency": "GBP",
  "sellCurrency": "GBP",
  "settlementAmountWithoutFee": 99.99,
  "settlementAmount": 99.99,
  "settlementFee": 0,
  "customerRate": 1,
  "customerInverseRate": 1,
  "uniqueId": "8233f929-94d3-4390-8d27-da92b733cafb",
  "confirmationKey": "F12345/pdf/F12345-F6VOXCZ1AMND.pdf",
  "type": "payment",
  "budgetId": "63f4b801-70d6-4bba-b3f3-7b9acd051633",
  "budgetName": "Account balance",
  "createdAt": "2022-11-14T10:55:28.000Z",
  "updatedAt": "2022-11-14T10:55:30.000Z",
  "order": {
    "id": 654321,
    "orderSource": "legacy",
    "companyId": "F12345",
    "originId": "F6VOXCZ1AMND",
    "parentOriginId": null,
    "userId": "d4fd55fe-836d-48d2-8d49-e5629bd508a6",
    "userName": "John Doe",
    "status": "complete",
    "type": "payment",
    "lastSourceEventDatetime": null,
    "createdAt": "2022-11-14T10:55:28.000Z",
    "updatedAt": "2022-11-14T10:55:30.000Z",
    "settlementDate": null,
    "events": [
      {
        "id": "beec0eb3-3e11-44a4-86de-65404510038a",
        "eventId": "4c191b59-685b-454b-bad7-e832505ee51c",
        "orderCreatedAt": "2022-11-14T10:55:28.000Z",
        "eventType": 0,
        "orderId": 654321,
        "title": "Order created",
        "description": "Payment to William Walker created",
        "createdAt": "2022-11-14T10:55:28.000Z",
        "referencedOriginOrderId": null
      }
    ]
  },
  "transactionBoxes": []
}

Order query response: Querying by order (type=order) returns the same payment transaction structure shown above, using the originOrderId (e.g., F6VOXCZ1AMND) as the identifier. Card transaction response:

{
  "resourceType": "card",
  "id": "19bbf64b-ddfb-48ee-b125-66ed4455d534",
  "accountId": "F12345",
  "transactionGroupId": "f863de54-1cac-49b2-b624-ffd3a54dfcc7",
  "sourceGroupId": "f863de54-1cac-49b2-b624-ffd3a54dfcc7",
  "transactionType": "Marqeta",
  "status": "pending",
  "transactionDate": "2022-08-18T13:38:01.000Z",
  "createdAt": "2022-08-17T07:07:10.000Z",
  "updatedAt": "2022-08-18T14:25:22.000Z",
  "transactionGroup": {
    "id": "f863de54-1cac-49b2-b624-ffd3a54dfcc7",
    "accountId": "F12345",
    "personId": "e5098eb4-4800-4276-a234-2a9185399430",
    "firstName": "John",
    "lastName": "Smith",
    "budgetId": "650b2c1b-21fa-4d79-b73c-7aa9482c0e66",
    "budgetName": "Account Balance",
    "createdAt": "2022-08-17T07:07:12.000Z",
    "updatedAt": "2022-08-17T07:07:12.000Z"
  },
  "cardTransaction": {
    "exchangeRate": null,
    "exchangeRateInverse": null,
    "id": "7a5e1306-794c-4ccb-a0d1-e647eff79c6b",
    "transactionToken": "03ae2891-6611-4e12-9bf8-a455384477f0",
    "precedingRelatedTransactionToken": null,
    "identifier": null,
    "transactionId": "19bbf64b-ddfb-48ee-b125-66ed4455d534",
    "localAmount": 99.99,
    "localAmountCurrency": "GBP",
    "settlementAmount": null,
    "settlementAmountCurrency": null,
    "baseCurrency": "GBP",
    "billingAmount": null,
    "billingExchangeRate": null,
    "feeAmount": 0,
    "feeCurrency": "GBP",
    "total": 0,
    "cardName": "Debit Card",
    "cardId": "8fe9cd43-d79f-4025-a0dc-3ee4ace98eb8",
    "cardProductToken": "c12dd620-053d-43c7-a00b-ea78a9afbc6b",
    "cardType": "PHYSICAL_MSR",
    "cardLastDigits": "1234",
    "status": "pending",
    "type": "card",
    "transactionType": null,
    "approvalCode": null,
    "acquirerInstitutionIdCode": null,
    "acquirerReferenceNumber": null,
    "paymentChannel": null,
    "transactionCompletedAt": null,
    "transactionCreatedAt": "2022-08-17T07:07:10.000Z",
    "boxesResponse": null,
    "pos": null,
    "createdAt": "2022-08-18T14:25:22.000Z",
    "updatedAt": "2022-08-18T14:25:22.000Z",
    "chargedTotalAmount": 99.99,
    "chargedAmount": 99.99,
    "chargedCurrency": "GBP",
    "merchantFeeAmount": 0,
    "response": {
      "code": null,
      "memo": null
    },
    "runningBalance": "2000.49",
    "updatedAtBoxTransaction": "2022-08-18T14:25:22.000Z"
  },
  "merchant": {
    "id": "7221d41b-69c3-4fbc-8317-d3210d97b3ab",
    "merchantCategoryId": "d780ae34-dfe1-4e24-82f0-2043c7fa30d4",
    "mid": "5009545",
    "subMerchantId": null,
    "originalName": "ACME COFFEE",
    "name": "ACME COFFEE",
    "description": null,
    "address": null,
    "city": "LONDON",
    "state": "GBR",
    "postalCode": "EC3V 2BJ",
    "countryCode": "GBR",
    "website": null,
    "logo": null,
    "emoji": "",
    "notes": "",
    "createdAt": "2022-01-11T09:46:07.000Z",
    "updatedAt": "2022-01-11T09:46:07.000Z",
    "enrichedName": null,
    "lastEnrichedRefreshDate": null,
    "merchantCategory": {
      "id": "d780ae34-dfe1-4e24-82f0-2043c7fa30d4",
      "code": "5814",
      "description": "Fast food restaurants",
      "createdAt": "2021-09-10T08:55:06.000Z",
      "updatedAt": "2021-09-10T08:55:06.000Z"
    }
  },
  "transactionBox": null,
  "initiator": null
}

Box transaction response:

{
  "resourceType": "box",
  "id": "4b076d4a-ffa7-47b4-936d-c42fee31bb28",
  "accountId": "F50975",
  "createdAt": "2024-09-11T13:31:24.000Z",
  "updatedAt": "2024-09-11T13:31:24.000Z",
  "initiator": null,
  "sourceGroupId": null,
  "status": null,
  "transactionDate": null,
  "transactionGroup": {
    "id": "8e7519d2-9552-431e-a81e-7c0a499e78e5",
    "accountId": "F50975",
    "personId": null,
    "firstName": null,
    "lastName": null,
    "budgetId": "773ccbf9-8332-4264-885e-3b1a8274626c",
    "budgetName": "Account balance",
    "createdAt": "2024-09-11T13:31:24.000Z",
    "updatedAt": "2024-09-11T13:31:24.000Z"
  },
  "transactionGroupId": "8e7519d2-9552-431e-a81e-7c0a499e78e5",
  "transactionType": "Boxes",
  "transactionBox": {
    "id": "00018d82-f576-4728-9e32-92634aec8250",
    "paymentId": null,
    "transactionId": "4b076d4a-ffa7-47b4-936d-c42fee31bb28",
    "boxTransactionId": 375508,
    "accountId": "F50975",
    "budgetId": "773ccbf9-8332-4264-885e-3b1a8274626c",
    "transactionBoxableType": "transaction",
    "transactionBoxableId": "4b076d4a-ffa7-47b4-936d-c42fee31bb28",
    "boxId": "54171a16-73f0-4fad-8f72-9a2b06b3f28e",
    "type": "block",
    "amount": 0.33,
    "currency": "GBP",
    "paymentType": null,
    "transactionReference": null,
    "statementReference": null,
    "creditDebitIndicator": null,
    "debitId": null,
    "creditId": null,
    "thirdPartyReference": "8e7519d2-9552-431e-a81e-7c0a499e78e5",
    "marqetaTransactionToken": null,
    "marqetaTransactionIdentifier": null,
    "internalAccountTransferId": null,
    "affectsLedgerBalance": false,
    "runningBalance": "157017632.31",
    "blockId": "98479",
    "blockTag": "8e7519d2-9552-431e-a81e-7c0a499e78e5",
    "valueDateTime": null,
    "orderId": "",
    "eventSource": "MarqetaJIT",
    "createdAt": "2025-07-28T09:35:43.000Z",
    "updatedAt": "2025-07-28T09:38:19.000Z",
    "chargeBearer": null
  }
}

Get payment files

For SWIFT and CHAPS payments, you can download the proof of payment. This is the original bank message for the payment, provided as either an MT103 or an ISO 20022 pacs.008 document. To include it in the response, add paymentFiles to the include query parameter.

curl -i -X GET \
  'https://api.equalsmoney.com/v2/activity/payment/123456?accountId=F12345&include=paymentFiles' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

When a proof is available, the response includes a paymentFiles array on the transaction. Each item is a file you can download using a secure link that expires after a short time:

Sample response (payment, truncated)

{
  "resourceType": "payment",
  "id": 123456,
  "status": "complete",
  "amount": 99.99,
  "currency": "GBP",
  "reference": "Invoice 3468 payment",
  "beneficiaryName": "William Walker",
  "createdAt": "2022-11-14T10:55:28.000Z",
  "paymentFiles": [
    {
      "fileType": "MT103",
      "url": "https://files.equalsmoney.com/payment-information/eb6305c8.xml?X-Amz-Signature=...",
      "expiresAt": "2024-01-30T11:17:15.000Z"
    }
  ]
}

string

The type of the payment file. Allowable values: MT103, PACS008, PAIN001, PDF

string

A secure link to download the file. Download the file promptly, as the link expires after a short time.

string

The ISO 8601 date and time at which the link expires.

paymentFiles is only returned when you request it with include=paymentFiles.
It applies to outbound payments (type=payment) and inbound credits (type=boxTransaction) made over SWIFT or CHAPS. Other payment types do not have a proof of payment.
If no proof is available yet, paymentFiles will be empty.
The link expires, so download the file as soon as you receive it rather than saving the link. If the link has expired, request the transaction again to get a new one.

Error responses

Status code	Description
`404`	The transaction was not found. This can occur if the `id` doesn’t exist, if the `type` doesn’t match the ID format, or if the transaction doesn’t belong to the specified `accountId`.
`400`	Bad request. This can occur if a required parameter is missing (e.g., `accountId`) or if the `type` value is not one of the allowable values.

For more information about this request and its response, see the API reference.

​Get a single transaction

​Request

​Path parameters

​Query parameters

​Response

​Examples

​Get a payment transaction

​Get a transaction by transaction ID

​Get an order by origin order ID

​Get a box transaction

​Get a transaction with additional details

​Example responses by type

​Get payment files

​Error responses

Get a single transaction

Request

Path parameters

Query parameters

Response

Examples

Get a payment transaction

Get a transaction by transaction ID

Get an order by origin order ID

Get a box transaction

Get a transaction with additional details

Example responses by type

Get payment files

Error responses