Skip to main content
POST
/
v1
/
createBatchPayment
CreateBatchPayment
curl --request POST \
  --url https://api.mpcvault.com/v1/createBatchPayment \
  --header 'Content-Type: application/json' \
  --header 'x-mtoken: <api-key>' \
  --data '
{
  "btcBatchSendNative": {
    "from": "<string>",
    "recipients": [
      {
        "address": "<string>",
        "amount": "<string>",
        "notes": "<string>"
      }
    ]
  },
  "name": "<string>",
  "notes": "<string>"
}
'
{
  "batchPayment": {
    "btcBatchSendNative": {
      "from": "<string>",
      "recipients": [
        {
          "address": "<string>",
          "amount": "<string>",
          "notes": "<string>"
        }
      ]
    },
    "uuid": "<string>",
    "name": "<string>",
    "notes": "<string>",
    "failedReason": "<string>",
    "creationTimestamp": 123,
    "approvalSigningRequest": {
      "aptosMessage": {
        "from": "<string>",
        "content": {
          "address": "<string>",
          "application": "<string>",
          "chainId": "<string>",
          "message": "<string>",
          "nonce": "<string>"
        }
      },
      "uuid": "<string>",
      "failedReason": "<string>",
      "txHash": "<string>",
      "creationTimestamp": 123,
      "notes": "<string>",
      "vaultUuid": "<string>",
      "callbackClientSignerPublicKey": "<string>",
      "simulation": "aSDinaTvuI8gbWludGxpZnk=",
      "evmInputDataDecode": {
        "function": "<string>",
        "args": [
          {
            "name": "<string>",
            "type": "<string>",
            "data": "<string>"
          }
        ]
      }
    },
    "sendSigningRequest": {
      "aptosMessage": {
        "from": "<string>",
        "content": {
          "address": "<string>",
          "application": "<string>",
          "chainId": "<string>",
          "message": "<string>",
          "nonce": "<string>"
        }
      },
      "uuid": "<string>",
      "failedReason": "<string>",
      "txHash": "<string>",
      "creationTimestamp": 123,
      "notes": "<string>",
      "vaultUuid": "<string>",
      "callbackClientSignerPublicKey": "<string>",
      "simulation": "aSDinaTvuI8gbWludGxpZnk=",
      "evmInputDataDecode": {
        "function": "<string>",
        "args": [
          {
            "name": "<string>",
            "type": "<string>",
            "data": "<string>"
          }
        ]
      }
    }
  },
  "error": {
    "message": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.mpcvault.com/llms.txt

Use this file to discover all available pages before exploring further.

Creates a batch payment in a single request. Complete and send the batch payment in the MPCVault web app. In the Try It playground, select a batch type from the tabs and fill in the required fields.

Authorizations

​
x-mtoken
string
header
required

Your API token. Required for all API requests.

Body

application/json
​
btcBatchSendNative
object
required
​
name
string

symbol_value:"Monthly payroll" comment:name is the name of the batch payment.

​
notes
string

symbol_value:"Monthly payroll" comment:notes is the transaction notes for the batch payment.

Response

200 - application/json

Success

​
batchPayment
btc_batch_send_native · object
​
error
execute_signing_requests_error_code · object