PIpismo
Payments

Get multi-leg payment status

Enables users to query the processing status of a multi-leg payment.

get/corporate/v3/payments/multileg/{multilegId}

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/corporate/v3/payments/multileg/{multilegId}
  • Auth
    HTTP bearer

Path parameters

multilegIdstring required

Multileg ID provided when the multileg payment is created.

Response

Successful response

multileg_idstring required

A unique multileg payment identifier provided by the client. If an existing multileg_id already exists in the system, the API returns a 409 error.

This field is:

  • Unique within the Organization.
  • Immutable — It can't be updated.
  • Not recyclable — You can't reuse a multileg_id.
status'CREATING' | 'EXECUTING' | 'DEBITS_EXECUTED' | 'CREDITS_FAILED' | 'FINISHED' | 'ROLLING_BACK' | 'ROLLED_BACK' | 'ROLLBACK_FAILED' | 'TIMED_OUT' required

Status of the multi-leg processing.<br>

  • CREATING: The multileg payment request has been received and queued for execution.
  • EXECUTING: Asynchronous processing of the multileg payment has started.
  • DEBITS_EXECUTED: All debit legs have been successfully executed; credit leg processing is still in progress.
  • CREDITS_FAILED: Used in v2 when one or more credit legs failed. This status is no longer used in v3, but remains in the API for queries on payments created via the V2 endpoint.
  • FINISHED: All payment legs were processed successfully.
  • ROLLING_BACK: One or more payment legs failed, and the rollback process has begun.
  • ROLLED_BACK: One or more payment legs failed, and all successful legs were rolled back.
  • ROLLBACK_FAILED: One or more payment legs failed, rollback was attempted, but the rollback of some legs was unsuccessful.
  • TIMED_OUT: Processing did not complete because the multileg execution timed out.

Example response

{
  "multileg_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e245",
  "status": "CREATING",
  "debits": [
    {
      "tracking_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244",
      "external_account_id": "289",
      "status": "PENDING",
      "event_datetime": "2023-04-27T12:01:24Z",
      "error": {
        "status": 400,
        "code": "WPMT0017",
        "message": "Invalid JSON payload received: Error unmarshalling request"
      },
      "rollback": {
        "tracking_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244",
        "event_datetime": "2023-04-27T12:01:24Z",
        "error": {
          "status": 400,
          "code": "WPMT0017",
          "message": "Invalid JSON payload received: Error unmarshalling request"
        }
      }
    }
  ],
  "credits": [
    {
      "tracking_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244",
      "external_account_id": "289",
      "status": "PENDING",
      "event_datetime": "2023-04-27T12:01:24Z",
      "error": {
        "status": 400,
        "code": "WPMT0017",
        "message": "Invalid JSON payload received: Error unmarshalling request"
      },
      "rollback": {
        "tracking_id": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244",
        "event_datetime": "2023-04-27T12:01:24Z",
        "error": {
          "status": 400,
          "code": "WPMT0017",
          "message": "Invalid JSON payload received: Error unmarshalling request"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.