Create bulk send
This operation creates a bulk send to transfer funds to multiple recipients in a single request.
Authorizations
The API key. For more details, refer to API key.
In the API playground, enter your API secret, and your API key will be accordingly calculated.
Body
The request body to create a bulk send.
The source account from which the bulk send will be made.
- If the source account is a merchant account, provide the merchant's ID (e.g., "M1001").
- If the source account is the developer account, use the string
"developer".
"M1001"
The execution mode of the bulk send.
Strict: The bulk send is executed in strict mode. All-or-nothing is enforced at the validation stage: if any item fails validation, the entire batch is rejected and no items are sent. Note that this all-or-nothing guarantee applies at validation only, not at execution. After validation passes, individual items may still be rejected by risk control or fail during on-chain execution, which can result in aPartiallyCompletedbulk send status.Partial: The bulk send is executed in partial mode, which means some bulk send items can be successfully executed and some can be failed.
Strict, Partial "Strict"
The bulk send items.
The request ID that is used to track a bulk send request. The request ID is provided by you and must be unique within your system.
"123e457-e89b-12d3-a456-426614174004"
The description for the entire bulk send batch. Maximum length: 255 characters.
"Monthly vendor payments - January 2024"
Response
The bulk send was successfully created.
The bulk send ID.
"123e4567-e89b-12d3-a456-426614174003"
The source account from which the bulk send will be made.
- If the source account is a merchant account, provide the merchant's ID (e.g., "M1001").
- If the source account is the developer account, use the string
"developer".
"M1001"
The execution mode of the bulk send.
Strict: The bulk send is executed in strict mode. All-or-nothing is enforced at the validation stage: if any item fails validation, the entire batch is rejected and no items are sent. Note that this all-or-nothing guarantee applies at validation only, not at execution. After validation passes, individual items may still be rejected by risk control or fail during on-chain execution, which can result in aPartiallyCompletedbulk send status.Partial: The bulk send is executed in partial mode, which means some bulk send items can be successfully executed and some can be failed.
Strict, Partial "Strict"
The current status of the bulk send. Possible values include:
Pending: The bulk send has been created and is waiting to be processed.Validating: The bulk send items are being validated.Transferring: The bulk send items are being processed and funds are being transferred.Completed: All items in the bulk send have been successfully processed.PartiallyCompleted: Some items in the bulk send have been successfully processed, while others have failed.Failed: The bulk send has failed and no items were processed successfully.
Pending, Validating, Transferring, Completed, PartiallyCompleted, Failed "Pending"
The created time of the bulk send, represented as a UNIX timestamp in seconds.
1744689600
The updated time of the bulk send, represented as a UNIX timestamp in seconds.
1744689600
The request ID.
"123e457-e89b-12d3-a456-426614174004"
The description for the entire bulk send batch.
"Monthly vendor payments - January 2024"
The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or 0 if refunded.
