---
title: "Post action to orchestration payment"
method: POST
path: "/v4/orchestration/payment/action"
tags: ["Orchestration payments"]
---

# Post action to orchestration payment

`POST /v4/orchestration/payment/action`

Posts action into the Orchestration service.

## Request body

- PaymentActionRequest
  - `unique_reference_number` string, required — Set to the unique reference number associated with the payment.
  - `status` 'SUCCESS' | 'FAILURE' | 'DECLINED' | 'REDO' | 'SUBSTATE' | 'NOTIFY' | 'PENDING' | 'SUBTASK', required — Activity status
  - `notification_type` string, 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<br/><br/>Use with `output.sub_state` to provide additional information. |
  - `output` ActivityOutput — Use this object when `notification_type` is `PARTNER_SUBSTATE`. For all other values of `notification_type`, this property can be null.
    - `sub_state` string — Free-form string that describes a sub-state of the payment while it is in the `EXECUTED` state, for example, `FORWARDED` or `AWAITING_COLLECTION`. Displays as a `label` value in the `labels` array. Also displays as the `key` value in the receiving node's `user_info.executed` array.
    - `memo` string — Free-form details that describe the `sub_state` of the payment, for example, `with courier heading to payout location`. Displays as the `value` value in the receiving node's `user_info.executed` array.
    - `info` object — Provide one or more arbitrary key/value pairs.
  - `error` ActivityError[] — 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.
    - `type` string — For recommended type values, see [Returns and failure codes](/products/payments-odl/api-docs/ripplenet/resources/error-codes/returns-and-error-codes/).
    - `code` string — For recommended failure codes, see [Returns and failure codes](/products/payments-odl/api-docs/ripplenet/resources/error-codes/returns-and-error-codes/#812-failure-type-codes).
    - `reason` string — The reason for the failure or lock decline.

## Response `201`

Successfully posted action.

- PaymentActionResponse — JSON response object that represents a payment action query ID.
  - `unique_reference_number` string — Unique Reference Number.

---

[API](https://skmtc.net/ripple/apis/ripplenet-server-api.md) · [All operations](https://skmtc.net/ripple/apis/ripplenet-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripplenet-server-api/revisions/7843f07ca150/schema)