Payments Domain Overview

Purpose

The Payments API enables partners to initiate and manage payment operations programmatically via secure machine-to-machine communication.

The integration is designed to support automated payment processing with a strong authentication and request-signing model.

Scope

Through the Payments API, partners can:

  • Preflight payment details prior to execution
  • Initiate payment transactions
  • Retrieve payment status
  • Integrate payment processing into internal systems
  • Retrieve current balance

All operations are performed via authenticated and digitally signed API requests.

Payment Lifecycle

Payment processing follows a structured lifecycle to ensure validation, security, and traceability.

  1. Preflight Validation
    A preliminary request validates payment details before execution.
    This step verifies formatting, required fields, and business constraints.
  2. Payment Execution
    Once validated, the payment is submitted for processing via a dedicated execution request.
  3. Status Handling
    The system returns the payment status, which may indicate processing, completion, or failure.