Settlement

A payout/settlement/disbursement is a type of accounting record that represents fund transfers from a merchant's payment processor wallet to a destination account.

  • amount
    Type: number
    required
  • currencyCode
    Type: string
    required
  • date
    Type: stringFormat: date
    required

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • status
    Type: enum
    required
    values
    pendingpaidfailed
  • customFields
    Type: nullable

    The additional fields related to an accounting record. Custom fields are used to attach custom metadata to the objects to ingest into the system. Custom fields can be any valid JSON object.

    Properties: 1
  • description
    Type: stringnullable
  • exchangeRates
    Type: array of ExchangeRatenullable
    Properties: 2
Previous
ReportAccount
Next
SettlementStatus