AM/TA/Inv - Mark Payment Batch as Executed

Details

/external/v1/payment/batch-execute

Synopsis

Mark Payment Batch as Executed

put

This route is used to trigger the process to mark a list of payments of a given security as executed. It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints. This endpoint can be invoked if the security is in one of the following statuses: ["active","completed","approved_revert_to_active","closed","cancel_in_progress","canceled","refund_in_progress"]. This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider","investor"]. This endpoint can't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "managePayment".

Required scopes

This endpoint requires the following scopes:

• : managePayment

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

Responses

200

Successfully triggered the process to execute a list of payments.The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

application/json

400

The following error codes can be returned: - GN0002 - IS0008 - PA0009 - PA0006 - PA0008 - AS0013 - PA0012 - TX0006 - AS0042 - AS0043 - AS0018 - AS0029 - AS0044 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 - AU0003 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 - IS0099 - PA0020 Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned: - IS0009 - PA0010 - PA0019 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - IS0013 - IS0012 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/payment/batch-execute

HTTPcURLJavaScriptPython

PUT /external/v1/payment/batch-execute HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 694

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "paymentsData": [
    {
      "paymentIdentifier": {
        "paymentId": "USS3JKS01I00"
      },
      "wireId": "20250807ABC123456789",
      "sourceAccount": {
        "orgId": "US9QIMA",
        "accountIdentifier": {
          "accountId": "USS3JKS01I00"
        }
      },
      "targetAccount": {
        "orgId": "US9QIMA",
        "accountIdentifier": {
          "accountId": "USS3JKS01I01"
        }
      },
      "method": "Wire"
    },
    {
      "paymentIdentifier": {
        "correlationIdentifier": {
          "correlationId": "USS3JKS01I00"
        }
      },
      "wireId": "20250807ABC123456781",
      "sourceAccount": {
        "orgId": "US9QIMA",
        "accountIdentifier": {
          "accountId": "USS3JKS01I00"
        }
      },
      "targetAccount": {
        "orgId": "US9QIMA",
        "accountIdentifier": {
          "accountId": "USS3JKS01I01"
        }
      },
      "method": "Wire"
    }
  ]
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}