Payment

Type: object

ONBRDNG Schema for a payment_method

root id
Type: string

Unique Identifier for a Payment

root user_id
Type: string

Unique Identifier for a user

root user_subscription_id
Type: string

Foreign key for User Subscription

root payment_method
Type: string

The selection payment method

root payment_amount
Type: number

Payment amount.

root payment_currency
Type: string

Payment currency. Format: ISO-4217, ie 'GBP'

Must match regular expression: ^[A-Z]{3}$

root payment_status
Type: enum (of string)

The payment status, ie paid, expired, failed or pending.

Must be one of:

  • "paid"
  • "expired"
  • "failed"
  • "pending"

root payment_recurring_type
Type: enum (of string)

The payment status, ie first or recurring.

Must be one of:

  • "first"
  • "recurring"

root installed_at
Type: stringFormat: date-time

Moment of payment installment. Format: YYYY-MM-DD HH:MM:SS[.SSSSSS].

Must match regular expression: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z?$

root cancelled_at
Type: stringFormat: date-time

Moment of payment cancellation. Format: YYYY-MM-DD HH:MM:SS[.SSSSSS].

Must match regular expression: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z?$

root refunded_at
Type: stringFormat: date-time

Moment of payment refund. Format: YYYY-MM-DD HH:MM:SS[.SSSSSS].

Must match regular expression: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z?$

root chargeback_at
Type: stringFormat: date-time

Moment of payment chargeback. Format: YYYY-MM-DD HH:MM:SS[.SSSSSS].

Must match regular expression: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z?$