Orchestration payments

Get orchestration payment

Gets orchestration payment by unique reference number.

get/v4/orchestration/payment/{uniqueReferenceNumber}

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/:uniqueReferenceNumber/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

uniqueReferenceNumberstring String required

Unique reference number of the orchestration payment to fetch.

Response

Successfully returned orchestration payment.

uuidstring uuid

Unique Identifier of the orchestration payment.

unique_reference_numberstring

Unique reference number.

sender_end_to_end_idstring

Sender end-to-end ID.

payment_type'REGULAR' | 'RETURN' | 'REVERSAL'

The payment type for the payment.

connector_role'SENDING' | 'RECEIVING' | 'INTERMEDIARY'

The connector role for payment.

payment_idstring

Payment ID for the transaction in RippleNet.

payment_statusstring

Status of the payment.

previous_payment_statusstring

Previous status of the payment.

orchestration_templatestring

Template name used for executing the orchestration payment.

orchestration_statusstring

Status of the orchestration payment.

current_activitystring

Current activity which is being executed.

current_activity_statusstring

Status of the current activity.

initial_contextobject

Initial context for the orchestration payment.

current_contextobject

Current context of the orchestration payment.

error_messageobject

Error message in case of any error.

activity_listobject

Activity list of the activities executed so far.

created_atstring date-time

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

modified_atstring date-time

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

Example response

{
  "uuid": "5492648d-2132-4e70-9ded-2fc86f22b321",
  "unique_reference_number": "00310000015",
  "sender_end_to_end_id": "00310000015",
  "payment_id": "26bf269b-1a2b-c3d4-872a-7f18d7dcf9f2",
  "payment_status": "SUCCESS",
  "previous_payment_status": "EXECUTED",
  "orchestration_template": "default_template",
  "orchestration_status": "RUNNING",
  "current_activity": "get_quote_v1",
  "current_activity_status": "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.