Skip to main content
POST
/
compliance
/
funds
/
disposition
/
refund
import cobo_waas2
from cobo_waas2.models.disposition_response import DispositionResponse
from cobo_waas2.models.refund_disposition import RefundDisposition
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.ComplianceApi(api_client)
    refund_disposition = cobo_waas2.RefundDisposition()

    try:
        # Refund funds
        api_response = api_instance.refund_funds(refund_disposition=refund_disposition)
        print("The response of ComplianceApi->refund_funds:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComplianceApi->refund_funds: %s\n" % e)


{
  "transaction_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "Submitted"
}
import cobo_waas2
from cobo_waas2.models.disposition_response import DispositionResponse
from cobo_waas2.models.refund_disposition import RefundDisposition
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.ComplianceApi(api_client)
    refund_disposition = cobo_waas2.RefundDisposition()

    try:
        # Refund funds
        api_response = api_instance.refund_funds(refund_disposition=refund_disposition)
        print("The response of ComplianceApi->refund_funds:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComplianceApi->refund_funds: %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.

Body

application/json

The request body to refund funds.

The information about a request to refund funds.

​
transaction_id
string<uuid>
required

The UUID of the transaction whose funds are to be refunded. This identifies the original transaction that requires refund processing.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
destination_address
string
required

The blockchain address to receive the refunded funds.

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb7"

​
disposition_amount
string
required

The amount to be refunded from the original transaction, specified as a numeric string. This value cannot exceed the total amount of the original transaction.

Example:

"1.5"

​
category_names
string[]

Custom categories to identify and track this refund transaction. Used for transaction classification and reporting.

Example:
["Compliance", "Refund", "AML"]
​
description
string

Additional notes or description for the refund.

Maximum length: 200
Example:

"Refund due to compliance requirements - Case #12345"

Response

Successfully created a disposition request.

The response for a disposition request.

​
transaction_id
string<uuid>
required

The UUID of the transaction being processed for disposition.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
status
enum<string>
required

The status of a disposition operation.

Available options:
Submitted,
Refunding,
Refunded,
RefundFailed,
Frozen,
Unfreezing,
Unfrozen,
UnfreezeFailed,
Isolating,
Isolated,
IsolateFailed,
CoboDisposition,
Normal
Example:

"Submitted"