Payment Data Structure

  • Payment Transaction Details, Settlement Details, and Payout Details belonging to the same payment transaction are linked via the unique Payment ID and Payment Detail ID values.

  • The PSP Reference is a unique identifier for the payment and all transactions and adjustments in its lifecycle.

  • The Merchant Reference is unique to each individual transaction or adjustment, all belonging to the same PSP reference. It is a combination of the POS check number and a generated number.

  • Payment Payout Details and Payout Summary are linked through the Payout PSP references.
    • Transaction Payout PSP Reference or Fee Payout PSP Reference in Payment Payout Details are used to join to the Payout PSP Reference in the Payment Payout Summary report.

    • If the payout record does not involve a fee, the Fee Payout PSP Reference is null.

    • If the payout record is for a fee only, the Transaction Payout PSP Reference is null.

  • In addition to inserting new records, downstream systems must be able to update existing records with revisionary data.
    • Use Payment ID and Payment Detail ID to identify existing records that need to be updated.

    • Example: A complete refund is performed in two separate payouts. The refunded amount is debited first, the fees for the refund transaction are included in the subsequent day's payout, both referencing the same Payment ID.