Skip to Content
DocumentationREST APIBatch paymentGet batch payment details

Get batch payment details

Gets the details of a batch payment, including associated signing requests.

POST /v1/getBatchPaymentDetails

Body
uuidstring
uuid is the unique identifier of the batch payment.
Example:
{
uuid: 9f5ee5fb-07f5-470c-a2ff-081e2d6d107a
}
Response
batchPaymentobject
uuidstring
uuid is the unique identifier of the batch payment.
namestring
name is the name of the batch payment.
notesstring
notes is the transaction notes for the batch payment.
status is the status of the batch payment.
failedReasonstring
failed_reason is the reason why the batch payment failed, only set if status is STATUS_FAILED.
creationTimestampuint64
creation_timestamp is the timestamp when the batch payment was created.
approvalSigningRequestobject
uuidstring
uuid is the unique identifier of the signing request.
status is the status of the signing request. STATUS_SUCCEEDED only means that the signing request has been signed.it does not mean that the transaction itself is successful.
failedReasonstring
failed_reason is the reason why the signing request failed, only set if status is STATUS_FAILED.
txHashstring
tx_hash is the hash of the transaction, only set if status is STATUS_SUCCEEDED.This does not mean that the transaction it self is successful. It only means that the signing request has been signed.
creationTimestampuint64
creation_timestamp is the timestamp when the signing request was created.
string
type is the type of the signing request. It is a oneof field.
notesstring
notes is the transaction notes for the signing request.
vaultUuidstring
vault_uuid is the UUID of the vault that the signing request was created in.
callbackClientSignerPublicKeystring
callback_client_signer_public_key is the public key of the api client signer for callback. This field can be empty.
simulationbytes
simulation is the transaction simulation for the signing request.
evmInputDataDecodeobject
functionstring
function is the name of the function to be called.
args[]EVMInputDataDecode.Argument
args is the list of arguments to be passed to the function.
sendSigningRequestobject
uuidstring
uuid is the unique identifier of the signing request.
status is the status of the signing request. STATUS_SUCCEEDED only means that the signing request has been signed.it does not mean that the transaction itself is successful.
failedReasonstring
failed_reason is the reason why the signing request failed, only set if status is STATUS_FAILED.
txHashstring
tx_hash is the hash of the transaction, only set if status is STATUS_SUCCEEDED.This does not mean that the transaction it self is successful. It only means that the signing request has been signed.
creationTimestampuint64
creation_timestamp is the timestamp when the signing request was created.
string
type is the type of the signing request. It is a oneof field.
notesstring
notes is the transaction notes for the signing request.
vaultUuidstring
vault_uuid is the UUID of the vault that the signing request was created in.
callbackClientSignerPublicKeystring
callback_client_signer_public_key is the public key of the api client signer for callback. This field can be empty.
simulationbytes
simulation is the transaction simulation for the signing request.
evmInputDataDecodeobject
functionstring
function is the name of the function to be called.
args[]EVMInputDataDecode.Argument
args is the list of arguments to be passed to the function.
string
type is the type of the batch payment. It is a oneof field.
errorError
Example:
{
batchPayment:
{
uuid: 9f5ee5fb-07f5-470c-a2ff-081e2d6d107a
name: name1
notes: notes test
status: 0
failedReason: failed reason
creationTimestamp: 1744274467154
approvalSigningRequest:
{
uuid: bb6f129f-bbe3-4d95-9f33-c32812e3e1c4
status: 0
failedReason: failed reason
txHash: 3Eq21vXNB5s86c62bVuUfTerseghjkuUqRPBmGRJhyTA
creationTimestamp: 1744274467154
evmSendNative:
{
chainId: 137
from: 0x71C7656EC7ab88bd32g47dgdhhssq245f6d8976F
to: 0x71C7656EC7ab88bd32g47dgdhhssq245f6d8976F
value: 1000000000000000
gasFee:
{
maxFee: 0.1
maxPriorityFee: 1500000000
gasLimit: 30000000000
}
nonce: 1
}
notes: send 1 eth to 0x71C7656EC7ab88bd32g47dgdhhssq245f6d8976F
vaultUuid: 9f5ee5fb-07f5-470c-a2ff-081e2d6d107a
callbackClientSignerPublicKey: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIL3OzFAKNGHsMtBpTemiAI3V1AxRs de g h j c m k i da g d k test
simulation: eyJtZXNzYWdlcyI6W3siYWRkcmVzcyI6IkVRRC1IR09CYlh4dzNQWWQ4SzM5TXN3SlZYN1lvb19oM1FTRWl1cFdFUXA2dWlOVSIsImFtb3VudCI6IjE5MDAwMDAwMCIsInBheWxvYWQiOiJ0ZTZjY2tFQkFnRUFwZ0FCckErS2ZxVUFBQUJUVVpIL0ZpQStpQUR2TzVrQ29uR3lvQnlKT0tVanorSk9jWVI2cnJhbUlBQWUxRXAzckE1d25RQWhCUlhOT04yMUFHa1NqN0hVaUJ5N0F2UHBwYmVialh2NWl0Z1h3VnpzSE1nTzVyS0JBUUNWSlpPRllZQUNLaGFqRmt4TldxTVRQekVRL3hCSmJnREtpc2lyNy94UUorQWswelNBdytZRWllc0FJUVVWelRqZHRRQnBFbyt4MUlnY3V3THo2YVczbTQxNytZcllGOEZjN0J6UUZKNjVtZz09In1dLCJ2YWxpZF91bnRpbCI6MTcyMjQ3NzQ3MDU4MiwiZnJvbSI6IjA6eDg0MTQ1NzM0RTM3NkQ0MDFBNDRBM0VDNzUyMjA3MkVDMEJDRkE2OTZERTZFMzVFRkU2MkI2MDVGMDU3M0IwNzMiLCJuZXR3b3JrIjoiLTIzOSJ9
evmInputDataDecode:
{
function: function_name(arg1_type arg1_value, arg2_type arg2_value, ...)
args: [{name: arg1_name, type: arg1_type, data: arg1_value}, {name: arg2_name, type: arg2_type, data: arg2_value}]
}
}
sendSigningRequest:
{
uuid: bb6f129f-bbe3-4d95-9f33-c32812e3e1c4
status: 0
failedReason: failed reason
txHash: 3Eq21vXNB5s86c62bVuUfTerseghjkuUqRPBmGRJhyTA
creationTimestamp: 1744274467154
evmSendNative:
{
chainId: 137
from: 0x71C7656EC7ab88bd32g47dgdhhssq245f6d8976F
to: 0x71C7656EC7ab88bd32g47dgdhhssq245f6d8976F
value: 1000000000000000
gasFee:
{
maxFee: 0.1
maxPriorityFee: 1500000000
gasLimit: 30000000000
}
nonce: 1
}
notes: send 1 eth to 0x71C7656EC7ab88bd32g47dgdhhssq245f6d8976F
vaultUuid: 9f5ee5fb-07f5-470c-a2ff-081e2d6d107a
callbackClientSignerPublicKey: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIL3OzFAKNGHsMtBpTemiAI3V1AxRs de g h j c m k i da g d k test
simulation: eyJtZXNzYWdlcyI6W3siYWRkcmVzcyI6IkVRRC1IR09CYlh4dzNQWWQ4SzM5TXN3SlZYN1lvb19oM1FTRWl1cFdFUXA2dWlOVSIsImFtb3VudCI6IjE5MDAwMDAwMCIsInBheWxvYWQiOiJ0ZTZjY2tFQkFnRUFwZ0FCckErS2ZxVUFBQUJUVVpIL0ZpQStpQUR2TzVrQ29uR3lvQnlKT0tVanorSk9jWVI2cnJhbUlBQWUxRXAzckE1d25RQWhCUlhOT04yMUFHa1NqN0hVaUJ5N0F2UHBwYmVialh2NWl0Z1h3VnpzSE1nTzVyS0JBUUNWSlpPRllZQUNLaGFqRmt4TldxTVRQekVRL3hCSmJnREtpc2lyNy94UUorQWswelNBdytZRWllc0FJUVVWelRqZHRRQnBFbyt4MUlnY3V3THo2YVczbTQxNytZcllGOEZjN0J6UUZKNjVtZz09In1dLCJ2YWxpZF91bnRpbCI6MTcyMjQ3NzQ3MDU4MiwiZnJvbSI6IjA6eDg0MTQ1NzM0RTM3NkQ0MDFBNDRBM0VDNzUyMjA3MkVDMEJDRkE2OTZERTZFMzVFRkU2MkI2MDVGMDU3M0IwNzMiLCJuZXR3b3JrIjoiLTIzOSJ9
evmInputDataDecode:
{
function: function_name(arg1_type arg1_value, arg2_type arg2_value, ...)
args: [{name: arg1_name, type: arg1_type, data: arg1_value}, {name: arg2_name, type: arg2_type, data: arg2_value}]
}
}
evmBatchSendNative:
{
chainId: 137
from: 0x71C7656EC7ab88bd32g47dgdhhssq245f6d8976F
recipients: [{address: 0x71C7656EC7ab88bd32g47dgdhhssq245f6d8976F, amount: 0.001, notes: Monthly payroll}]
}
}
error:
}

enum_types

enum mpcvault.platform.v1.NetworkType

0
NETWORK_TYPE_UNKNOWN
1
NETWORK_TYPE_EVM
2
NETWORK_TYPE_BITCOIN
3
NETWORK_TYPE_TRON
4
NETWORK_TYPE_APTOS
5
NETWORK_TYPE_SUI
6
NETWORK_TYPE_SOLANA
7
NETWORK_TYPE_TON

enum mpcvault.platform.v1.ECDSAHashFunction

0
ECDSA_HASH_FUNCTION_UNSPECIFIED
1
ECDSA_HASH_FUNCTION_USE_MESSAGE_DIRECTLY
2
ECDSA_HASH_FUNCTION_SHA256

enum mpcvault.platform.v1.EVMMessage.Type

0
TYPE_UNSPECIFIED
1
TYPE_PERSONAL_SIGN
2
TYPE_SIGN_TYPED_DATA

enum mpcvault.platform.v1.AptosMessage.Type

0
TYPE_UNSPECIFIED
1
TYPE_DEFAULT

enum mpcvault.platform.v1.SolanaMessage.Type

0
TYPE_UNSPECIFIED
1
TYPE_DEFAULT

enum mpcvault.platform.v1.SuiMessage.Type

0
TYPE_UNSPECIFIED
1
TYPE_DEFAULT

enum mpcvault.platform.v1.TonMessage.Type

0
TYPE_UNSPECIFIED
1
TYPE_DEFAULT

enum mpcvault.platform.v1.SigningRequest.Status

0
STATUS_UNSPECIFIED
1
STATUS_PENDING
2
STATUS_SUCCEEDED
3
STATUS_FAILED

enum mpcvault.platform.v1.BatchPayment.Status

0
STATUS_UNSPECIFIED
1
STATUS_PENDING
2
STATUS_SUCCEEDED
3
STATUS_FAILED
Last updated on
Create batch paymentGetBalance