Skip to main content
GET
Get payment by ID

Overview

Returns the complete v3 representation of a single payment, for every scheme (SEPA, INST, SDD, SWIFT, T2). Use it after a webhook to load everything about the payment - the webhook carries only the status change; this endpoint returns the full picture:
  • Parties - debtor and creditor with name, account (IBAN or other), agent BIC, full postal address, private/organisation identification, plus ultimate debtor and creditor when present
  • Amounts - instructed and settlement amount with currencies, settlement date, charges and adjustments (return charges, compensation, unaccounted tax)
  • References - endToEndId, messageId, instructionId, purpose, purpose code, category purpose, structured reference
  • Status - current status together with statusReason (code + message) explaining why the payment is in that status, and the originator of the last status change (originBic, originName, originReasonCode, originReasonInfo)
  • Scheme-specific blocks - swift, directDebit or t2 details when the payment belongs to that scheme
  • Links - parentPaymentId connects returns and cancellations to the original payment

When to use it

  • Correlate a Payment Status Change webhook by trx_id, then fetch the details you need
  • Investigate a Rejected payment - statusReason and the origin* fields identify the reason and which party rejected it
  • Reconcile a received payment - full payer details and references arrive exactly as sent by the counterparty

Path Parameters

id
integer<int64>
required

Response

Payment found and returned successfully

createdAt
string<date-time>
required

Time and date when the payment was created (UTC)

Example:

"2025-11-21T12:46:54.321667Z"

creditor
object
required

Creditor (recipient) party information

debtor
object
required

Debtor (sender) party information

direction
enum<string>
required

Payment direction

Available options:
OUTBOUND,
INBOUND
Example:

"OUTBOUND"

endToEndId
string
required

End-to-end identifier assigned by the originator

id
integer<int64>
required

Unique payment identifier

Example:

10300007

instructedAmount
integer
required

Instructed payment amount in minor currency units (cents)

Example:

100

instructedCurrency
string
required

Instructed payment currency ISO code

Example:

"EUR"

metadata
string[]
required

Client-defined metadata values assigned when the payment was created

scheme
enum<string>
required

Payment scheme. SEPA_CT — SEPA Credit Transfer, SEPA_INST — SEPA Instant Credit Transfer, SEPA_DD — SEPA Direct Debit, SWIFT — SWIFT cross-border payment.

Available options:
SEPA_CT,
SEPA_INST,
SEPA_DD,
SWIFT,
T2
Example:

"SEPA_CT"

sddActionOptions
object[]
required

R-transactions a client may raise against this payment right now. Empty for anything but a received SEPA direct debit collection. The action endpoints validate these windows again when a request is submitted.

sddRejectWindowExpired
boolean
required

True only when all Reject reason windows have expired. False also covers unknown expiry.

sddReturnWindowsExpired
boolean
required

True only when all Return and Refund reason windows have expired. False also covers unknown expiry.

settlementAmount
integer
required

Settlement amount in minor currency units (cents)

Example:

100

settlementCurrency
string
required

Settlement currency ISO code

Example:

"EUR"

status
enum<string>
required

Current payment status

Available options:
CREATED,
TO_SIGN,
SIGNED,
SENT_TO_CLEAR,
COMPLETED,
CANCELLED,
REJECTED,
ACCEPTED,
SOME_PROBLEMS,
PENDING_CONFIRMATION
Example:

"COMPLETED"

type
enum<string>
required

Payment type

Available options:
PAYMENT,
PAYMENT_CANCELLATION,
PAYMENT_RETURN,
REVERSE_PAYMENT,
CSM_FEES,
ADJUSTMENT
Example:

"PAYMENT"

adjustmentDisplayParties
object | null

Display-only parties for a resolved liquidity adjustment; the authoritative parties remain in debtor and creditor

categoryPurposeCode
enum<string> | null

Category purpose code (e.g. SALA, TAXS, GOVT)

Available options:
BONU,
CASH,
CBLK,
CCRD,
CORT,
DCRD,
DIVI,
DVPM,
EPAY,
FCIN,
FCOL,
GOVT,
HEDG,
ICCP,
IDCP,
INTC,
INTE,
LOAN,
MP2B,
MP2P,
OTHR,
PENS,
RPRE,
RRCT,
RVPM,
SALA,
SECU,
SSBE,
SUPP,
TAXS,
TRAD,
TREA,
VATX,
WHLD
categoryPurposeProprietary
string | null

Proprietary category purpose

chargesAndAdjustments
object | null

Return-only charges and adjustments. Populated only for payment_return / payment_cancellation transactions; absent otherwise.

creditTransferType
enum<string> | null

Credit transfer type for T2 payments

Available options:
CUSTOMER,
FINANCIAL_INSTITUTION
directDebit
object | null

SEPA direct debit fields, present only for SDD payments

instructionId
string | null

Instruction identifier

messageId
string | null

Message identifier

originBic
string | null

Return / rejection originator BIC

originName
string | null

Return / rejection originator name

originReasonCode
string | null

Return / rejection reason code

Example:

"AC04"

originReasonInfo
string | null

Return / rejection reason information

parentPaymentId
integer<int64> | null

Parent payment identifier, present for returns / reversals / cancellations

parentTransactionAmount
integer | null

Original (parent) transaction amount in minor currency units (cents)

purpose
string | null

Unstructured remittance information (free text)

Example:

"Invoice #12345"

purposeCode
string | null

ISO 20022 purpose code or proprietary purpose value (e.g. SUPP, SALA, TAXS)

settlementDate
string<date> | null

Settlement date

statusReason
object | null

Reason for the current status

structuredReference
object | null

Structured remittance reference

swift
object | null

SWIFT-specific fields, present only for SWIFT payments

t2
object | null

T2-specific fields, present only for T2 payments

ultimateCreditor
object | null

Ultimate creditor party information

ultimateDebtor
object | null

Ultimate debtor party information

updatedAt
string<date-time> | null

Time and date when the payment was last updated (UTC)

Example:

"2025-11-21T12:46:54.612954Z"

Last modified on September 9, 2026