Get bulk send information

import cobo_waas2
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)
    bulk_send_id = "123e4567-e89b-12d3-a456-426614174003"

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

// 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.*;

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();
    String bulkSendId = "123e4567-e89b-12d3-a456-426614174003";
    try {
      PaymentBulkSend result = apiInstance.getBulkSendById(bulkSendId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#getBulkSendById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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() {
	bulkSendId := "123e4567-e89b-12d3-a456-426614174003"

	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.GetBulkSendById(ctx, bulkSendId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetBulkSendById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBulkSendById`: PaymentBulkSend
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetBulkSendById`: %v\n", resp)
}

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 bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
apiInstance.getBulkSendById(bulk_send_id).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

{
  "bulk_send_id": "123e4567-e89b-12d3-a456-426614174003",
  "source_account": "M1001",
  "execution_mode": "Strict",
  "status": "Pending",
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600,
  "request_id": "123e457-e89b-12d3-a456-426614174004",
  "description": "Monthly vendor payments - January 2024",
  "failed_reason": "Cannot charge payout fee: Fee Station balance is insufficient. Please add funds to Fee Station and try again.",
  "commission_fee": {
    "fee_amount": "<string>"
  }
}

{
  "error_code": 123,
  "error_message": "<string>",
  "error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}

{
  "error_code": 123,
  "error_message": "<string>",
  "error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}

GET

payments

bulk_sends

{bulk_send_id}

import cobo_waas2
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)
    bulk_send_id = "123e4567-e89b-12d3-a456-426614174003"

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

// 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.*;

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();
    String bulkSendId = "123e4567-e89b-12d3-a456-426614174003";
    try {
      PaymentBulkSend result = apiInstance.getBulkSendById(bulkSendId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#getBulkSendById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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() {
	bulkSendId := "123e4567-e89b-12d3-a456-426614174003"

	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.GetBulkSendById(ctx, bulkSendId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetBulkSendById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBulkSendById`: PaymentBulkSend
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetBulkSendById`: %v\n", resp)
}

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 bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
apiInstance.getBulkSendById(bulk_send_id).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

{
  "bulk_send_id": "123e4567-e89b-12d3-a456-426614174003",
  "source_account": "M1001",
  "execution_mode": "Strict",
  "status": "Pending",
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600,
  "request_id": "123e457-e89b-12d3-a456-426614174004",
  "description": "Monthly vendor payments - January 2024",
  "failed_reason": "Cannot charge payout fee: Fee Station balance is insufficient. Please add funds to Fee Station and try again.",
  "commission_fee": {
    "fee_amount": "<string>"
  }
}

{
  "error_code": 123,
  "error_message": "<string>",
  "error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}

{
  "error_code": 123,
  "error_message": "<string>",
  "error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}

import cobo_waas2
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)
    bulk_send_id = "123e4567-e89b-12d3-a456-426614174003"

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

// 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.*;

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();
    String bulkSendId = "123e4567-e89b-12d3-a456-426614174003";
    try {
      PaymentBulkSend result = apiInstance.getBulkSendById(bulkSendId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#getBulkSendById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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() {
	bulkSendId := "123e4567-e89b-12d3-a456-426614174003"

	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.GetBulkSendById(ctx, bulkSendId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetBulkSendById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBulkSendById`: PaymentBulkSend
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetBulkSendById`: %v\n", resp)
}

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 bulk_send_id = "123e4567-e89b-12d3-a456-426614174003";
apiInstance.getBulkSendById(bulk_send_id).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

Authorizations

BIZ-API-KEY

string

header

required

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.

Path Parameters

bulk_send_id

string

required

The bulk send ID.

Response

The request was successful.

bulk_send_id

string

required

The bulk send ID.

Example:

"123e4567-e89b-12d3-a456-426614174003"

source_account

string

required

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

enum<string>

required

Specifies how the batch handles item-level validation failures. The required execution_mode field is a string enum and must be set to either Strict or Partial; no default is applied if you omit it. It is not a strict_mode boolean flag.

Strict: If any item in the batch fails validation, no items are executed. Every item is marked NotExecuted, and the batch fails. The batch also fails in Strict mode if the fund sweep needed to fund it only partially completes.
Partial: Item validation failures are isolated to the affected items. Failed items are marked NotExecuted, while all other validated items in the batch continue to be processed normally.

Use Partial when one item's validation failure should not block the rest of the batch. Because outcomes can differ by item, check each item's result and validation_status individually instead of assuming that a batch-level outcome applies to every item.

Available options:

Strict,

Partial

Example:

"Strict"

status

enum<string>

required

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.

Available options:

Pending,

Validating,

Transferring,

Completed,

PartiallyCompleted,

Failed

Example:

"Pending"

created_timestamp

integer

required

The created time of the bulk send, represented as a UNIX timestamp in seconds.

Example:

1744689600

updated_timestamp

integer

required

The updated time of the bulk send, represented as a UNIX timestamp in seconds.

Example:

1744689600

request_id

string

The request ID.

Example:

"123e457-e89b-12d3-a456-426614174004"

description

string

The description for the entire bulk send batch.

Example:

"Monthly vendor payments - January 2024"

failed_reason

string

The reason why the bulk send failed.

Example:

"Cannot charge payout fee: Fee Station balance is insufficient. Please add funds to Fee Station and try again."

commission_fee

object

The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or 0 if refunded.

Show child attributes

⌘I

Get Started

Pay-ins

Funds Management

Merchants

Reports

Webhooks

Get bulk send information

Authorizations

Path Parameters

Response