Pular para o conteúdo

Get orchestration payment without user info

Requisição

Gets orchestration payment without user info by unique reference number.

Segurança
Bearer
Caminho
uniqueReferenceNumberstring, (String), [ 1 .. 64 ] characters^[a-zA-Z0-9@_,:\s-]*$obrigatório

Unique reference number of the orchestration payment to fetch.

curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/internal/payment/{uniqueReferenceNumber}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respostas

Successfully returned orchestration payment.

Corpo*/*
uuidstring, (uuid)

Unique Identifier of the orchestration payment.

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

Unique reference number.

Exemplo:"00310000015"
sender_end_to_end_idstring

Sender end-to-end ID.

Exemplo:"00310000015"
payment_typestring

The payment type for the payment.

Enum:"REGULAR""RETURN""REVERSAL"
connector_rolestring

The connector role for payment.

Enum:"SENDING""RECEIVING""INTERMEDIARY"
payment_idstring

Payment ID for the transaction in RippleNet.

Exemplo:"26bf269b-1a2b-c3d4-872a-7f18d7dcf9f2"
payment_statusstring

Status of the payment.

Exemplo:"SUCCESS"
previous_payment_statusstring

Previous status of the payment.

Exemplo:"EXECUTED"
orchestration_templatestring

Template name used for executing the orchestration payment.

Exemplo:"default_template"
orchestration_statusstring

Status of the orchestration payment.

Exemplo:"RUNNING"
current_activitystring

Current activity which is being executed.

Exemplo:"get_quote_v1"
current_activity_statusstring

Status of the current activity.

Exemplo:"SUCCESS"
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.

Exemplo:"2018-04-06T20:33:35Z"
modified_atstring, (date-time)

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

Exemplo:"2018-04-06T20:33:35Z"
Resposta
{
  "uuid": "5492648d-2132-4e70-9ded-2fc86f22b321",
  "unique_reference_number": "00310000015",
  "sender_end_to_end_id": "00310000015",
  "payment_type": "REGULAR",
  "connector_role": "SENDING",
  "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",
  "initial_context": {},
  "current_context": {},
  "error_message": {},
  "activity_list": {},
  "created_at": "2018-04-06T20:33:35Z",
  "modified_at": "2018-04-06T20:33:35Z"
}