Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Orchestration payments

Post action to orchestration payment

Posts action into the Orchestration service.

post/v4/orchestration/payment/action

Request body

unique_reference_numberstring required

Set to the unique reference number associated with the payment.

status'SUCCESS' | 'FAILURE' | 'DECLINED' | 'REDO' | 'SUBSTATE' | 'NOTIFY' | 'PENDING' | 'SUBTASK' required

Activity status

notification_typestring required

Activity context name.

Use with the status parameter to define the action.

Recommended values:

ValueNotification type
CONFIRM_LOCKConfirm the lock
CONFIRM_SETTLEConfirm settlement
CONFIRM_COMPLETEConfirm completion
PARTNER_SUBSTATENotify 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"
}