AM/TA/Inv - Create Payments Batch Transaction

Details

/external/v1/payment/batch-create

Synopsis

Create Payments Batch Transaction

post

This route is used to create payments transactions on the blockchain for a particular security. 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

201

Successfully triggered the process to create 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 - PA0001 - PA0018 - TX0006 - PA0003 - AC0062 - AC0068 - AC0067 - AC0044 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 - AC0001 - AC0002 - GN0008 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 - PA0004 - PA0002 Please refer to the error code dictionary for the details of each error code.

application/json

post

/external/v1/payment/batch-create

HTTPcURLJavaScriptPython

POST /external/v1/payment/batch-create HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "paymentsData": [
    {
      "sourceAccount": {
        "orgId": "US9QIMA",
        "accountIdentifier": {
          "accountId": "USS3JKS01I00"
        }
      },
      "targetAccount": {
        "orgId": "US9QIMA",
        "accountIdentifier": {
          "accountId": "USS3JKS01I01"
        }
      },
      "amount": 10000.5,
      "method": "Wire",
      "description": "Payment for invoice 12345"
    }
  ]
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "paymentIds": [
    "US9QIFILE1",
    "US9QIFILE2"
  ]
}