Payment

@experimental context type representing an institutional payment instruction, mapping to ISO 20022 pacs.008 (FIToFICustomerCreditTransfer). This type defines routing and settlement details including amount, currency, debtor, creditor, and optional network routing information.

Schema

https://fdc3.finos.org/schemas/next/context/payment.schema.json (github)

Type

fdc3.payment

Properties

id (required)

type: object

Additional Properties

type: string

One or more identifiers that refer to the payment in an OMS, EMS, or Settlement network (e.g., UETR, TransactionHash).

name

type: string

An optional human-readable summary of the payment context.

amount (required)

type: number

The exact numerical value of the payment.

currency (required)

type: string

The ISO 4217 currency code or standard asset identifier (e.g., 'USD', 'EUR', 'GBP').

debtor (required)

type: object

Subproperties:

name

type: string

account (required)

type: string

agent

type: string

The originating party initiating the payment.

creditor (required)

type: object

Subproperties:

name

type: string

account (required)

type: string

agent

type: string

The receiving party for the payment.

networkRouting

type: object

Additional Properties

type: string

Optional parameters for payment routing and settlement execution, such as clearing system identifiers, rail routing codes, or network-specific execution parameters.

Example

{
  "type": "fdc3.payment",
  "name": "ISO 20022 pacs.008 Settlement",
  "id": {
    "UETR": "123e4567-e89b-12d3-a456-426614174000"
  },
  "amount": 150000,
  "currency": "USD",
  "debtor": {
    "name": "Acme Corp",
    "account": "GB33BUKB20201555555555"
  },
  "creditor": {
    "name": "Global Treasury Ltd",
    "account": "US33CHAS021000021"
  },
  "networkRouting": {
    "rail": "RTGS",
    "settlementMethod": "CLRG",
    "clearingSystem": "SWIFT"
  }
}