Skip to main content
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)


{
  "bulk_send_id": "123e4567-e89b-12d3-a456-426614174003",
  "source_account": "M1001",
  "execution_mode": "Strict",
  "status": "Pending",
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600,
  "description": "Monthly vendor payments - January 2024"
}
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)

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

The execution mode of the bulk send.

  • Strict: The bulk send is executed in strict mode, which means all bulk send items should be successfully executed or all failed.
  • Partial: The bulk send is executed in partial mode, which means some bulk send items can be successfully executed and some can be failed.
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

​
description
string

The description for the entire bulk send batch.

Example:

"Monthly vendor payments - January 2024"