import cobo_waas2
from cobo_waas2.models.create_payment_order_request import CreatePaymentOrderRequest
from cobo_waas2.models.order import Order
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)
    create_payment_order_request = cobo_waas2.CreatePaymentOrderRequest(
        merchant_id="M1001", 
        merchant_order_code="M20240201001",
        psp_order_code="P20240201001", 
        pricing_currency="USD",
        pricing_amount="100.00",
        fee_amount="2.00",
        payable_currency="ETH_USDT"
    )

    try:
        # Create pay-in order
        api_response = api_instance.create_payment_order(
            create_payment_order_request=create_payment_order_request
        )
        print("The response of PaymentApi->create_payment_order:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_payment_order: %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();
    CreatePaymentOrderRequest createPaymentOrderRequest =
        new CreatePaymentOrderRequest()
           .merchantId("1001")
           .merchantOrderCode("M20240201001")
           .pspOrderCode("P20240201001")
           .pricingCurrency("USD")
           .pricingAmount("100.00")
           .payableCurrency("ETH_USDT")
           .feeAmount("2.00");
    try {
      Order result = apiInstance.createPaymentOrder(createPaymentOrderRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#createPaymentOrder");
      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() {
	createPaymentOrderRequest := *coboWaas2.NewCreatePaymentOrderRequest("1001", "P20240201001", "2.00")
	createPaymentOrderRequest.SetMerchantOrderCode("M20240201001")
	createPaymentOrderRequest.SetPricingCurrency("USD")
	createPaymentOrderRequest.SetPricingAmount("100.00")
	createPaymentOrderRequest.SetPayableCurrency("ETH_USDT")
	createPaymentOrderRequest.SetFeeAmount("2.00")
  
	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.CreatePaymentOrder(ctx).
		CreatePaymentOrderRequest(createPaymentOrderRequest).
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.CreatePaymentOrder``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreatePaymentOrder`: Order
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.CreatePaymentOrder`: %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 opts = {
  CreatePaymentOrderRequest:
    CoboWaas2.CreatePaymentOrderRequest.constructFromObject({
      merchant_id: "M1001",
      merchant_order_code: "M20240201001",
      psp_order_code: "P20240201001",
      pricing_currency: "USD",
      pricing_amount: "100.00",
      payable_currency: "ETH_USDT",
      fee_amount: "2.00"
    }),
};
apiInstance.createPaymentOrder(opts).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

{
  "order_id": "5001",
  "psp_order_code": "psp-order-20240601-00789",
  "fee_amount": "2",
  "chain_id": "ETH",
  "payable_amount": "103.03",
  "exchange_rate": "0.99",
  "receive_address": "0x1234567890abcdef1234567890abcdef12345678",
  "status": "Pending",
  "received_token_amount": "103.0305",
  "merchant_id": "1001",
  "merchant_order_code": "merchant-inv-55231",
  "pricing_currency": "USD",
  "pricing_amount": "100.00",
  "payable_currency": "ETH_USDT",
  "amount_tolerance": "0.5",
  "expired_at": 1711324800,
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600,
  "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",
      "sub_status": "PendingDoubleCheck",
      "failed_reason": "Rejected by signer Cobo TSS",
      "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",
        "source": "Client",
        "country": "USA",
        "email": "[email protected]",
        "contact_address": "123 Main St, Anytown, USA",
        "merchant_id": "M1001"
      }
    }
  ],
  "currency": "<string>",
  "order_amount": "<string>",
  "token_id": "<string>",
  "settlement_status": "Pending"
}

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

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

Order Mode

Create pay-in order

This operation creates a pay-in order.

Before you can call this operation, make sure the following prerequisites are met:

Payments onboarding is complete, so your organization’s payment developer account is active.
merchant_id references a merchant that already exists and is owned by your organization.

Completing Payments onboarding automatically provisions a default merchant for your organization, which you can use directly as the merchant_id value. To create additional merchants, call Create merchant.

This operation does not independently check merchant KYB, merchant activation or status, merchant configuration, or whether a developer-fee configuration record exists for the merchant. These checks are not substitutes for completing organization-level Payments onboarding — if your organization’s payment developer account is not active, the request fails regardless of merchant state. For more information, refer to Merchants and Error codes and status codes.

POST

payments

orders

import cobo_waas2
from cobo_waas2.models.create_payment_order_request import CreatePaymentOrderRequest
from cobo_waas2.models.order import Order
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)
    create_payment_order_request = cobo_waas2.CreatePaymentOrderRequest(
        merchant_id="M1001", 
        merchant_order_code="M20240201001",
        psp_order_code="P20240201001", 
        pricing_currency="USD",
        pricing_amount="100.00",
        fee_amount="2.00",
        payable_currency="ETH_USDT"
    )

    try:
        # Create pay-in order
        api_response = api_instance.create_payment_order(
            create_payment_order_request=create_payment_order_request
        )
        print("The response of PaymentApi->create_payment_order:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_payment_order: %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();
    CreatePaymentOrderRequest createPaymentOrderRequest =
        new CreatePaymentOrderRequest()
           .merchantId("1001")
           .merchantOrderCode("M20240201001")
           .pspOrderCode("P20240201001")
           .pricingCurrency("USD")
           .pricingAmount("100.00")
           .payableCurrency("ETH_USDT")
           .feeAmount("2.00");
    try {
      Order result = apiInstance.createPaymentOrder(createPaymentOrderRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#createPaymentOrder");
      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() {
	createPaymentOrderRequest := *coboWaas2.NewCreatePaymentOrderRequest("1001", "P20240201001", "2.00")
	createPaymentOrderRequest.SetMerchantOrderCode("M20240201001")
	createPaymentOrderRequest.SetPricingCurrency("USD")
	createPaymentOrderRequest.SetPricingAmount("100.00")
	createPaymentOrderRequest.SetPayableCurrency("ETH_USDT")
	createPaymentOrderRequest.SetFeeAmount("2.00")
  
	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.CreatePaymentOrder(ctx).
		CreatePaymentOrderRequest(createPaymentOrderRequest).
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.CreatePaymentOrder``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreatePaymentOrder`: Order
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.CreatePaymentOrder`: %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 opts = {
  CreatePaymentOrderRequest:
    CoboWaas2.CreatePaymentOrderRequest.constructFromObject({
      merchant_id: "M1001",
      merchant_order_code: "M20240201001",
      psp_order_code: "P20240201001",
      pricing_currency: "USD",
      pricing_amount: "100.00",
      payable_currency: "ETH_USDT",
      fee_amount: "2.00"
    }),
};
apiInstance.createPaymentOrder(opts).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

{
  "order_id": "5001",
  "psp_order_code": "psp-order-20240601-00789",
  "fee_amount": "2",
  "chain_id": "ETH",
  "payable_amount": "103.03",
  "exchange_rate": "0.99",
  "receive_address": "0x1234567890abcdef1234567890abcdef12345678",
  "status": "Pending",
  "received_token_amount": "103.0305",
  "merchant_id": "1001",
  "merchant_order_code": "merchant-inv-55231",
  "pricing_currency": "USD",
  "pricing_amount": "100.00",
  "payable_currency": "ETH_USDT",
  "amount_tolerance": "0.5",
  "expired_at": 1711324800,
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600,
  "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",
      "sub_status": "PendingDoubleCheck",
      "failed_reason": "Rejected by signer Cobo TSS",
      "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",
        "source": "Client",
        "country": "USA",
        "email": "[email protected]",
        "contact_address": "123 Main St, Anytown, USA",
        "merchant_id": "M1001"
      }
    }
  ],
  "currency": "<string>",
  "order_amount": "<string>",
  "token_id": "<string>",
  "settlement_status": "Pending"
}

{
  "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.create_payment_order_request import CreatePaymentOrderRequest
from cobo_waas2.models.order import Order
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)
    create_payment_order_request = cobo_waas2.CreatePaymentOrderRequest(
        merchant_id="M1001", 
        merchant_order_code="M20240201001",
        psp_order_code="P20240201001", 
        pricing_currency="USD",
        pricing_amount="100.00",
        fee_amount="2.00",
        payable_currency="ETH_USDT"
    )

    try:
        # Create pay-in order
        api_response = api_instance.create_payment_order(
            create_payment_order_request=create_payment_order_request
        )
        print("The response of PaymentApi->create_payment_order:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_payment_order: %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();
    CreatePaymentOrderRequest createPaymentOrderRequest =
        new CreatePaymentOrderRequest()
           .merchantId("1001")
           .merchantOrderCode("M20240201001")
           .pspOrderCode("P20240201001")
           .pricingCurrency("USD")
           .pricingAmount("100.00")
           .payableCurrency("ETH_USDT")
           .feeAmount("2.00");
    try {
      Order result = apiInstance.createPaymentOrder(createPaymentOrderRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#createPaymentOrder");
      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() {
	createPaymentOrderRequest := *coboWaas2.NewCreatePaymentOrderRequest("1001", "P20240201001", "2.00")
	createPaymentOrderRequest.SetMerchantOrderCode("M20240201001")
	createPaymentOrderRequest.SetPricingCurrency("USD")
	createPaymentOrderRequest.SetPricingAmount("100.00")
	createPaymentOrderRequest.SetPayableCurrency("ETH_USDT")
	createPaymentOrderRequest.SetFeeAmount("2.00")
  
	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.CreatePaymentOrder(ctx).
		CreatePaymentOrderRequest(createPaymentOrderRequest).
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.CreatePaymentOrder``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreatePaymentOrder`: Order
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.CreatePaymentOrder`: %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 opts = {
  CreatePaymentOrderRequest:
    CoboWaas2.CreatePaymentOrderRequest.constructFromObject({
      merchant_id: "M1001",
      merchant_order_code: "M20240201001",
      psp_order_code: "P20240201001",
      pricing_currency: "USD",
      pricing_amount: "100.00",
      payable_currency: "ETH_USDT",
      fee_amount: "2.00"
    }),
};
apiInstance.createPaymentOrder(opts).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.

Body

application/json

The request body to create a pay-in order.

merchant_id

string

required

The merchant ID.

Example:

"1001"

psp_order_code

string

required

The order identifier for your own internal business order. Set this to the order reference you use internally to identify this pay-in — for example, an order or transaction ID from your own order-management system. This value must be unique within your Cobo organization: Cobo enforces uniqueness on psp_order_code, so reusing a code already associated with an existing order in your organization is rejected. If a downstream merchant you serve supplies its own separate order reference, record that in merchant_order_code instead — psp_order_code always identifies your own order, not the merchant's.

Example:

"psp-order-20240601-00789"

fee_amount

string

required

The order-level developer charge deducted from the payment collected for this order and credited to your developer balance. Both 0 and positive values are valid. A value of 0 means that no developer fee is taken and the merchant receives the full collected amount.

When the collected payment exactly matches the payable amount, the merchant balance is credited with the payable amount minus fee_amount, and your developer balance is credited with fee_amount. For example, for a payable amount of 104.08 and a fee_amount of 2, the merchant receives 102.08 and you receive 2.

For related fee settings and settlement details, see Merchant management and Accounts and fund allocation.

Example:

"2"

payable_currency

string

required

The ID of the cryptocurrency used for payment. Supported values:

USDC: ETH_USDC, ARBITRUM_USDC, SOL_USDC, BASE_USDC, MATIC_USDC, BSC_USDC
USDT: TRON_USDT, ETH_USDT, ARBITRUM_USDT, SOL_USDT, BASE_USDT, MATIC_USDT, BSC_USDT

Example:

"ETH_USDT"

merchant_order_code

string

An optional reference for the order maintained by a downstream merchant you serve — for example, when you are a payment service provider (PSP) processing pay-in orders on behalf of merchants. Set this field only when such a downstream merchant supplies its own order reference that is distinct from your internal psp_order_code. Omit this field if you are collecting payment directly as the merchant, with no separate downstream merchant reference to track.

Example:

"merchant-inv-55231"

pricing_currency

string

The pricing currency that denominates pricing_amount and fee_amount. If left empty, both values will be denominated in payable_currency. Currently, For a complete list of supported currencies, see Supported chains and tokens.

Example:

"USD"

pricing_amount

string

The base amount of the order, excluding the developer fee (specified in fee_amount). Values must be greater than 0 and contain two decimal places.

Example:

"100.00"

payable_amount

string

The total amount the payer needs to pay, denominated in the specified payable_currency. If this field is left blank, the system will automatically calculate the amount at order creation using the following formula: (pricing_amount + fee_amount) / current exchange rate.

Values must be greater than 0 and contain two decimal places.

Example:

"103.03"

expired_in

integer

default:1800

The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to 1800, the order will expire in 30 minutes. Must be greater than zero and cannot exceed 3 hours (10800 seconds). After expiration:

The order status becomes final and cannot be changed
The received_token_amount field will no longer be updated
Funds received after expiration will be categorized as late payments and can only be settled from the developer balance.
A late payment will trigger a transactionLate webhook event.

Example:

1800

amount_tolerance

string

The allowed amount deviation, with precision up to 1 decimal place.

For example, if payable_amount is 100.00 and amount_tolerance is 0.50:

Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5)
Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5)

Example:

"0.5"

currency

string

default:""

This field has been deprecated. Please use pricing_currency instead.

Example:

"USD"

order_amount

string

This field has been deprecated. Please use pricing_amount instead.

Example:

"100.00"

token_id

string

This field has been deprecated. Please use payable_currency instead.

Example:

"ETH_USDT"

use_dedicated_address

boolean

This field has been deprecated.

Example:

false

custom_exchange_rate

string

This field has been deprecated.

Example:

"1.00"

Response

The request was successful.

order_id

string

required

The unique identifier of the payment order. Cobo assigns this ID when the payment order is created — when that happens depends on which pay-in method you use.

For the direct method, Create pay-in order creates the order synchronously and returns order_id in the response immediately.

For the payment link method, Create order link returns only the hosted link details and does not create an order, so order_id does not exist yet at that point. order_id becomes available only after the payer opens the hosted payment page, selects the payment token and blockchain network, and submits the order — Cobo creates the order and assigns order_id at that moment, not when the link itself was generated.

Example:

"5001"

psp_order_code

string

required

The order identifier for your own internal business order, exactly as you supplied it in psp_order_code when creating the order. This value is unique within your Cobo organization.

Example:

"psp-order-20240601-00789"

fee_amount

string

required

The order-level developer charge credited to your developer balance when the order settles. A value of 0 means that no developer fee was charged and the merchant was credited with the full collected amount.

For related fee settings and settlement details, see Merchant management and Accounts and fund allocation.

Example:

"2"

chain_id

string

required

The ID of the blockchain network where the payment transaction should be made.

Example:

"ETH"

payable_amount

string

required

The cryptocurrency amount to be paid for this order.

Example:

"103.03"

exchange_rate

string

required

The exchange rate between payable_currency and pricing_currency, calculated as (pricing_amount + fee_amount) / payable_amount.

This field is only returned when payable_amount was not provided in the order creation request.

Example:

"0.99"

receive_address

string

required

The recipient wallet address to be used for the payment transaction.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

status

enum<string>

required

The current status of the pay-in order:

Pending: The order has been created and is awaiting payment. No incoming transaction has been detected.
Processing: An incoming transaction has been detected at the recipient address.
Completed: The payment has been fully received and is now complete.
Expired: The order has reached its expiration time without receiving any payment, or the order has been cancelled by the Update pay-in order operation.
Underpaid: The order has reached its expiration time. A payment was received but the amount is less than the order's required amount.

Available options:

Pending,

Processing,

Completed,

Expired,

Underpaid

Example:

"Pending"

received_token_amount

string

required

The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT).

Example:

"103.0305"

merchant_id

string

The merchant ID.

Example:

"1001"

merchant_order_code

string

The downstream merchant's order reference, exactly as you supplied it in merchant_order_code when creating the order, if you provided one. Present only when a merchant_order_code was included at order creation.

Example:

"merchant-inv-55231"

pricing_currency

string

The pricing currency of the order.

Example:

"USD"

pricing_amount

string

The base amount of the order, excluding the developer fee (specified in fee_amount).

Example:

"100.00"

payable_currency

string

The ID of the cryptocurrency used for payment.

Example:

"ETH_USDT"

amount_tolerance

string

The allowed amount deviation, with precision up to 1 decimal place.

For example, if payable_amount is 100.00 and amount_tolerance is 0.50:

Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5)
Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5)

Example:

"0.5"

expired_at

integer

The expiration time of the pay-in order, represented as a UNIX timestamp in seconds.

Example:

1711324800

created_timestamp

integer

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

Example:

1744689600

updated_timestamp

integer

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

Example:

1744689600

transactions

object[]

An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the settlement process.

Show child attributes

currency

string

This field has been deprecated. Please use pricing_currency instead.

order_amount

string

This field has been deprecated. Please use pricing_amount instead.

token_id

string

This field has been deprecated. Please use payable_currency instead.

settlement_status

enum<string>

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.

Available options:

Pending,

Processing,

Completed,

PartiallyCompleted,

Failed

Example:

"Pending"

⌘I

Get Started

Pay-ins

Funds Management

Merchants

Reports

Webhooks

Create pay-in order

Authorizations

Body

Response