> ## 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.
# Get settlement request information
> This operation has been deprecated. Please use [Get payout information](https://www.cobo.com/payments/en/api-references/payment/get-payout-information) instead.
This operation retrieves the information of a specific settlement request.
```python Python theme={null}
import cobo_waas2
from cobo_waas2.models.settlement import Settlement
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 `` with your private key
api_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)
settlement_request_id = "S20250304-1001"
try:
# Get settlement request information
api_response = api_instance.get_settlement_by_id(settlement_request_id)
print("The response of PaymentApi->get_settlement_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PaymentApi->get_settlement_by_id: %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.*;
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 `` with your private key
defaultClient.setPrivKey("");
PaymentApi apiInstance = new PaymentApi();
String settlementRequestId = "S20250304-1001";
try {
Settlement result = apiInstance.getSettlementById(settlementRequestId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#getSettlementById");
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() {
settlementRequestId := "S20250304-1001"
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 `` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "",
})
resp, r, err := apiClient.PaymentAPI.GetSettlementById(ctx, settlementRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.GetSettlementById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetSettlementById`: Settlement
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.GetSettlementById`: %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 `` with your private key
apiClient.setPrivateKey("");
// Call the API
const apiInstance = new CoboWaas2.PaymentApi();
const settlement_request_id = "S20250304-1001";
apiInstance.getSettlementById(settlement_request_id).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
```
## OpenAPI
````yaml get /payments/settlement_requests/{settlement_request_id}
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/settlement_requests/{settlement_request_id}:
get:
tags:
- Payment
summary: Get settlement request information
description: >
This operation has been deprecated. Please use [Get payout
information](https://www.cobo.com/payments/en/api-references/payment/get-payout-information)
instead.
This operation retrieves the information of a specific settlement
request.
operationId: get_settlement_by_id
parameters:
- $ref: '#/components/parameters/SettlementRequestIdPathParam'
responses:
'200':
$ref: '#/components/responses/getSettlementReqeustDetailResponse'
4XX:
$ref: '#/components/responses/badRequestError'
5XX:
$ref: '#/components/responses/internalServerError'
security:
- CoboAuth: []
- OAuth2:
- payment_settlement.read
components:
parameters:
SettlementRequestIdPathParam:
name: settlement_request_id
in: path
required: true
description: The settlement request ID.
schema:
type: string
example: S20250304-1001
responses:
getSettlementReqeustDetailResponse:
description: The request was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/Settlement'
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:
Settlement:
type: object
required:
- settlement_request_id
- request_id
- status
- settlements
properties:
settlement_request_id:
type: string
description: The settlement request ID generated by Cobo.
example: S20250304-1001
request_id:
type: string
description: The request ID provided by you when creating the settlement request.
example: SETTLEMENT123
status:
$ref: '#/components/schemas/SettleRequestStatus'
settlements:
type: array
items:
$ref: '#/components/schemas/SettlementDetail'
created_timestamp:
type: integer
description: >-
The created time of the settlement request, represented as a UNIX
timestamp in seconds.
example: 1744689600
updated_timestamp:
type: integer
description: >-
The updated time of the settlement request, represented as a UNIX
timestamp in seconds.
example: 1744689600
initiator:
type: string
description: >
The initiator of this settlement request. Can return either an API
key or the Payments App's ID.
- Format `api_key_`: Indicates the settlement request was
initiated via the Payments API using the API key.
- Format `app_`: Indicates the settlement request was
initiated through the Payments App using the App ID.
example: >-
api_key_b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d
acquiring_type:
$ref: '#/components/schemas/AcquiringType'
payout_channel:
$ref: '#/components/schemas/PayoutChannel'
settlement_type:
$ref: '#/components/schemas/SettlementType'
currency:
type: string
description: The fiat currency for the off-ramp.
example: USD
received_amount_fiat:
type: string
description: >-
The estimated amount of the fiat currency to receive after
off-ramping. This amount is subject to change due to bank transfer
fees.
example: '500.00'
bank_account:
$ref: '#/components/schemas/BankAccount'
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
SettleRequestStatus:
type: string
enum:
- Pending
- Processing
- Completed
- PartiallyCompleted
- Failed
- Canceled
example: Pending
description: >
The current status of a settlement request:
- `Pending`: The settlement request has been created and is awaiting
processing.
- `Processing`: The settlement request is currently being processed,
with at least one settlement in progress.
- `Completed`: All requested settlements have been completed.
- `PartiallyCompleted`: Some requested settlements have been completed
successfully, while others have failed.
- `Failed`: All requested settlements have failed.
- `Canceled`: The settlement request has been canceled due to bank
transfer failure. Contact Cobo's support team through
[help@cobo.com](mailto:help@cobo.com) for assistance.
SettlementDetail:
type: object
properties:
currency:
type: string
description: The fiat currency for the settlement.
example: USD
token_id:
type: string
description: The ID of the cryptocurrency settled.
example: ETH_USDT
chain_id:
type: string
description: The ID of the blockchain network on which the settlement occurred.
example: ETH
merchant_id:
type: string
description: The ID of the merchant associated with this settlement.
example: M1001
amount:
type: string
description: >
The settlement amount.
- If `payout_channel` is set to `Crypto`, this represents the
settlement amount in the specified cryptocurrency.
- If `payout_channel` is set to `OffRamp`, this represents the
settlement amount in the specified fiat currency.
example: '500.00'
settled_amount:
type: string
description: >
The settled amount of this settlement detail.
- If `payout_channel` is set to `Crypto`, this represents the actual
settled amount in the specified cryptocurrency.
- If `payout_channel` is set to `OffRamp`, this represents the
actual settled amount in the specified fiat currency.
example: '500.00'
status:
$ref: '#/components/schemas/SettleStatus'
bank_account:
$ref: '#/components/schemas/BankAccount'
transactions:
type: array
description: >-
An array of transactions associated with this settlement request.
Each transaction represents a separate blockchain operation related
to the settlement process.
items:
$ref: '#/components/schemas/PaymentTransaction'
created_timestamp:
type: integer
description: >-
The creation time of the settlement, represented as a UNIX timestamp
in seconds.
example: 1744689600
updated_timestamp:
type: integer
description: >-
The last update time of the settlement, represented as a UNIX
timestamp in seconds.
example: 1744689600
crypto_address_id:
type: string
description: The ID of the crypto address used for crypto payouts.
example: addr_ethusdt_20250429T134512_a8c31f
crypto_address:
type: string
description: The actual blockchain address to which funds were transferred.
example: '0xabc123456789def0000000000000000000000000'
payout_channel:
$ref: '#/components/schemas/PayoutChannel'
acquiring_type:
$ref: '#/components/schemas/AcquiringType'
settlement_request_id:
type: string
description: The settlement request ID generated by Cobo.
example: S20250304-1001
order_ids:
type: array
description: >
A list of unique order IDs to be included in this settlement.
- This field is only applicable when `settlement_type` is set to
`Merchant`.
- If provided, the settlement will only apply to the specified
orders.
items:
$ref: '#/components/schemas/OrderId'
commission_fee:
$ref: '#/components/schemas/CommissionFee'
bridging_fee:
$ref: '#/components/schemas/BridgingFee'
AcquiringType:
type: string
enum:
- Order
- TopUp
example: Order
description: >
The payment acquisition type.
- `Order`: Payers pay by fixed-amount orders. Ideal for specific
purchases and one-time transactions.
- `TopUp`: Account recharge flow where payers deposit funds to their
dedicated top-up addresses. Ideal for flexible or usage-based payment
models.
PayoutChannel:
type: string
enum:
- Crypto
- OffRamp
example: Crypto
description: >
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.
SettlementType:
type: string
enum:
- Merchant
- Psp
example: Merchant
description: >
Specifies the source of funds for the settlement:
- `Merchant`: The settlement amount will be deducted from the merchant
balance.
- `Psp`: The settlement amount will be deducted from the developer
balance.
BankAccount:
type: object
required:
- bank_account_id
- info
properties:
bank_account_id:
type: string
format: uuid
description: The bank account ID.
example: 123e4567-e89b-12d3-a456-426614174003
info:
type: object
additionalProperties: true
description: JSON-formatted bank account details.
example:
beneficiary_name: John Doe
beneficiary_address: 123 Main St, Anytown, USA
account_number: '4111111111111111'
bank_name: ABC Bank
bank_country: USA
bank_address: 456 Bank Ave, Cityville, USA
swift_or_bic: ABCDEFGH
created_timestamp:
type: integer
description: >-
The creation time of the bank account, represented as a UNIX
timestamp in seconds.
example: 1744689600
updated_timestamp:
type: integer
description: >-
The last update time of the bank account, represented as a UNIX
timestamp in seconds.
example: 1744689600
SettleStatus:
type: string
enum:
- Pending
- Processing
- Completed
- PartiallyCompleted
- Failed
example: Pending
description: >
The current status of a settlement.
- `Pending`: The settlement has been created and is awaiting processing.
- `Processing`: The settlement is being processed.
- `Completed`: The funds have been successfully deposited into the bank
account or the withdrawal crypto address.
- `PartiallyCompleted`: Some settlement transactions have been completed
successfully, while others have failed.
- `Failed`: The settlement could not be completed due to an error.
PaymentTransaction:
type: object
required:
- tx_id
- from_address
- to_address
- amount
- status
- created_timestamp
- updated_timestamp
properties:
tx_id:
type: string
description: The transaction ID.
example: tx_123e4567-e89b-12d3-a456-426614174003
tx_hash:
type: string
description: The transaction hash.
example: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e'
token_id:
type: string
description: The ID of the cryptocurrency.
example: ETH_USDT
from_address:
type: string
description: The source address of the transaction.
example: '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537'
to_address:
type: string
description: The destination address of the transaction.
example: '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15'
amount:
type: string
description: The amount of cryptocurrency transferred, as a decimal string.
example: '0.15'
status:
$ref: '#/components/schemas/TransactionStatus'
counterparty:
$ref: '#/components/schemas/Counterparty'
destination:
$ref: '#/components/schemas/Destination'
created_timestamp:
type: integer
format: int64
description: >-
The time when the transaction was created, in Unix timestamp format,
measured in milliseconds.
example: 1610445878970
updated_timestamp:
type: integer
format: int64
description: >-
The time when the transaction was updated, in Unix timestamp format,
measured in milliseconds.
example: 1610445878970
OrderId:
type: string
description: >
The order ID to be included in this settlement.
- If provided: Settles merchant funds received from this specific order
- If empty: Settles merchant funds received from all unsettled orders of
the specified merchant
**Usage conditions**
- Only applicable when `settlement_type` is set to `Merchant`
- Cannot be used together with `amount` parameter
example: O20250304-M1001-1001
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.
BridgingFee:
type: object
required:
- fee_amount
properties:
fee_amount:
type: string
description: |
The fee charged for bridging tokens to another chain.
received_token_id:
type: string
description: The ID of the destination token received after bridging.
received_amount:
type: string
description: The final amount of the token received after bridging.
bridge_status:
$ref: '#/components/schemas/PaymentBridgeStatus'
TransactionStatus:
type: string
enum:
- Submitted
- PendingScreening
- PendingAuthorization
- PendingSignature
- Broadcasting
- Confirming
- Completed
- Failed
- Rejected
- Pending
example: Submitted
description: >
The transaction status. For more details including sub-statuses, please
refer to [Transaction statuses and
sub-statuses](https://www.cobo.com/developers/v2/guides/transactions/status).
The `PendingAuthorization` status covers both manual approval
steps and internal automated risk-control, KYT, and compliance screening
checks. A transaction in this status does not necessarily require a
human to take action.
Counterparty:
type: object
required:
- counterparty_type
- counterparty_name
- created_timestamp
- updated_timestamp
properties:
counterparty_id:
type: string
format: uuid
description: The counterparty ID.
example: 123e4567-e89b-12d3-a456-426614174003
counterparty_type:
$ref: '#/components/schemas/CounterpartyType'
counterparty_name:
type: string
description: The counterparty name.
example: Counterparty A
country:
type: string
description: The country of the counterparty, in ISO 3166-1 alpha-3 format.
example: USA
email:
type: string
description: The email of the counterparty.
example: counterparty@example.com
contact_address:
type: string
description: The contact address of the counterparty.
example: 123 Main St, Anytown, USA
created_timestamp:
type: integer
description: >-
The created time of the counterparty, represented as a UNIX
timestamp in seconds.
example: 1744689600
updated_timestamp:
type: integer
description: >-
The updated time of the counterparty, represented as a UNIX
timestamp in seconds.
example: 1744689600
Destination:
type: object
required:
- destination_type
- destination_name
- created_timestamp
- updated_timestamp
properties:
destination_id:
type: string
format: uuid
description: The destination ID.
example: 123e4567-e89b-12d3-a456-426614174003
destination_type:
$ref: '#/components/schemas/DestinationType'
destination_name:
type: string
description: The destination name.
example: Destination A
country:
type: string
description: The country of the destination, in ISO 3166-1 alpha-3 format.
example: USA
email:
type: string
description: The email of the destination.
example: destination@example.com
contact_address:
type: string
description: The contact address of the destination.
example: 123 Main St, Anytown, USA
merchant_id:
type: string
description: The ID of the merchant linked to the destination.
example: M1001
created_timestamp:
type: integer
description: >-
The created time of the destination, represented as a UNIX timestamp
in seconds.
example: 1744689600
updated_timestamp:
type: integer
description: >-
The updated time of the destination, represented as a UNIX timestamp
in seconds.
example: 1744689600
PaymentBridgeStatus:
description: |
The current status of the payout bridge. Possible values include:
- `Completed`: The payout bridge has been completed successfully.
- `Failed`: The payout bridge has failed.
type: string
enum:
- Completed
- Failed
example: Completed
CounterpartyType:
type: string
enum:
- Individual
- Organization
example: Individual
description: |
The type of the counterparty:
- `Individual`: The counterparty is an individual.
- `Organization`: The counterparty is an organization.
DestinationType:
type: string
enum:
- Individual
- Organization
example: Individual
description: |
The type of the destination.
- `Individual`: The destination is an individual.
- `Organization`: The destination is an organization.
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
````