Get a single payment by its origin ID

GET

activity

payment

origin

{originId}

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/activity/payment/origin/{originId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.equalsmoney.com/v2/activity/payment/origin/{originId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/activity/payment/origin/{originId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.equalsmoney.com/v2/activity/payment/origin/{originId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.equalsmoney.com/v2/activity/payment/origin/{originId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/activity/payment/origin/{originId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "resourceType": "payment",
  "id": 42782085,
  "orderId": 1380,
  "userId": "34edaf73-49be-4669-83ee-1b1f8c680d26",
  "ownerId": "775596ae-2624-40af-a9dc-9756110a4a04",
  "companyId": "F50072",
  "originId": "9a623439-8275-4230-a157-6c623a2ea7b8",
  "originOrderId": "EKOBEPVFJ",
  "externalId": "cust-ref-9f3b",
  "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",
  "uetr": "eb6305c8-0d2a-4e1e-a30f-3ef5b1e5c2f8",
  "paymentConfirmationAvailable": true,
  "paymentNetwork": "UKFPS",
  "type": "exchange",
  "order": {
    "id": 1380,
    "companyId": "F50072",
    "originId": "9a623439-8275-4230-a157-6c623a2ea7b8",
    "status": "needsApproval",
    "type": "payment",
    "userId": "34edaf73-49be-4669-83ee-1b1f8c680d26",
    "ownerId": "775596ae-2624-40af-a9dc-9756110a4a04",
    "userName": "John Doe",
    "lastSourceEventDatetime": "2019-08-24T14:15:22Z",
    "orderSource": "string",
    "parentOriginId": "string",
    "settlementDate": "string",
    "initiator": "John Doe",
    "metadata": "{ paymentsCount: 1 }",
    "events": [
      null
    ],
    "payments": [
      null
    ],
    "childFundingBudget": {
      "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
      "boxCollectionId": "string",
      "budgetName": "Marketing sub-balance"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "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",
        "sourceBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "sourceBudgetName": "Marketing budget",
        "destinationBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "destinationBudgetName": "Travel budget"
      },
      "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",
        "sourceBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "sourceBudgetName": "Marketing budget",
        "destinationBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "destinationBudgetName": "Travel budget"
      },
      "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": "775596ae-2624-40af-a9dc-9756110a4a03",
      "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",
        "sourceBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "sourceBudgetName": "Marketing budget",
        "destinationBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "destinationBudgetName": "Travel budget"
      },
      "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",
        "sourceBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "sourceBudgetName": "Marketing budget",
        "destinationBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "destinationBudgetName": "Travel budget"
      },
      "uetr": "eb6305c8-0d2a-4e1e-a30f-3ef5b1e5c2f8",
      "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",
    "origin": "user",
    "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
    ]
  },
  "paymentFiles": [
    {
      "fileType": "MT103",
      "url": "https://files.equalsmoney.com/payment-information/eb6305c8.xml?X-Amz-Signature=...",
      "expiresAt": "2024-01-30T11:17:15.000Z"
    }
  ],
  "swiftGpi": {
    "uetr": "eb6305c9-1f7f-49de-aed0-16487c27b42d",
    "status": "ACCC",
    "initiatedAt": "2026-06-16T10:00:00.000Z",
    "lastUpdatedAt": "2026-06-16T10:12:00.000Z",
    "instructedAmount": "1000.00",
    "instructedCurrencyCode": "USD",
    "events": [
      {
        "trackerEventType": "CRED",
        "fromBankIdentifier": "BANKGB2L",
        "toBankIdentifier": "BANKDEFF",
        "status": "ACSP",
        "amount": "1000.00",
        "currencyCode": "USD",
        "eventTimestamp": "2026-06-16T10:09:00.000Z"
      }
    ]
  },
  "teams": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Authorizations

Authorization

string

header

required

Path Parameters

originId

string

required

The ID of the Payment on the origin platform. This is the transactionGroupId on the payment's BoxCredited/BoxDebited webhooks.

Maximum string length: 36

Example:

"9a623439-8275-4230-a157-6c623a2ea7b8"

Query Parameters

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

include

enum<string>

Controls which optional properties should be attached to the response. forwardDetails attaches the forward contract's payments, events, deposits and drawdowns to forward contract payments. paymentFiles attaches a paymentFiles array (per UETR); each item has a fileType (mt103/pacs008/pain001/pdf) and a pre-signed url. swiftGpi attaches the SWIFT GPI tracking detail (UETR, status and payment-leg events).

Available options:

forwardDetails,

paymentFiles,

swiftGpi

Example:

"paymentFiles,swiftGpi"

personId

The ID of the person to work with. Use commas to pass multiple values. Has to be URL encoded.

Response

200 - application/json

resourceType

enum<string>

required

Used to identify this particular type of Order. E.g. when it's part of the "activity" stream. Exchange payments return "currencyPurchase".

Available options:

payment,

currencyPurchase

Example:

"payment"

integer

required

The ID of the Payment.

Example:

42782085

orderId

integer

required

The ID of the Order the Payment belongs to.

Example:

1380

userId

string | null

required

The ID of the User that the Payment belongs to. Can be NULL (PAY Payment for example).

Maximum string length: 36

Example:

"34edaf73-49be-4669-83ee-1b1f8c680d26"

companyId

string

required

The ID of the Company that the Payment belongs to.

Maximum string length: 36

Example:

"F50072"

originId

string

required

The ID of the Payment on the origin platform. PAY for example

Maximum string length: 36

Example:

"9a623439-8275-4230-a157-6c623a2ea7b8"

originOrderId

string

required

The order ID of the Order the Payment belongs to on the origin platform. PAY for example

Maximum string length: 36

Example:

"EKOBEPVFJ"

budgetId

string<uuid>

required

The ID of the budget to work with.

Maximum string length: 36

Example:

"775596ae-2624-40af-a9dc-9756110a4a03"

status

enum<string>

required

The status of the Payment. Currently always the same as the parent Order status.

Available options:

needsApproval,

fundsRequired,

pending,

complete,

declined,

reverted,

refunded,

cancelled,

open,

cardCheck,

fundsSettled

Example:

"orderCancelled"

isMultiBeneficiary

boolean

required

Whether this is a single or multi beneficiary payment.

beneficiaryId

string

required

The unique ID of the beneficiary

Maximum string length: 256

Example:

"ben90944601"

beneficiaryName

string

required

Name of the Person receiving the Payment.

Maximum string length: 256

Example:

"Nichole Grant"

beneficiaryAddress

string

required

Address of the Person receiving the Payment.

Example:

"46315 Bailey MillSouth CamilleNiue"

beneficiaryAccountNumber

string

required

Bank account number to send the Payment to.

Maximum string length: 32

Example:

"10387899"

beneficiarySortCode

string

required

Sort code of the bank to send the Payment to.

Maximum string length: 32

Example:

"12-34-56"

beneficiaryIban

string

required

Iban of the bank to send the Payment to.

Maximum string length: 34

Example:

"PT72105510150936500020992"

beneficiaryBankCode

string

required

Bank code of the bank to send the Payment to.

Maximum string length: 256

Example:

"QHKEMKK1"

beneficiaryBankAddress

string

required

Address of the bank the Payment is being made to.

Example:

"883 Bernie MountainNew EstachesterVietnam"

beneficiaryCountryCode

string

required

The ISO country code for the country the beneficiary is registered to.

Example:

"GB"

beneficiaryRoutingInfo

string

required

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

string | null

required

Name of the Person send in the Payment.

Maximum string length: 256

Example:

"Joseph Bloggs"

reference

string

required

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

number

required

The amount the Payment was for. Maximum amount is 9999999999.99.

Example:

773.08

currency

enum<string>

required

Available options:

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,

SLE,

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

enum<string> | null

required

Available options:

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,

SLE,

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

enum<string> | null

required

Available options:

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,

SLE,

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

number | null

required

When isMultiBeneficiary = false. The amount of the currency being bought including our Fee. Maximum amount is 9999999999.99.

Example:

33920.34

settlementFee

number | null

required

When isMultiBeneficiary = false. The total fee we took for the facilitating the purchase.

Example:

1.34

settlementAmountWithoutFee

number | null

required

When isMultiBeneficiary = false. The amount of the currency being bought excluding our Fee. Maximum amount is 9999999999.99.

Example:

33920.34

customerRate

number | null

required

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

number | null

required

When isMultiBeneficiary = false. The rate at which the sell currency was sold including any margin

Example:

0.71942446043

confirmationKey

string | null

required

When isMultiBeneficiary = false. The key used to identify a pdf confirmation for an order.

Example:

"F36555/pdf/F36555-000265963.pdf"

uniqueId

string

required

The unique ID of the beneficiary on MTS

Maximum string length: 256

Example:

"69e4a1e8-db35-4301-b5a8-67a2cb063609"

type

enum<string> | null

required

The type of the Payment. fee and tax are billing charges raised against an order, not customer-initiated movements.

Available options:

exchange,

payment,

cardPayment,

deposit,

forwardContract,

drawdown,

load,

fee,

tax

order

object

required

Show child attributes

budgetName

string

required

The name of the budget.

transactionGroupId

string | null

required

The transaction group ID.

Example:

"1c0547bd-30e6-4d14-b82e-78cd128fbfd9"

transactionBoxes

object[]

required

Array of all the box events which belongs to a Payment.

Show child attributes

createdAt

string<date-time>

required

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAt

string<date-time>

required

The date the Resource was last modified. ISO 8601 format without milliseconds.

ownerId

string<uuid> | null

The CIS person UUID of the person who owns this Payment — the same identity the app holds for a logged-in person. Null when no owner is known (never the caller by fallback); distinct from the legacy userId column, which may hold an auth subject on older rows. Absent from older producers.

Maximum string length: 36

Example:

"775596ae-2624-40af-a9dc-9756110a4a04"

externalId

string | null

The customer-defined unique identifier for the payment. Echoes the externalId originally supplied to POST /v2/payments. Absent or null when none was supplied.

Required string length: 1 - 64

Example:

"cust-ref-9f3b"

budget

enum<string>

default:companyBalance

Always returns "companyBalance" as the Budget.

Available options:

companyBalance

uetr

string | null

Unique End-to-end Transaction Reference. Set on payments routed over SWIFT or CHAPS. Not an eligibility signal on its own, since it can be present on payments no confirmation can be produced for. Use paymentConfirmationAvailable to decide whether to offer a confirmation document.

Maximum string length: 36

Example:

"eb6305c8-0d2a-4e1e-a30f-3ef5b1e5c2f8"

paymentConfirmationAvailable

boolean

Whether a payment confirmation document can be produced for this Payment.

Example:

true

paymentNetwork

enum<string> | null

The network the Payment was routed over. Null where the rail is not known, and for internal transfers, which have no external network.

Available options:

SWIFT,

SEPA.INSTANT,

SEPA.CREDITTRANSFER,

CHAPS,

UKFPS,

ACH,

WIRETRANSFER,

OFF_PLATFORM,

NIP

Example:

"UKFPS"

deleted

boolean | null

Used to show if a payment has been deleted (when received from PAY).

annotationGroup

object | null

Show child attributes

attachment

object | null

Show child attributes

forwardDetails

object | null

Nested forward-contract details. Only populated when include=forwardDetails is requested for forwardContract rows.

Show child attributes

paymentFiles

object[] | null

Downloadable payment files for the activity, keyed by UETR (one per UETR today). Only populated when include=paymentFiles is requested, for payment and boxTransaction rows.

Show child attributes

swiftGpi

object | null

SWIFT GPI tracking detail for the payment, including the full chain of payment-leg events. Only present for SWIFT/bank payments when include=swiftGpi is specified.

Show child attributes

teams

Comma-separated list of team names associated with the payment initiator. Only present when include=teams is specified.

⌘I

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/activity/payment/origin/{originId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.equalsmoney.com/v2/activity/payment/origin/{originId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/activity/payment/origin/{originId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.equalsmoney.com/v2/activity/payment/origin/{originId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.equalsmoney.com/v2/activity/payment/origin/{originId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/activity/payment/origin/{originId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "resourceType": "payment",
  "id": 42782085,
  "orderId": 1380,
  "userId": "34edaf73-49be-4669-83ee-1b1f8c680d26",
  "ownerId": "775596ae-2624-40af-a9dc-9756110a4a04",
  "companyId": "F50072",
  "originId": "9a623439-8275-4230-a157-6c623a2ea7b8",
  "originOrderId": "EKOBEPVFJ",
  "externalId": "cust-ref-9f3b",
  "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",
  "uetr": "eb6305c8-0d2a-4e1e-a30f-3ef5b1e5c2f8",
  "paymentConfirmationAvailable": true,
  "paymentNetwork": "UKFPS",
  "type": "exchange",
  "order": {
    "id": 1380,
    "companyId": "F50072",
    "originId": "9a623439-8275-4230-a157-6c623a2ea7b8",
    "status": "needsApproval",
    "type": "payment",
    "userId": "34edaf73-49be-4669-83ee-1b1f8c680d26",
    "ownerId": "775596ae-2624-40af-a9dc-9756110a4a04",
    "userName": "John Doe",
    "lastSourceEventDatetime": "2019-08-24T14:15:22Z",
    "orderSource": "string",
    "parentOriginId": "string",
    "settlementDate": "string",
    "initiator": "John Doe",
    "metadata": "{ paymentsCount: 1 }",
    "events": [
      null
    ],
    "payments": [
      null
    ],
    "childFundingBudget": {
      "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
      "boxCollectionId": "string",
      "budgetName": "Marketing sub-balance"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "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",
        "sourceBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "sourceBudgetName": "Marketing budget",
        "destinationBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "destinationBudgetName": "Travel budget"
      },
      "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",
        "sourceBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "sourceBudgetName": "Marketing budget",
        "destinationBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "destinationBudgetName": "Travel budget"
      },
      "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": "775596ae-2624-40af-a9dc-9756110a4a03",
      "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",
        "sourceBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "sourceBudgetName": "Marketing budget",
        "destinationBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "destinationBudgetName": "Travel budget"
      },
      "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",
        "sourceBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "sourceBudgetName": "Marketing budget",
        "destinationBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
        "destinationBudgetName": "Travel budget"
      },
      "uetr": "eb6305c8-0d2a-4e1e-a30f-3ef5b1e5c2f8",
      "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",
    "origin": "user",
    "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
    ]
  },
  "paymentFiles": [
    {
      "fileType": "MT103",
      "url": "https://files.equalsmoney.com/payment-information/eb6305c8.xml?X-Amz-Signature=...",
      "expiresAt": "2024-01-30T11:17:15.000Z"
    }
  ],
  "swiftGpi": {
    "uetr": "eb6305c9-1f7f-49de-aed0-16487c27b42d",
    "status": "ACCC",
    "initiatedAt": "2026-06-16T10:00:00.000Z",
    "lastUpdatedAt": "2026-06-16T10:12:00.000Z",
    "instructedAmount": "1000.00",
    "instructedCurrencyCode": "USD",
    "events": [
      {
        "trackerEventType": "CRED",
        "fromBankIdentifier": "BANKGB2L",
        "toBankIdentifier": "BANKDEFF",
        "status": "ACSP",
        "amount": "1000.00",
        "currencyCode": "USD",
        "eventTimestamp": "2026-06-16T10:09:00.000Z"
      }
    ]
  },
  "teams": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get started

Accounts & onboarding

Budgets

Payments

Cards

Transactions

Reports

People

Webhooks

Roqqett

Get a single payment by its origin ID

Authorizations

Path Parameters

Query Parameters

Response