Get orchestration payments

Request

Gets a list of orchestration payments.

Security

Bearer

Query

pageinteger

The page number for paginated results.

The value is zero-based, where 0 represents the first page.

Set it to 0 to get the first page of results.

sizeinteger, [ 1 .. 100 ]

Number of objects to return per page.

Default:10

sort_fieldstring

Attribute to sort the results on.

Enum:	Sort by
CREATED_AT	Created date-time
MODIFIED_AT	Modified date-time

Default:"MODIFIED_AT"

Enum:"CREATED_AT""MODIFIED_AT"

sort_directionstring

Direction of sorted results based on sort_field.

Enum:	Description
ASC	Sort ascending
DESC	Sort descending

Default:"ASC"

Enum:"ASC""DESC"

unique_reference_numberstring

Parameter for filtering with unique reference number.

orchestration_statusstring

Parameter for filtering with status of the orchestration payment.

Enum	Description
INITIAL	Filter by payments in the initial state
RUNNING	Filter by payments in the running state
COMPLETED	Filter by completed payments
PAUSED	Filter by paused payments
FAILURE	Filter by payment failures
DECLINED	Filter by declined payments
RETRY	Filter by payments that have a retry status

Enum:"INITIAL""RUNNING""COMPLETED""PAUSED""FAILURE""DECLINED""RETRY"

range_fieldstring

Range field

Designates the column name of the payments database table that is used for filtering payments before/after/between time stamps.

The following options are valid:

Range field	Description
CREATED_AT	Filter by created date-time
MODIFIED_AT	Filter by modified date-time

Example usage

If you specify range_field = MODIFIED_AT, you need to specify a time stamp (in the 24 character ISO 8601 format used in payment objects: YYYY-MM-DDTHH:mm:ss.sssZ) as the value for before and/or after to fetch payments before, after, or between the specified time range(s) (inclusive).

Dependency: If you specify range_field, you must also specify before and/or after.

beforestring

Before time stamp

Filters for payments where the range_field column value is before this specified time stamp (inclusive).

You can also specify after to create a time range between after and before.

Dependency: If you specify before, you must also specify range_field.

Example: 2023-10-13T10:16:29.000Z

afterstring

After time stamp

Filters for payments where the range_field column value is after this specified time stamp (inclusive).

You can also specify before to create a time range between after and before.

Dependency: If you specify after, you must also specify range_field.

Example: 2023-10-13T10:16:29.000Z

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/v4/orchestration/payment?page=0&size=10&sort_field=CREATED_AT&sort_direction=ASC&unique_reference_number=string&orchestration_status=INITIAL&range_field=string&before=string&after=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully fetched all orchestration payments.

Bodyapplication/json

firstboolean

true if this is the first page.

lastboolean

true if this is the last page.

numberinteger

page number

numberOfElementsinteger

Number Of elements in this request

sizeinteger

page size

totalElementsinteger, (int64)

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

sortArray of objects

Sort details of this page

contentArray of objects

Response

{
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": [
    { … }
  ],
  "content": [
    { … }
  ]
}