Skip to content

Get orchestration notification

Request

Gets a given orchestration payment notification by UUID.

Security
Bearer
Path
uuidstring, (uuid)required

The UUID of the orchestration payment notification.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/v4/orchestration/payment/notification/{uuid}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully fetched orchestration paymnet notification.

Bodyapplication/json
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" }