PaymentHeaderPublic

Payment header (sensitive fields masked for non-admins)

idinteger

external_sourcestring

external_payment_idstring

statusstring

methodstring

total_amountnumber

currencystring

scheduled_atdate-timenullable

submitted_atdate-timenullable

sent_atdate-timenullable

expected_settlement_atdate-timenullable

settled_atdate-timenullable

returned_atdate-timenullable

payment_referencestringnullable

bank_referencestringnullable

ach_trace_numberstringnullable

sepa_end_to_end_idstringnullable

rtp_trace_idstringnullable

check_numberstringnullable

Masked unless admin

check_mailed_atdate-timenullable

check_cleared_atdate-timenullable

check_stop_paymentbooleannullable

beneficiary_namestringnullable

beneficiary_bank_namestringnullable

beneficiary_bank_countrystringnullable

beneficiary_swift_bicstringnullable

beneficiary_ibanstringnullable

Masked unless admin

beneficiary_accountstringnullable

Masked unless admin

beneficiary_routingstringnullable

Masked unless admin

payer_bank_namestringnullable

payer_bank_countrystringnullable

payer_accountstringnullable

Masked unless admin

payer_routingstringnullable

Masked unless admin

remittance_memostringnullable

remittance_advice_urlstringnullable

created_bystringnullable

created_viastringnullable

created_atdate-time

updated_atdate-time

PaymentHeaderPublic

{
  "id": 0,
  "external_source": "string",
  "external_payment_id": "string",
  "status": "string",
  "method": "string",
  "total_amount": 0,
  "currency": "string",
  "scheduled_at": "2024-07-29T15:51:28.071Z",
  "submitted_at": "2024-07-29T15:51:28.071Z",
  "sent_at": "2024-07-29T15:51:28.071Z",
  "expected_settlement_at": "2024-07-29T15:51:28.071Z",
  "settled_at": "2024-07-29T15:51:28.071Z",
  "returned_at": "2024-07-29T15:51:28.071Z",
  "payment_reference": "string",
  "bank_reference": "string",
  "ach_trace_number": "string",
  "sepa_end_to_end_id": "string",
  "rtp_trace_id": "string",
  "check_number": "string",
  "check_mailed_at": "2024-07-29T15:51:28.071Z",
  "check_cleared_at": "2024-07-29T15:51:28.071Z",
  "check_stop_payment": true,
  "beneficiary_name": "string",
  "beneficiary_bank_name": "string",
  "beneficiary_bank_country": "string",
  "beneficiary_swift_bic": "string",
  "beneficiary_iban": "string",
  "beneficiary_account": "string",
  "beneficiary_routing": "string",
  "payer_bank_name": "string",
  "payer_bank_country": "string",
  "payer_account": "string",
  "payer_routing": "string",
  "remittance_memo": "string",
  "remittance_advice_url": "string",
  "created_by": "string",
  "created_via": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}