---
title: "Get orchestration payments"
method: GET
path: "/v4/orchestration/payment"
tags: ["Orchestration payments"]
---

# Get orchestration payments

`GET /v4/orchestration/payment`

Gets a list of orchestration payments.

## Query parameters

- `page` integer
- `size` integer
- `sort_field` 'CREATED_AT' | 'MODIFIED_AT'
- `sort_direction` 'ASC' | 'DESC'
- `unique_reference_number` string
- `orchestration_status` 'INITIAL' | 'RUNNING' | 'COMPLETED' | 'PAUSED' | 'FAILURE' | 'DECLINED' | 'RETRY'
- `range_field` string
- `before` string
- `after` string

## Response `200`

Successfully fetched all orchestration payments.

- OrchestrationPayments — Paginated response base object.
  - `first` boolean — true if this is the first page.
  - `last` boolean — true if this is the last page.
  - `number` integer — page number
  - `numberOfElements` integer — Number Of elements in this request
  - `size` integer — page size
  - `totalElements` integer — Total number of elements for the given request
  - `totalPages` integer — Total number of pages for the given request
  - `sort` Sort[] — Sort details of this page
    - `direction` string — Direction of the sort
    - `property` string
    - `ignoreCase` boolean
    - `nullHandling` string
    - `ascending` boolean
    - `descending` boolean
  - `content` OrchestrationPaymentResponse[]
    - `uuid` string, uuid — Unique Identifier of the orchestration payment.
    - `unique_reference_number` string — Unique reference number.
    - `sender_end_to_end_id` string — Sender end-to-end ID.
    - `payment_type` 'REGULAR' | 'RETURN' | 'REVERSAL' — The payment type for the payment.
    - `connector_role` 'SENDING' | 'RECEIVING' | 'INTERMEDIARY' — The connector role for payment.
    - `payment_id` string — Payment ID for the transaction in RippleNet.
    - `payment_status` string — Status of the payment.
    - `previous_payment_status` string — Previous status of the payment.
    - `orchestration_template` string — Template name used for executing the orchestration payment.
    - `orchestration_status` string — Status of the orchestration payment.
    - `current_activity` string — Current activity which is being executed.
    - `current_activity_status` string — Status of the current activity.
    - `initial_context` object — Initial context for the orchestration payment.
    - `current_context` object — Current context of the orchestration payment.
    - `error_message` object — Error message in case of any error.
    - `activity_list` object — Activity list of the activities executed so far.
    - `created_at` string, date-time — Date and time at which the orchestration payment was created, as an ISO-8601 timestamp in UTC.
    - `modified_at` string, date-time — Date and time at which the orchestration payment was modified, as an ISO-8601 timestamp in UTC.

---

[API](https://skmtc.net/ripple/apis/ripplenet-server-api.md) · [All operations](https://skmtc.net/ripple/apis/ripplenet-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripplenet-server-api/revisions/7843f07ca150/schema)