API Reference
API Reference

Create Trade

Create Trade

Body Params
string
required

Payment amount, amount must be greater than 0, can be 0 only when using subscription payment method. Truncated to two decimal places

string
required

Transaction currency corresponding to the amount, encoded according to ISO4217

string

Subotiz customer ID, associate with existing customer in Subotiz, choose one with customer_data field, use this field when you need to associate with existing customer

customer_data
object

Customer data, create customer object in Subotiz, choose one with customer_id field, use this field when you need to create new customer.

metadata
object

A set of key-value pairs that can be attached to an object, allowing you to store additional information in a structured format.

string
required

Third-party order ID

string
required

Payment business mode:

  • onetime_payment: One-time payment, requires collecting customer payment information, pass payment_method_data field.
  • subscription: Initial subscription payment, requires collecting customer payment information, pass payment_method_data field, returns payment_token for subsequent subscription renewals upon successful payment
  • recurring_payment: Subscription renewal payment, requires passing payment_token to complete payment, no need to collect user payment information
string

Customer payment token, used for subscription renewal, required when using recurring_payment payment method.

string

Redirect page after payment channel accepts successfully in scenarios like 3DS redirect payment

string
required

Trade initiation time, UTC format, example: 2025-07-02T15:04:05Z

string
required

Client domain information, Fixed value: checkout.subotiz.com

payment_method_data
object

Customer payment information, required for initial subscription payment when using subscription payment method

string

If supported, the field, Transaction Summary, will be passed to the payment provider via its API.
Currently, payments for amounts greater than zero via Subotiz Payments are supported only.

refer_info
object

Source information of the customer

Headers
string
required
Defaults to 008e3967-a1b5-48bb-be14-d5bff5092e61

The unique identifier of the request

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json