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:

Each leg generates the following events:

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body

string
required
length between 1 and 43

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.
metadata
object

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

debits
array of objects
debits
credits
array of objects
credits
boolean

Whether funds are available when payment is posted.

Responses

403

The request has been lost

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json