Post multi-leg payment (deprecated)

Enable users to submit a payment with multiple legs to the platform. The payments are processed asynchronously and must contain at least two legs, but no more than twenty.

The payload contains debits and credits lists. These lists include legs that follow the requirements of credit and debit objects in the Post payment endpoint.

For information about multi-leg payments, see the Post multi-leg payment section in Payment overview.

NOTES:

To find the correct reason IDs, refer to the List account status reasons endpoint.
This endpoint does not support forced transfers from an earmark balance.
For error handling, see Error handling mechanism in Payment overview.

Each leg generates the following events:

Platform authorization created
Account balance changed
Account balance changed (Availables)
Accounting entry created
If flex controls are configured, a Flex control evaluated event is triggered.

Additionally, the following events are generated for multi-leg payments:

See Data and reporting for more information about events and setting up event notifications.

Request body

tracking_idstring required

A unique payment tracking number. In the case of multi-leg payments, this ID is used to generate distinct child tracking IDs for each leg. If any of these child tracking IDs matches an existing tracking ID within the platform, a 400 error is returned. A single tracking ID must be provided. This is referred to as the original tracking ID. For information about tracking IDs, see Tracking ID requirement.

This field is:

Unique within the Organization.
Immutable: This field cannot be updated.
Not recyclable: tracking_id cannot be reused.

metadataMultilegMetadata

Key-value pairs containing data intended for storage in the Pismo system.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

instant_clearingboolean

Whether funds are available when payment is posted.

Example request

{
  "tracking_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244",
  "debits": [
    {
      "amount": 86753.09,
      "currency": "USD",
      "external_account_id": "289",
      "processing_code": "220035",
      "soft_descriptor": "ACME Inc. - Invoice 2938",
      "validation_rules": {
        "ACCOUNT_STATUS": {
          "override": false
        },
        "LEDGER": {
          "force": false
        },
        "FLEX_CONTROLS": {
          "override": true
        },
        "RATES": {
          "override": true
        }
      },
      "payment_datetime": "2023-03-10T19:05:56.743Z",
      "business_date": "2023-03-09",
      "earmark_id": "dadaab22-6e28-4746-8440-0caa030f0f3f"
    }
  ],
  "credits": [
    {
      "amount": 86753.09,
      "currency": "USD",
      "external_account_id": "289",
      "processing_code": "220035",
      "soft_descriptor": "ACME Inc. - Invoice 2938",
      "validation_rules": {
        "ACCOUNT_STATUS": {
          "override": false
        },
        "LEDGER": {
          "force": false
        },
        "FLEX_CONTROLS": {
          "override": true
        },
        "RATES": {
          "override": true
        }
      },
      "payment_datetime": "2023-03-10T19:05:56.743Z",
      "business_date": "2023-03-09"
    }
  ]
}

Response

Accepted

tracking_idstring

Customer created tracking ID. Must consist of alphanumeric characters (a-z, A-Z, 0-9), hyphens (-), and colons (:), with a length from 1 to 128. The Pismo platform uses this field to implement idempotency and prevent duplicates.