v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB

Orchestration payments

Get orchestration notifications by status

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

get/v4/orchestration/payment/notification

Query parameters

status'NEW' | 'SENT' required

The 'status' of the notifications to retrieve.

sizeinteger

Number of objects to return per page.

delay_timeinteger

Delay time in minutes to retrieve the SENT notifications.

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

Response

Successfully fetched orchestration payment notifications list.

uuidstring uuid

Unique Identifier of the orchestration payment notification.

notification_typestring

Type of the orchestration payment notification.

notification_versionstring

Version of the orchestration payment notification.

notification_status'NEW' | 'SENT' | 'ACK'

Orchestration payment notification status.

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.

modified_atstring date-time

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

Example response

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