Skip to main content
GET
/
payments
/
payouts
/
{payout_id}
import cobo_waas2
from cobo_waas2.models.payment_payout_detail import PaymentPayoutDetail
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)
    payout_id = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f"

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


{
  "payout_id": "123e457-e89b-12d3-a456-426614174004",
  "request_id": "123e457-e89b-12d3-a456-426614174004",
  "payout_channel": "Crypto",
  "status": "Pending",
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600,
  "source_account": "<string>",
  "payout_items": [
    {
      "token_id": "ETH_USDT",
      "amount": "500.00",
      "bridging_fee": {
        "fee_amount": "<string>",
        "received_token_id": "<string>",
        "received_amount": "<string>",
        "bridge_status": "Completed"
      }
    }
  ],
  "recipient_info": {
    "address": "0x9876543210abcdef1234567890abcdef12345678",
    "token_id": "TRON_USDT",
    "currency": "USD",
    "bank_account_id": "123e4567-e89b-12d3-a456-426614174003"
  },
  "initiator": "b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d",
  "actual_payout_amount": "500.00",
  "commission_fees": [
    {
      "fee_amount": "<string>"
    }
  ],
  "remark": "Payout for customer 123",
  "transactions": [
    {
      "tx_id": "tx_123e4567-e89b-12d3-a456-426614174003",
      "from_address": "0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537",
      "to_address": "0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15",
      "amount": "0.15",
      "status": "Submitted",
      "created_timestamp": 1610445878970,
      "updated_timestamp": 1610445878970,
      "tx_hash": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "token_id": "ETH_USDT",
      "counterparty": {
        "counterparty_type": "Individual",
        "counterparty_name": "Counterparty A",
        "created_timestamp": 1744689600,
        "updated_timestamp": 1744689600,
        "counterparty_id": "123e4567-e89b-12d3-a456-426614174003",
        "country": "USA",
        "email": "[email protected]",
        "contact_address": "123 Main St, Anytown, USA"
      },
      "destination": {
        "destination_type": "Individual",
        "destination_name": "Destination A",
        "created_timestamp": 1744689600,
        "updated_timestamp": 1744689600,
        "destination_id": "123e4567-e89b-12d3-a456-426614174003",
        "country": "USA",
        "email": "[email protected]",
        "contact_address": "123 Main St, Anytown, USA",
        "merchant_id": "M1001"
      }
    }
  ]
}
import cobo_waas2
from cobo_waas2.models.payment_payout_detail import PaymentPayoutDetail
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)
    payout_id = "aff0e1cb-15b2-4e1f-9b9d-a9133715986f"

    try:
        # Get payout information
        api_response = api_instance.get_payout_by_id(payout_id)
        print("The response of PaymentApi->get_payout_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_payout_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

​
payout_id
string
required

The payout ID.

Response

The request was successful.

​
payout_id
string
required

The payout ID generated by Cobo.

Example:

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

​
request_id
string
required

The request ID provided by you when creating the payout.

Example:

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

​
payout_channel
enum<string>
required

The channel through which the payout will be processed. Possible values include:

  • Crypto: The payout will be processed as a cryptocurrency transfer to a crypto address.
  • OffRamp: The payout will be processed as a fiat currency transfer to a registered bank account.
Available options:
Crypto,
OffRamp
Example:

"Crypto"

​
status
enum<string>
required

The current status of the payout. Possible values include:

  • Pending: The payout has been created and is awaiting processing.
  • Preparing: The payout is being prepared for transfer.
  • Transferring: The payout is currently being transferred to the recipient's destination.
  • Completed: The payout has been successfully completed and all transactions have been processed.
  • PartiallyCompleted: The payout has been partially completed, with some transactions succeeding and others failing.
  • Failed: The payout has failed and no transactions were completed successfully.
  • RejectedByBank: The payout was rejected by the recipient's bank (applicable to OffRamp payouts only).
Available options:
Pending,
Preparing,
Transferring,
Completed,
PartiallyCompleted,
Failed,
RejectedByBank
Example:

"Pending"

​
created_timestamp
integer
required

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

Example:

1744689600

​
updated_timestamp
integer
required

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

Example:

1744689600

​
source_account
string

The source account from which the payout 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".
​
payout_items
object[]

required

​
recipient_info
object
​
initiator
string

The initiator of this payout, usually the user's API key.

Example:

"b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d"

​
actual_payout_amount
string
  • For Crypto payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in recipient_info.token_id.
  • For OffRamp payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in recipient_info.currency. (Note: The actual amount received may be lower due to additional bank transfer fees.)
Example:

"500.00"

​
commission_fees
object[]

The commission fees of the payout.

​
remark
string

A note or comment about the payout.

Example:

"Payout for customer 123"

​
transactions
object[]

An array of payout transactions.