> ## Documentation Index
> Fetch the complete documentation index at: https://cobo.com/payments/llms.txt
> Use this file to discover all available pages before exploring further.

# Create bulk send

> This operation creates a bulk send to transfer funds to multiple recipients in a single request.


<RequestExample>
  ```python Python theme={null}
  import cobo_waas2
  from cobo_waas2.models.create_bulk_send_request import CreateBulkSendRequest
  from cobo_waas2.models.payment_bulk_send import PaymentBulkSend
  from cobo_waas2.rest import ApiException
  from pprint import pprint

  # See configuration.py for a list of all supported configurations.
  configuration = cobo_waas2.Configuration(
      # Replace `<YOUR_PRIVATE_KEY>` with your private key
      api_private_key="<YOUR_PRIVATE_KEY>",
      # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
      host="https://api.dev.cobo.com/v2",
  )
  # Enter a context with an instance of the API client
  with cobo_waas2.ApiClient(configuration) as api_client:
      # Create an instance of the API class
      api_instance = cobo_waas2.PaymentApi(api_client)
      create_bulk_send_request = cobo_waas2.CreateBulkSendRequest(
          source_account="M1001",
          execution_mode="Strict",
          payout_params=[
              cobo_waas2.CreateBulkSendRequestPayoutParamsInner(
                  token_id="ETH_USDT",
                  receiving_address="0xabc123456789def0000000000000000000000000",
                  amount="500.00",
              )
          ],
      )

      try:
          # Create bulk send
          api_response = api_instance.create_bulk_send(
              create_bulk_send_request=create_bulk_send_request
          )
          print("The response of PaymentApi->create_bulk_send:\n")
          pprint(api_response)
      except Exception as e:
          print("Exception when calling PaymentApi->create_bulk_send: %s\n" % e)

  ```

  ```java Java theme={null}
  // Import classes:
  import com.cobo.waas2.ApiClient;
  import com.cobo.waas2.ApiException;
  import com.cobo.waas2.Configuration;
  import com.cobo.waas2.Env;
  import com.cobo.waas2.api.PaymentApi;
  import com.cobo.waas2.model.*;
  import java.util.Arrays;

  public class Example {
    public static void main(String[] args) {
      ApiClient defaultClient = Configuration.getDefaultApiClient();
      // Select the development environment. To use the production environment, replace `Env.DEV` with
      // `Env.PROD
      defaultClient.setEnv(Env.DEV);

      // Replace `<YOUR_PRIVATE_KEY>` with your private key
      defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
      PaymentApi apiInstance = new PaymentApi();
      CreateBulkSendRequest createBulkSendRequest =
          new CreateBulkSendRequest()
              .sourceAccount("M1001")
              .executionMode(PaymentBulkSendExecutionMode.STRICT)
              .payoutParams(
                  Arrays.asList(
                      new CreateBulkSendRequestPayoutParamsInner()
                          .tokenId("ETH_USDT")
                          .receivingAddress("0xabc123456789def0000000000000000000000000")
                          .amount("500.00")));
      try {
        PaymentBulkSend result = apiInstance.createBulkSend(createBulkSendRequest);
        System.out.println(result);
      } catch (ApiException e) {
        System.err.println("Exception when calling PaymentApi#createBulkSend");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
      }
    }
  }

  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
  	"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
  	"os"
  )

  func main() {
  	createBulkSendRequest := *coboWaas2.NewCreateBulkSendRequest("M1001", coboWaas2.PaymentBulkSendExecutionMode("Strict"), []coboWaas2.CreateBulkSendRequestPayoutParamsInner{*coboWaas2.NewCreateBulkSendRequestPayoutParamsInner("ETH_USDT", "0xabc123456789def0000000000000000000000000", "500.00")})

  	configuration := coboWaas2.NewConfiguration()
  	// Initialize the API client
  	apiClient := coboWaas2.NewAPIClient(configuration)
  	ctx := context.Background()

  	// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
  	ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
  	// Replace `<YOUR_PRIVATE_KEY>` with your private key
  	ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
  		Secret: "<YOUR_PRIVATE_KEY>",
  	})
  	resp, r, err := apiClient.PaymentAPI.CreateBulkSend(ctx).
  		CreateBulkSendRequest(createBulkSendRequest).
  		Execute()
  	if err != nil {
  		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.CreateBulkSend``: %v\n", err)
  		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
  	}
  	// response from `CreateBulkSend`: PaymentBulkSend
  	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.CreateBulkSend`: %v\n", resp)
  }

  ```

  ```javascript JavaScript theme={null}
  const CoboWaas2 = require("@cobo/cobo-waas2");
  // Initialize the API client
  const apiClient = CoboWaas2.ApiClient.instance;
  // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
  apiClient.setEnv(CoboWaas2.Env.DEV);
  // Replace `<YOUR_PRIVATE_KEY>` with your private key
  apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
  // Call the API
  const apiInstance = new CoboWaas2.PaymentApi();
  const opts = {
    CreateBulkSendRequest: CoboWaas2.CreateBulkSendRequest.constructFromObject({
      source_account: "M1001",
      execution_mode: "Strict",
      payout_params: [
        {
          token_id: "ETH_USDT",
          receiving_address: "0xabc123456789def0000000000000000000000000",
          amount: "500.00",
        },
      ],
    }),
  };
  apiInstance.createBulkSend(opts).then(
    (data) => {
      console.log("API called successfully. Returned data: " + data);
    },
    (error) => {
      console.error(error);
    },
  );

  ```
</RequestExample>


## OpenAPI

````yaml post /payments/bulk_sends
openapi: 3.0.3
info:
  title: Cobo Wallet as a Service 2.0
  description: >
    The Cobo Wallet-as-a-Service (WaaS) 2.0 API is the latest version of Cobo's
    WaaS API offering. It enables you to access Cobo's full suite of crypto
    wallet technologies with powerful and flexible access controls. By
    encapsulating complex security protocols and streamlining blockchain
    interactions, this API allows you to concentrate on your core business
    activities without worrying about the safety of your assets. The WaaS 2.0
    API presents the following key features:


    - A unified API for Cobo's [all four wallet
    types](https://manuals.cobo.com/en/portal/introduction#an-all-in-one-wallet-platform)

    - Support for 80+ chains and 3000+ tokens

    - A comprehensive selection of webhook events

    - Flexible usage models for MPC Wallets, including [Organization-Controlled
    Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/introduction)
    and [User-Controlled
    Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ucw/introduction)

    - Programmatic control of smart contract wallets such as Safe{Wallet} with
    fine-grained access controls

    - Seamlessly transfer funds across multiple exchanges, including Binance,
    OKX, Bybit, Deribit, and more


    For more information about the WaaS 2.0 API, see [Introduction to WaaS
    2.0](https://www.cobo.com/developers/v2/guides/overview/introduction).
  termsOfService: https://cobo.com/waas/tos/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  contact:
    name: Cobo WaaS
    url: https://www.cobo.com/waas
    email: help@cobo.com
  version: 1.0.0
servers:
  - url: https://api.dev.cobo.com/v2
    description: Development environment
  - url: https://api.cobo.com/v2
    description: Production environment
security:
  - CoboAuth: []
tags:
  - name: Organizations
    description: Operations related to Organizations.
  - name: Wallets
    description: Operations related to all wallets.
  - name: Wallets - MPC Wallets
    description: Operations related to mpc wallet.
  - name: Wallets - Exchange Wallet
    description: Operations related to exchange wallet.
  - name: Wallets - Smart Contract Wallets
    description: Operations related to smart contract wallet.
  - name: Transactions
    description: Operations related to all transactions.
  - name: Developers - Webhooks
    description: Operations related to webhooks.
  - name: Stakings
    description: Operations related to staking.
  - name: OAuth
    description: Operations related to OAuth.
  - name: Developers
    description: Operations related to developers.
  - name: AddressBooks
    description: Operations related to address books.
  - name: TravelRule
    description: Operations related to travel rule.
  - name: GraphQL
    description: Operations related to executing GraphQL queries and mutations.
  - name: PrimeBroker
    description: Operations related to prime broker.
  - name: AppWorkflows
    description: Operations related to app workflow.
  - name: FeeStation
    description: Operations related to fee station.
  - name: Payment
    description: Operations related to payment.
  - name: Batch Payouts
    description: Operations related to batch payouts.
  - name: Tokenization
    description: Operations related to tokenization.
  - name: AutoSweep
    description: Operations related to auto sweep.
  - name: Compliance
    description: Operations related to compliance.
paths:
  /payments/bulk_sends:
    post:
      tags:
        - Payment
      summary: Create bulk send
      description: >
        This operation creates a bulk send to transfer funds to multiple
        recipients in a single request.
      operationId: create_bulk_send
      requestBody:
        $ref: '#/components/requestBodies/createPaymentBulkSendBody'
      responses:
        '201':
          $ref: '#/components/responses/createPaymentBulkSendResponse'
        4XX:
          $ref: '#/components/responses/badRequestError'
        5XX:
          $ref: '#/components/responses/internalServerError'
      security:
        - CoboAuth: []
        - OAuth2:
            - payment_settlement.create
components:
  requestBodies:
    createPaymentBulkSendBody:
      description: The request body to create a bulk send.
      content:
        application/json:
          schema:
            type: object
            required:
              - source_account
              - execution_mode
              - payout_params
            properties:
              request_id:
                type: string
                description: >-
                  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.
                example: 123e457-e89b-12d3-a456-426614174004
              source_account:
                type: string
                description: >
                  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"`.
                example: M1001
              execution_mode:
                $ref: '#/components/schemas/PaymentBulkSendExecutionMode'
              description:
                type: string
                description: >-
                  The description for the entire bulk send batch. Maximum
                  length: 255 characters.
                example: Monthly vendor payments - January 2024
              payout_params:
                type: array
                description: The bulk send items.
                items:
                  type: object
                  required:
                    - token_id
                    - receiving_address
                    - amount
                  properties:
                    token_id:
                      type: string
                      description: >-
                        The token ID of the cryptocurrency to be sent to the
                        recipient.
                      example: ETH_USDT
                    receiving_address:
                      type: string
                      description: The receiving address.
                      example: '0xabc123456789def0000000000000000000000000'
                    amount:
                      type: string
                      description: >-
                        The amount of the cryptocurrency to be sent to the
                        recipient.
                      example: '500.00'
                    description:
                      type: string
                      description: >-
                        A note or comment about the bulk send item. Maximum
                        length: 255 characters.
                      example: 'Invoice #INV-2024-001'
  responses:
    createPaymentBulkSendResponse:
      description: The bulk send was successfully created.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentBulkSend'
    badRequestError:
      description: >-
        Bad request. Your request contains malformed syntax or invalid
        parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    internalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    PaymentBulkSendExecutionMode:
      type: string
      enum:
        - Strict
        - Partial
      example: Strict
      description: >
        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 a
        `PartiallyCompleted` bulk 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.
    PaymentBulkSend:
      type: object
      required:
        - bulk_send_id
        - status
        - source_account
        - execution_mode
        - created_timestamp
        - updated_timestamp
      properties:
        bulk_send_id:
          type: string
          description: The bulk send ID.
          example: 123e4567-e89b-12d3-a456-426614174003
        request_id:
          type: string
          description: The request ID.
          example: 123e457-e89b-12d3-a456-426614174004
        source_account:
          type: string
          description: >
            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"`.
          example: M1001
        description:
          type: string
          description: The description for the entire bulk send batch.
          example: Monthly vendor payments - January 2024
        execution_mode:
          $ref: '#/components/schemas/PaymentBulkSendExecutionMode'
        status:
          $ref: '#/components/schemas/PaymentBulkSendStatus'
        created_timestamp:
          type: integer
          description: >-
            The created time of the bulk send, represented as a UNIX timestamp
            in seconds.
          example: 1744689600
        updated_timestamp:
          type: integer
          description: >-
            The updated time of the bulk send, represented as a UNIX timestamp
            in seconds.
          example: 1744689600
        commission_fee:
          description: >-
            The commission fee. Not returned when no fee has been incurred, the
            actual charged amount once incurred, or `0` if refunded.
          allOf:
            - $ref: '#/components/schemas/CommissionFee'
    ErrorResponse:
      type: object
      description: The response of a failed request.
      required:
        - error_code
        - error_message
        - error_id
      properties:
        error_code:
          type: integer
          description: >-
            The error code. Refer to [Error codes and status
            codes](https://www.cobo.com/developers/v2/api-references/error-codes)
            for more details.
        error_message:
          type: string
          description: The error description.
        error_id:
          type: string
          description: >-
            The error log ID. You can provide the error ID when submitting a
            ticket to help Cobo to locate the issue.
          example: 0b6ddf19083c4bd1a9ca01bec44b24dd
    PaymentBulkSendStatus:
      type: string
      enum:
        - Pending
        - Validating
        - Transferring
        - Completed
        - PartiallyCompleted
        - Failed
      example: Pending
      description: >
        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.
    CommissionFee:
      type: object
      required:
        - fee_amount
      properties:
        fee_amount:
          type: string
          description: >-
            The amount of the commission fee charged by Cobo for operations such
            as pay-ins and payouts, in USD.
  securitySchemes:
    CoboAuth:
      type: apiKey
      in: header
      name: BIZ-API-KEY
      description: >
        The API key. For more details, refer to [API
        key](https://www.cobo.com/developers/v2/guides/overview/cobo-auth#api-key).


        In the API playground, enter your [API
        secret](https://www.cobo.com/developers/v2/guides/overview/cobo-auth#api-secret),
        and your API key will be accordingly calculated.
    OAuth2:
      type: oauth2
      description: >-
        The [Org Access
        Token](https://www.cobo.com/developers/v2/apps/org-access-tokens). Use
        this authorization method only if you are developing Cobo Portal Apps
        for installation and use across different organizations.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.cobo.com/authorize
          tokenUrl: https://auth.cobo.com/oauth/token
          scopes:
            address_book.read: Read address book
            api_key.read: Read API key information
            callback.read: Read callback message
            callback.resend: Resend callback message
            wallet.create: Create wallet
            wallet.read: Read wallet information
            wallet.update: Update wallet information
            wallet.delete: Delete wallet information
            wallet.create_address: Create wallet address
            wallet.manage_utxo: Manage UTXO
            mpc_project.create: Create MPC project
            mpc_project.read: Read MPC project information
            mpc_project.update: Update MPC project information
            mpc_vault.create: Create MPC Vault
            mpc_vault.read: Read MPC Vault information
            mpc_vault.update: Update MPC Vault information
            mpc_key_group.create: Create MPC key group
            mpc_key_group.read: Read MPC key group information
            mpc_key_group.update: Update MPC key group information
            mpc_key_group.delete: Delete MPC key group information
            transaction.read: Read transaction information
            transaction.withdraw: Make withdrawals
            transaction.estimate_fee: Estimate transaction fee
            transaction.contract_call: Initiate contract calls
            transaction.message_sign: Initiate message signings
            transaction.stake: Stake assets
            transaction.unstake: Unstake assets
            transaction.unstake_withdraw: Withdraw unstaked assets
            transaction.manage: Manage ongoing transactions
            transaction.update: Update transaction notes
            travel_rule.read: Read travel rule information
            travel_rule.edit: Edit travel rule information
            webhook.read: Read webhook URLs/events
            webhook.edit: Edit webhook URLs
            webhook.resend: Resend webhook events
            payment_orders_payin.create: Create pay-in order
            payment_orders_payin.read: Read pay-in order information
            payment_orders_payin.update: Update pay-in order
            payment_orders_refund.create: Create payment refund order
            payment_orders_refund.read: Read payment refund order information
            payment_settlement.create: Create payment settlement request
            payment_settlement.read: Read payment settlement request information
            payment_merchant.create: Create payment merchant
            payment_merchant.read: Read payment merchant information
            payment_merchant.update: Update payment merchant
            payment_forced_sweep.create: Create payment force sweep request
            payment_forced_sweep.read: Read payment force sweep request information
            compliance_funds.refund: Refund compliance funds request
            compliance_funds.isolate: Isolate compliance funds request
            compliance_funds.unfreeze: Unfreeze compliance funds request
            compliance_funds.read: Read compliance funds request information
            compliance_kyt_review.update: Update KYT review status
            compliance_kyt_decisions.update: Update KYT decision status
            compliance_kyt_status.read: Read KYT screening status
            compliance_kya_screenings.create: Create KYA address screening requests
            compliance_kya_screenings.read: Read KYA address screening results

````