Get orchestration notifications by status

Request

Gets a list of orchestration payment notifications with a given status.

Security

Bearer

Query

statusstringrequired

The 'status' of the notifications to retrieve.

Enum:"NEW""SENT"

sizeinteger, [ 1 .. 100 ]

Number of objects to return per page.

Default:10

delay_timeinteger

Delay time in minutes to retrieve the SENT notifications.

Default:30

range_fieldstring

Range Field

Designates the column name of the notifications database table that is used for filtering notifications 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 notifications objects: YYYY-MM-DDTHH:mm:ss.sssZ) as the value for before and/or after to fetch notifications before, after, or between the specified time range(s) (inclusive).

Dependency: If range_field is specified, before and/or after must also be specified.

beforestring

Before time stamp

Filters for notifications where the notifications 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 notifications where the notifications 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/notification?status=NEW&size=10&delay_time=30&range_field=string&before=string&after=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully fetched orchestration payment notifications list.

Bodyapplication/json

Array [

uuidstring, (uuid)

Unique Identifier of the orchestration payment notification.

Example:"5492648d-2132-4e70-9ded-2fc86f22b321"

notification_typestring

Type of the orchestration payment notification.

Example:"PAYMENT_SUCCESS"

notification_versionstring

Version of the orchestration payment notification.

Example:1

notification_statusstring

Orchestration payment notification status.

Enum:"NEW""SENT""ACK"

notification_payloadobject

Orchestration payment notification payload.

created_atstring, (date-time)

Date and time at which the message was created, as an ISO-8601 timestamp in UTC.

Example:"2018-04-06T20:33:35Z"

modified_atstring, (date-time)

Date and time at which the message was modified, as an ISO-8601 timestamp in UTC.

Example:"2018-04-06T20:33:35Z"

]

Response

[
  {
    "uuid": "5492648d-2132-4e70-9ded-2fc86f22b321",
    "notification_type": "PAYMENT_SUCCESS",
    "notification_version": 1,
    "notification_status": "NEW",
    "notification_payload": {},
    "created_at": "2018-04-06T20:33:35Z",
    "modified_at": "2018-04-06T20:33:35Z"
  }
]