AM/TA/Inv - Mark Payment Batch as Settled

Details

/external/v1/payment/batch-settle

Synopsis

Mark Payment Batch as Settled

put

This route is used to trigger the process to mark a list of payments of a given security as settled. It will also trigger the settlement of all the associated entities (if needed). 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 mark payments as settled.The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

application/json

processIdstringRequired

This is used to uniquely identity a transaction process on this system.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

orchestrationIdstringRequired

The orchestration id. It is used to uniquely identity a group of transactions that are being orchestrated following an action request.If a processId was passed as an input to the action, it will be returned on this property.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

400

The following error codes can be returned: - GN0002 - IS0008 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 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 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-settle

HTTPcURLJavaScriptPython

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

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "paymentIdentifiers": [
    {
      "paymentId": "USS3JKS01I00"
    },
    {
      "correlationIdentifier": {
        "correlationId": "1234567"
      }
    }
  ]
}

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