Orchestration payments

Post action to orchestration payment

Posts action into the Orchestration service.

post/v4/orchestration/payment/action

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

Request body

unique_reference_numberstring required

Set to the unique reference number associated with the payment.

Activity status

notification_typestring 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.

Example request

{
  "unique_reference_number": "310000015",
  "status": "SUBSTATE",
  "notification_type": "PARTNER_SUBSTATE",
  "output": {
    "sub_state": "AMENDED",
    "memo": "Last name must be corrected",
    "info": {
      "last_name": "Gonzales"
    }
  }
}

Response

Successfully posted action.

unique_reference_numberstring

Unique Reference Number.

Example response

{
  "unique_reference_number": "00310000015"
}

Changes

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