Orchestration payments

Get orchestration notification

Gets a given orchestration payment notification by UUID.

get/v4/orchestration/payment/notification/{uuid}

Request

Base URL
//[domainPrefix].ripplexcurrent.com/v4 (relative, and it does not resolve against the document’s source URL)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/ripple/apis/ripplenet-server-api/docs/v4/orchestration/payment/notification/:uuid/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

uuidstring uuid required

The UUID of the orchestration payment notification.

Response

Successfully fetched orchestration paymnet notification.

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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.