Sent when a payment request is created. Carries a trimmed paymentRequest object. All deliveries share the common envelope (eventId, eventName, timestamp, programId, sandbox, customerId, clientReference).

paymentRequest fields

payee, batchItemId, cryptoQuoteId and childAccountId are included only when present.
FieldTypeNotes
idstringPayment request identifier.
paymentRefstringYour payment reference.
amountnumberAmount, minor units.
currencystringPayment currency.
customerIdstringInitiating customer.
accountIdstringSource account.
type / subTypestringPayment classification.
createdDateTimestringWhen the request was created.
statusstringCurrent status.
statusHistoryarrayStatus transitions with timestamps.
payeeobjectOptional. Beneficiary details.
batchItemIdstringOptional. Present for batch payments.
cryptoQuoteIdstringOptional. Present for crypto payments.
childAccountIdstringOptional. Present for child-account payments.

Example

{
  "eventId": "e5b2…",
  "eventName": "TRANSACTION_INITIATED",
  "timestamp": "2026-06-23T12:34:56.789Z",
  "programId": "yourprogram",
  "sandbox": false,
  "customerId": "cust_123",
  "paymentRequest": {
    "id": "pr_001",
    "paymentRef": "INV-2026-001",
    "amount": 5000,
    "currency": "EUR",
    "customerId": "cust_123",
    "accountId": "acc_456",
    "type": "SEPA",
    "subType": "CT",
    "createdDateTime": "2026-06-23T12:34:50.000Z",
    "status": "PENDING",
    "statusHistory": [{ "status": "PENDING", "timestamp": "2026-06-23T12:34:50.000Z" }],
    "payee": { "name": "Jane Doe", "iban": "DE89…" }
  }
}