generated: '2026-10-09'
method: derived
generator: derive-data-model.py
source:
- openapi/xrpay-openapi.yml
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 26
  entities_in_spec: 26
  relationships: 11
entities:
- name: DirectMobileMoneyPaymentMethodData
  fields: 2
- name: Error
  fields: 1
- name: LineItem
  fields: 4
- name: PaymentIntent
  fields: 31
- name: PaymentIntentCreate
  fields: 19
- name: PaymentNextAction
  fields: 8
- name: Payout
  fields: 16
  description: One merchant-facing payout. Delivery IDs are opaque and never identify a provider.
- name: PayoutDestination
  fields: 10
- name: PayoutDestinationCreate
  fields: 5
- name: PayoutInstitution
  fields: 9
- name: PayoutQuote
  fields: 17
- name: PayoutQuoteCreate
  fields: 5
- name: PayrollEmployeeCreate
  fields: 4
- name: PayrollRun
  fields: 13
  description: A single-currency payroll run. Each payment is indivisible and uses exactly one internal custody
    pool.
- name: Refund
  fields: 17
- name: RefundCreate
  fields: 4
- name: RefundList
  fields: 3
- name: Settlement
  fields: 4
- name: TestBalanceCredit
  fields: 7
  description: An idempotent credit to the connected business's isolated virtual payout balance. It never represents
    external money movement.
- name: WebhookDelivery
  fields: 14
- name: WebhookDeliveryList
  fields: 4
- name: WebhookEndpoint
  fields: 10
- name: WebhookEndpointCreate
  fields: 3
- name: WebhookEndpointList
  fields: 2
- name: WebhookEvent
  fields: 9
  description: The id/webhook_id remains stable across all attempts and replay operations.
- name: WebhookSecret
  fields: 6
relationships:
- from: PaymentIntentCreate
  to: DirectMobileMoneyPaymentMethodData
  type: has_one
  via: payment_method_data
- from: PaymentIntentCreate
  to: LineItem
  type: has_many
  via: line_items
- from: PaymentIntent
  to: Settlement
  type: has_one
  via: settlement
- from: PaymentIntent
  to: PaymentNextAction
  type: has_one
  via: next_action
- from: PaymentIntent
  to: TestBalanceCredit
  type: has_one
  via: test_balance_credit
- from: RefundCreate
  to: PaymentIntent
  type: belongs_to
  via: payment_intent_id
- from: Refund
  to: PaymentIntent
  type: belongs_to
  via: payment_intent_id
- from: Refund
  to: Settlement
  type: has_one
  via: settlement
- from: RefundList
  to: Refund
  type: has_many
  via: data
- from: WebhookEndpointList
  to: WebhookEndpoint
  type: has_many
  via: data
- from: WebhookDeliveryList
  to: WebhookDelivery
  type: has_many
  via: data