Post action to orchestration payment

Request

Posts action into the Orchestration service.

Security

Bearer

Bodyapplication/jsonrequired

unique_reference_numberstring, [ 1 .. 64 ] characters^[a-zA-Z0-9@_,:\s-]*$required

Set to the unique reference number associated with the payment.

Example:"310000015"

statusstringrequired

Activity status

Enum Value	Description
SUCCESS	Set status to success
FAILURE	Set status to failure Use with the `error` field to provide additional information.
DECLINED	Set status to declined Use with the `error` field to provide additional information.
REDO	Set status to redo
SUBSTATE	Set status to substate
NOTIFY	Set status to notify
PENDING	Set status to pending
SUBTASK	Set status to subtask

Example:"SUBSTATE"

notification_typestring, [ 1 .. 128 ] characters^[a-zA-Z0-9_:]*$required

Activity context name.

Use with the status parameter to define the action.

Recommended values:

Value	Notification type
CONFIRM_LOCK	Confirm the lock
CONFIRM_SETTLE	Confirm settlement
CONFIRM_COMPLETE	Confirm completion
PARTNER_SUBSTATE	Notify on partner substate Use with `output.sub_state` to provide additional information.

Example:"PARTNER_SUBSTATE"

outputobject

Use this object when notification_type is PARTNER_SUBSTATE.

For all other values of notification_type, this property can be null.

errorArray of objects

Array of one or more activity error objects.

When status is FAILURE or DECLINED, use this to fail a payment or decline a request to lock a payment.

For all other status values, this property can be null.

Example:"null"

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/v4/orchestration/payment/action \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "unique_reference_number": "310000015",
    "status": "SUBSTATE",
    "notification_type": "PARTNER_SUBSTATE",
    "output": {
      "sub_state": "AMENDED",
      "memo": "Last name must be corrected",
      "info": {
        "last_name": "Gonzales"
      }
    },
    "error": "null"
  }'

Responses

Successfully posted action.

Bodyapplication/json

unique_reference_numberstring

Unique Reference Number.

Example:"00310000015"

Response

{
  "unique_reference_number": "00310000015"
}