33BDA696CE38AF28
Uploaded by
idsharingth33BDA696CE38AF28
Uploaded by
idsharingthAPI Specs - External
1. Ads
1.1 Create Ad
Creates a new ad.
HTTP Request
POST /api/v5/p2p/ad/create
Request Parameters
Parameter Type Require Description
d
automatedM String No Message that is sent to taker when an order is placed on this ad
essage
cryptoAmou String Yes The quantity of cryptocurrency
nt
cryptoCurre String Yes The crypto currency symbol. Example: BTC
ncy
fiatCurrency String Yes The fiat currency symbol. Example: USD
isProofRequi Boolean No Indicates whether a proof (e.g., bank statement) is required for CNY
red ads. Valid values: true, false
isPublic Boolean No Indicates whether the ad is targeted for public or private
marketplace. Valid values: true,false
maxOrderLi String Yes The maximum order limit. Example: 990.00
mit
maxPaymen String No The maximum time allowed for payment in minutes before
tDurationIn timeout happens. Valid values can be fetched from the /config API
Minutes from maxPaymentDurationAllowedValues field.
Examples: 5,10,15,30,60,120
minAccount String No The number of days since the user has registered (sign-up date).
Age Valid values are: 30, 60, 180, 365
minComplet String No The minimum number of completed orders by the transaction
edOrders party
minComplet String No The minimum order completion rate of the taker. Example: 0.95
ionRate
minKycLevel String No The minimum identity verification level of the taker. Valid values:
1,2,3
minOrderLi String Yes The minimum order limit. Example: 890.00
mit
minSellOrde String No The minimum number of sell orders completed by the taker.
rs Example: 5
paymentMet Array of No The Ids of payment methods which maker accepts for payments.
hodIds String Applicable only for 'sell' ads. Example: [1234]
paymentMet String No The payment methods which maker can transact in. Applicable
hods only for 'buy' ads. Example: bank
priceFloor String No The lowest price before the user's ad is hidden. Applicable only for
ads with price type as floating_market. Example: 890.00
priceMargin String No The price margin ratio for floating type ads. Applicable only for ads
with price type as floating_market. Example: 0.01
remark String No Additional information or trading instructions for the ad for taker
side String Yes Specifies the transaction side or direction. Use buy to indicate a
buy transaction, sell for a sell
transaction.
targetGroup String Yes User target group for the ad. Valid values:
common,certified,diamond,all
type String Yes Ad price type. Valid values are: limit, floating_market
unitPrice String Yes The unit price in fiat currency. Applicable only for ads with price
type as fixed price. Example: 1.1
verificationT String No Verification type for overseas ads excluding CNY. Valid values: 0 (No
ype verification), 1 (Verification)
verificationN Array of No Notes set by the maker for Verification Ads to be shown as a
otes Object prompt to the taker
> id String No Verification note Id.
Valid values (CNY):
1 (Provide proof that the account funds used for payment have
been credited for more than X days)
Valid values (Overseas):
10 (Chat before payment)
11 (No 3rd party payment)
12 (Provide payment proof)
13 (ID verification)
> constraints Object No Constraints specified by the user
>> min String No Min constraint value. Example: 1
>> max String No Max constraint value. Example: 2
>> String No Max length constraint value. Example: 10
maxLength
>> isActive Boolean No Specifies whether the constraint is active. Valid values: true, false
> variables Object No Variables specified by the user for verification notes
>> num String No Number
>> others String No Miscellaneous
whitelistedC Array of No Regions that the taker must be from. Use ALL_COUNTRIES for
ountries String including all countries. For other countries use the two-digit Id.
Example: [US,UK,CA]
Response Parameters
Paramete Type Description
r
adId String Id of the created ad
1.2 Get Ad
Gets the ad information by ad id.
HTTP Request
GET /api/v5/p2p/ad
Request Parameters
Parame Type Require Description
ter d
adId String Yes Ad id
Response Parameters
Parameter Type Description
adId String Ad id
automatedMessage String Message that is sent to taker when an order is placed on
this ad
availableAmount String The available crypto quantity currently available for
buying and selling
blacklistStatus String Blacklist status. Valid values:
NO_BLACK (No blacklist relationship)
BLACK_OTHER (Current user blacklisted the other side)
BLACKED (The other side blacklisted current user)
BLACK_EACH_OTHER (Current user and other use
blacklisted each other)
blockedReasons Array of Collection of all blocked reasons. Example: Your
strings completion rate is less than 0.5. We encourage you to
increase it
completedOrderCry String The amount of crypto that has been traded till now
ptoAmount
completedOrderFia String The amount of fiat that has been traded till now
tAmount
configuredPayment Array of Collection of maker payment information
MethodDetails objects
> paymentMethod String Payment method
> openStatus String Payment method switch state. Valid values:
open
close
unbound
> Array of Collection of payment method details
paymentMethodDet objects
ails
>> String Payment method Id
paymentMethodId
>> accountNo String The account number of payment method
>> bankName String Bank name
createdTimestamp String Creation time of the ad
creator Object Ad creator details
> id String User Id
> nickName String Nick name of the user
> realName String Real name of the user
> type String User type for the ad. Valid values:
common
certified
diamond
> completedOrders String The number of orders completed by the user
> cancelledOrders String The number of orders canceled by the user
> String The number of sell orders completed by the user
completedSellOrder
s
> completionRate String The order completion rate of the user
> kycLevel String The identity verification level of the user. Valid values: 1,
2, 3
> acceptStatus String Order acceptance status of the user. Valid values: 0 (do
not accept order), 1 (accept order)
String Average payment time in seconds
>
avgPaymentTimeIn
Seconds
> String Average completion time in seconds
avgCompletionTim
eInSeconds
> String User joining timestamp in milliseconds
createdTimestamp
> hasAlreadyTraded Boolean Specifies whether the user has traded in the past with
the requester. Valid values: true, false
cryptoCurrency String Crypto currency symbol
cryptoScale String Crypto currency decimal places
fiatCurrency String Fiat currency symbol
fiatPriceIncrement String Fiat currency increasing unit price gradient
fiatPriceScale String Decimal places reserved for fiat currency
fiatScale String Fiat Currency decimal places
hiddenCategory String Hidden Category. Valid values are:
1 (hide one)
0 (not hidden)
3 (out of stock)
hiddenReason String All ads hidden reasons
hiddenType String Order offline type. Valid values:
0
1
isBlockTradeCatego Boolean Specifies whether the ad is a block trade ad (ad dealing
ry with large amount)
isCreatorBlockedBy Boolean Specifies whether blocked by the current user
CurrentUser
isHidden Boolean Specifies whether the ad is hidden or not
isListedOnMarketpl Boolean Specifies whether the ad is listed on marketplace
ace
isOwner Boolean Specifies whether the ad belongs to the user
isPriceOutOfRange Boolean Specifies whether index rate deviates too much
isProofRequired Boolean Specifies whether proof is required
isSecurityLimitAppli Boolean Specifies whether T+1 order
cable
latestUserRegistere String Transaction party user maximum registration time.
dTimestamp Example: 1686652358497
maxCompletedOrde String The maximum number of orders completed by the taker
rs
maxOrderSize String Order upper limit
maxAvgCompleteTi String The maximum average completion time of the
me transaction parties
maxPaymentDurati String The maximum time allowed for payment in minutes
onInMinutes before timeout happens.
merchantId String Merchant Id
minAccountAge String The number of days since the user has registered (sign-
up date). Example: 30
minCompletedOrde String The minimum number of orders completed by the taker
rs
minCompletionRate String The minimum order completion rate of the taker
minKycLevel String The minimum identity verification level of the taker.
Valid values: 1,2,3
minOrderSize String Order lower limit
minSellOrders String The minimum number of sell orders completed by the
taker
onHoldAmount String The quantity that has been frozen but the order has not
been completed till now
paymentMethodBas Array of Collection of payment method basic info set by the
icInfoList Object maker. Applicable for buy ads.
> paymentMethod String Payment method name
Boolean Indicate whether the payment method instantly settle
>
isInstantSettlePaym
ent
> transferSpeed String Indicates the speed of the payment method. Valid
values:
0 (nil): No specific speed requirement or processing time
mentioned.
1 (real time): Payment is expected to be processed
immediately or in real-time.
2 (instant crypto release): Payment release or
confirmation is expected to be instant for cryptocurrency
transactions.
3 (up to X days): Payment processing may take up to a
certain number of days, where X represents the specific
number of days mentioned.
platformCommissio String Commission rate charged by the platform
nRate
priceMargin String The price margin ratio for floating type ads. Applicable
only for ads with price type as floating price
realFiatMaxAmount String Original order maximum amount
PerOrder
remark String Additional information or instructions for the ad for taker
side String Specifies the transaction side or direction. Valid values:
buy
sell
status String Order status. Valid values:
new
canceled
completed
creating
create_fail
canceling
cancel_fail
targetGroup String User target group for the ad. Valid values:
common
certified
diamond
all
type String Ad price type. Valid values:
limit
floating_market
unitPrice String Unit price
unpaidOrderTimeo String Payment time in minutes
utInMinutes
updatedTimestamp String Timestamp of latest modification of ad. Example:
1686652358497
userRegisteredInter String Maximum registration interval in days
valInDays
verificationNotes Array of Notes for Verification Ads to be shown as a prompt to the
Object taker
>id Integer Verification note Id.
Valid values (CNY):
1 (Provide proof that the account funds used for
payment have been credited for more than X days)
Valid values (Overseas):
10 (Chat before payment)
11 (No 3rd party payment)
12 (Provide payment proof)
13 (ID verification)
>description String Text description of verification type
>viewType String For UI display can ignore for OpenAPI
> constraints Object Constraints specified by the user
>> active Boolean Specifies whether the constraint is active
>> max Integer Max payment account duration value
>> min Integer Min payment account duration value
>> maxLength Integer Max length for others constraint value
>variables Object Variables specified by the user for verification notes
>> num Integer Number
>> others String Miscellaneous
verificationType String Specifies the verification type. Applies for Overseas Ads.
Valid values:
0 (no verification required)
1 (verification required)
whitelistedCountrie String Regions that the taker must be from, as set by the maker
s of the ad
1.3 Update Ad
This operation would cancel the existing order and create a new one. If the required parameters
are not passed, then we default to using the old ad values.
HTTP Request
POST /api/v5/p2p/ad/update
Request Parameters
Parameter Type Require Description
d
adId String Yes Id of the Ad which needs to be updated
online String No Status of the ad: true (online), false (offline)
minOrderLimit String No The minimum order limit. Example: 890.00
maxOrderLimi String No The maximum order limit. Example: 990.00
t
type String No Ad price type. Valid values are: limit, floating_market
priceMargin String No The price margin ratio for floating type ads. Applicable only for
ads with price type as floating price. Example: 0.01
unitPrice String No The unit price in fiat currency. Applicable only for ads with price
type as fixed price. Example: 1.1
cryptoAmount String No The quantity of cryptocurrency
priceFloor String No The lowest price before the user's ad is hidden. Example: 890.00
isPublic Boolea No Indicates whether the ad is targeted for public or private
n marketplace. Valid values: true,false
paymentMeth Array of No The Ids of payment methods which maker accepts for payments.
odIds String Applicable only for 'sell' ads. Example: [1234]
paymentMeth String No The payment methods which maker can transact in. Applicable
ods only for 'buy' ads. Example: bank
minCompleted String No The minimum number of completed orders by the taker
Orders
minKycLevel String No The minimum identity verification level of the taker. Valid values:
1,2,3
minSellOrders String No The minimum number of sell orders completed by the taker.
Example: 5
minCompletio String No The minimum order completion rate of the taker. Example: 0.95
nRate
minAccountAg String No The number of days since the user has registered (sign-up date).
e Valid values are: 30, 60, 180, 365
targetGroup String No User target group for the ad. Valid values:
common,certified,diamond,all
maxPaymentD String No The maximum time allowed for payment in minutes before
urationInMinut timeout happens. Valid values: 5,10,15,30,60,120
es
isProofRequire Boolea No Indicates whether proof (e.g., bank statement) is required for CNY
d n ads. Valid values: true, false
whitelistedCou Array of No Regions that the taker must be from. Use ALL_COUNTRIES for
ntries String including all countries. For other countries use the two-digit Id.
Example: [US,UK,CA]
verificationTyp String No Verification type for overseas ads excluding CNY. Example: 0 (No
e verification), 1 (Verification))
verificationNot Array of No Notes set by the maker for Verification Ads to be shown as a
es Object prompt to the taker
Valid values (CNY):
1 (Provide proof that the account funds used for payment have
been credited for more than X days)
Valid values (Overseas):
10 (Chat before payment)
11 (No 3rd party payment)
12 (Provide payment proof)
13 (ID verification)
> id String No Verification note Id. Valid values: 1 (Provide proof that the
account funds used for payment have been credited for more
than X days)
> constraints
Object No Constraints specified by the user
>> min String No Min payment account duration value. Example: 1
>> max String No Max payment account duration value. Example: 2
>> maxLengthString No Max length constraint value. Example: 10
>> isActive Boolea No Specifies whether the constraint is active. Valid values: true, false
n
> variables Object No Variables specified by the user for verification notes
>> num String No Number
>> others String No Miscellaneous
remark String No Additional information or trading instructions for the ad for taker
automatedMes String No Message that is sent to taker when an order is placed on this ad
sage
Response Parameters
Paramete Type Description
r
oldAdId String Id of the cancelled ad
newAdId String Id of the newly created ad
1.4 Update Ad Active Status
Updates the ad status to be online or offline.
HTTP Request
POST /api/v5/p2p/ad/update-active-status
Request Parameters
Parame Type Require Description
ter d
adId String Yes Id of the Ad for which status needs to be modified
status String Yes New online status of the Ad. Valid values: hidden, show
Response Parameters
Paramete Type Description
r
adId String Id of the Ad for which status got modified
1.5 Cancel Ad
Cancel an ad
HTTP Request
POST /api/v5/p2p/ad/cancel
Request Parameters
Parame Type Require Description
ter d
adId String Yes Id of the Ad to be canceled
Response Parameters
Paramete Type Description
r
adId String Id of the cancelled Ad
1.6 Get Optimal Ad Price
Get top buy top sell price
HTTP Request
GET /api/v5/p2p/ad/optimal-price
Request Parameters
Parameter Type Require Description
d
cryptoCurre String Yes Crypto currency symbol
ncy
fiatCurrenc String Yes Fiat currency symbol
y
Response Parameters
Parameter Type Description
currentHighestBuyAd String Current highest buy ad price
Price
currentLowestSellAd String Current lowest sell ad price
Price
1.7 Get Marketplace List
Get buy and sell ad list. Return similar ads which are visible on the marketplace on app/website.
HTTP Request
GET /api/v5/p2p/ad/marketplace-list
Request Parameters
Parameter Type Requir Description
ed
side String No Specifies the transaction side or direction. Use buy to
indicate a buy transaction, sell for a sell transaction, or all to
include both buy and sell transactions.
cryptoCurrency String Yes Crypto currency symbol
fiatCurrency String Yes Fiat currency symbol
targetGroup String No User target group for the ad. Valid values:
common,certified,diamond,all,blockTrade,flashtrade
minCryptoAmount String No Minimum amount of crypto
cryptoQuota String No The crypto currency limit, which is the amount of crypto
currency multiplied by the unit price and the comparison of
the limit of the order. Example: 5.9
minFiatAmount String No Fiat currency quantity (ads with fiat amount less than this
number would be filtered out)
maxFiatAmount String No Fiat currency quantity (ads with fiat amount greater than
this number would be filtered out)
minFiatAmountPerOr String No The minimum fiat amount required for a single order. Any
der ads with orders placed for an amount less than this
threshold will be filtered out
maxFiatAmountPerO String No The maximum fiat amount required for a single order. Any
rder ads with orders placed for an amount greater than this
threshold will be filtered out
paymentMethod String No Payment method. Default: all. Examples: all, bank, aliPay,
wxPay
isTradable Boolea No Specifies whether the ad is tradable or not. Default: false
n
isSecurityLimitApplic Boolea No Specifies whether to show T+1 ads. Default: false
able n
shouldShowOnlyFoll Boolea No Specifies whether to fetch ads from users which the current
ow n user follows. Default: false. Valid values: true, false
showAlreadyTraded Boolea No Specifies whether to fetch ads which have already been
n traded with the user. Default: false. Valid values: true, false
isProofRequired Boolea No Specifies whether verification is required for the ads.
n Default: false. Valid values: true, false
hideOverseasVerifica Boolea No Specifies whether to hide overseas verification ads. Default:
tionAds n false. Applies only for non-CNY regions. Valid values: true,
false
limit String No Maximum number of items returned
sortType String No Sort type for the ads. Valid values:
default,recommended,price_asc,price_desc
Response Parameters
Parameter Type Description
sellAds Array of Collection of sell ad details
Object
buyAds Array of Collection of buy ad details
Object
> adId String Ad Id
> minSellOrders String Minimum number of sell orders completed by the trading
party
> side String Specifies the transaction side or direction. Valid values:
buy,sell,block_buy,block_sell
> cryptoCurrency String Crypto currency symbol
> fiatCurrency String Fiat currency symbol
> minOrderSize String Order lower limit
> maxOrderSize String Order upper limit
> availableAmount String The available current quantity that can be bought/sold
> unitPrice String The unit price in fiat currency. Applicable only for ads with
price type as fixed price. Example: 1.1
> creator Object Information about the ad creator.
>> hasAlreadyTraded Boolean Specifies whether the ad creator has already traded with the
user
>> nickName String Nick name of the ad creator
>> userId String Id of the ad creator
>> cancelledOrders String Number of orders cancelled by the user
>> merchantId String Merchant Id
>> type String Ad creator type. Valid values: all, common (non-
authenticated), certified (authenticated)
>> completedOrders String Total orders completed by the ad creator
>> completionRate String Completion rate of the ad creator
>> isBlacklistedByUser Boolean Specifies whether the ad creator is blocked by the user
> paymentMethods Array of Collection of payment methods. Example: bank, aliPay,
String wxPay
> Array of Collection of payment method basic info set by the maker.
paymentMethodBasicIn Object Applicable for buy ads
foList
>> paymentMethod String Payment method name
>> Boolean Indicate whether the payment method instantly settle
isInstantSettlePayment
>> transferSpeed String Indicates the speed of the payment method. Valid values:
0 (nil): No specific speed requirement or processing time
mentioned.
1 (real time): Payment is expected to be processed
immediately or in real-time.
2 (instant crypto release): Payment release or confirmation is
expected to be instant for cryptocurrency transactions.
3 (up to X days): Payment processing may take up to a
certain number of days, where X represents the specific
number of days mentioned.
> fiatScale String Fiat Currency decimal places
> isOwner Boolean Specifies whether the ad belongs to the user
> minCompletedOrders String The minimum number of completed orders specified by the
ad creator
> maxCompletedOrders String The maximum number of completed orders specified by the
ad creator
> minCompletionRate String The minimum completion rate of the taker specified by the
ad creator
> targetGroup String User target group for the ad. Valid values:
common
certified
diamond
all
> String The maximum average completion time of the taker
maxAvgCompletionTim
e
> Boolean Specifies whether T+1 ad
isSecurityLimitApplicabl
e
> isProofRequired Boolean Indicates whether a proof (e.g., bank statement) is required
for CNY ads. Valid values: true, false
> verificationType String Verification type for overseas ads excluding CNY. Valid
values: 0 (No verification), 1 (Verification)
> fiatSymbol String Fiat currency symbol. Examples: ￥,$
recommendedAd Array of Recommended ads
Object
> userGroup String User group that can see ad. Valid values: 0 (new users), 1
(returning users), 2 (both)
> ad Object Ad details. Schema is the same as what it is for buy/sell ads
Sample Response:
1 {
2 "code": 0,
3 "data": [
4 {
5 "buyAds": [
6
7 {
8 "adId": "230206170034022",
9 "availableAmount": "154.00",
10 "creator": {
11 "cancelledOrders": "7",
12 "completedOrders": "200001",
13 "completionRate": "0.9999",
14 "hasAlreadyTraded": false,
15 "isBlacklistedByUser": false,
16 "merchantId": "bba0ea46b8",
17 "nickName": "1234424",
18 "type": "diamond",
19 "userId": "2460c7a78d"
20 },
21 "cryptoCurrency": "usdt",
22 "fiatCurrency": "cny",
23 "fiatScale": "2",
24 "fiatSymbol": "¥",
25 "isOwner": "false",
26 "isProofRequired": false,
27 "isSecurityLimitApplicable": false,
28 "maxAvgCompletionTime": "",
29 "maxCompletedOrders": "0",
30 "maxOrderSize": "646.00",
31 "minCompletedOrders": "0",
32 "minCompletionRate": "0.0",
33 "minKycLevel": "1",
34 "minOrderSize": "1.00",
35 "minSellOrders": "0",
36 "paymentMethodBasicInfoList": [],
37 "paymentMethods": [
38 "bank"
39 ],
40 "remark": "",
41 "side": "buy",
42 "targetGroup": "all",
43 "unitPrice": "6.4600",
44 "verificationType": "0"
45 },
46 {
47 "adId": "230208145147869",
48 "availableAmount": "29.00",
49 "creator": {
50 "cancelledOrders": "2",
51 "completedOrders": "0",
52 "completionRate": "0.0000",
53 "hasAlreadyTraded": false,
54 "isBlacklistedByUser": false,
55 "merchantId": "ceb26b15e6",
56 "nickName": "Test@1675838705282",
57 "type": "certified",
58 "userId": "e436507906"
59 },
60 "cryptoCurrency": "usdt",
61 "fiatCurrency": "cny",
62 "fiatScale": "2",
63 "fiatSymbol": "¥",
64 "isOwner": "false",
65 "isProofRequired": false,
66 "isSecurityLimitApplicable": false,
67 "maxAvgCompletionTime": "",
68 "maxCompletedOrders": "0",
69 "maxOrderSize": "187.34",
70 "minCompletedOrders": "0",
71 "minCompletionRate": "0.0",
72 "minKycLevel": "1",
73 "minOrderSize": "1.00",
74 "minSellOrders": "0",
75 "paymentMethodBasicInfoList": [],
76 "paymentMethods": [
77 "bank"
78 ],
79 "remark": "",
80 "side": "buy",
81 "targetGroup": "all",
82 "unitPrice": "6.4600",
83 "verificationType": "0"
84 }
85 ],
86 "recommendedAd": {
87 "ad": {
88 "adId": "230710173636129",
89 "availableAmount": "999999.00",
90 "creator": {
91 "cancelledOrders": "0",
92 "completedOrders": "0",
93 "completionRate": "0.0000",
94 "hasAlreadyTraded": false,
95 "isBlacklistedByUser": false,
96 "merchantId": "9a9aa9acc9",
97 "nickName": "ftt.maker",
98 "type": "diamond",
99 "userId": "4f9054eaf1"
100 },
101 "cryptoCurrency": "usdt",
102 "fiatCurrency": "cny",
103 "fiatScale": "2",
104 "fiatSymbol": "¥",
105 "isOwner": "false",
106 "isProofRequired": false,
107 "isSecurityLimitApplicable": false,
108 "maxAvgCompletionTime": "",
109 "maxCompletedOrders": "0",
110 "maxOrderSize": "6999993.00",
111 "minCompletedOrders": "0",
112 "minCompletionRate": "0.0",
113 "minKycLevel": "1",
114 "minOrderSize": "1.00",
115 "minSellOrders": "0",
116 "paymentMethodBasicInfoList": [],
117 "paymentMethods": [
118 "bank"
119 ],
120 "remark": "",
121 "side": "sell",
122 "targetGroup": "all",
123 "unitPrice": "7.0000",
124 "verificationType": "0"
125 },
126 "userGroup": "0"
127 },
128 "sellAds": [
129 {
130 "adId": "230710173636129",
131 "availableAmount": "999999.00",
132 "creator": {
133 "cancelledOrders": "0",
134 "completedOrders": "0",
135 "completionRate": "0.0000",
136 "hasAlreadyTraded": false,
137 "isBlacklistedByUser": false,
138 "merchantId": "9a9aa9acc9",
139 "nickName": "ftt.maker",
140 "type": "diamond",
141 "userId": "4f9054eaf1"
142 },
143 "cryptoCurrency": "usdt",
144 "fiatCurrency": "cny",
145 "fiatScale": "2",
146 "fiatSymbol": "¥",
147 "isOwner": "false",
148 "isProofRequired": false,
149 "isSecurityLimitApplicable": false,
150 "maxAvgCompletionTime": "",
151 "maxCompletedOrders": "0",
152 "maxOrderSize": "6999993.00",
153 "minCompletedOrders": "0",
154 "minCompletionRate": "0.0",
155 "minKycLevel": "1",
156 "minOrderSize": "1.00",
157 "minSellOrders": "0",
158 "paymentMethodBasicInfoList": [],
159 "paymentMethods": [
160 "bank"
161 ],
162 "remark": "",
163 "side": "sell",
164 "targetGroup": "all",
165 "unitPrice": "7.0000",
166 "verificationType": "0"
167 }
168 ]
169 }
170 ],
171 "msg": ""
172 }
1.8 Get Ad share info
Gets Ad sharing info with QRcode, url, ad details. This is similar to the ad share feature on
web/mobile.
HTTP Request
GET /api/v5/p2p/ad/share-info
Request Parameters
Parameter Type Require Description
d
adId String No Ad id for which sharing info needs to be generated
Response Parameters
Parameter Type Description
adId String Ad id for which sharing info is generated
side String
Specifies the transaction side or direction. Valid values:
buy,sell,block_buy,block_sell
cryptoCurrency String Crypto currency symbol
fiatCurrency String Fiat currency symbol
cryptoDecimalPlaces String Crypto currency decimal places
fiatDecimalPlaces String Fiat currency decimal places
minOrderLimit String The minimum order limit. Example: 890.00
maxOrderLimit String The maximum order limit. Example: 990.00
unitPrice String The unit price in fiat currency. Applicable only for ads with price type
as fixed price. Example: 1.1
fiatPriceScale String Decimal places reserved for fiat currency
fiatPriceIncrement String Fiat currency increasing unit price gradient
paymentMethods Array of The payment methods which maker can transact in. Applicable only
String for 'buy' ads. Examples: bank,aliPay,wxPay
depositPaymentMeth Array of Collection of deposit payment methods
ods Object
> paymentMethod String Payment method code. Example: bank
> description String Description of payment method
remark String Additional information or instructions for the ad for taker
minKycLevel String The minimum identity verification level of the taker. Valid values:
1,2,3
targetGroup String User target group for the ad. Valid values:
common,certified,diamond,all
availableAmount String The available crypto quantity currently available for buying and
selling
nickName String Nick name of the creator
minCompletionRate String The minimum order completion rate of the taker. Example: 0.95
minCompletedOrder String The minimum number of completed orders specified by the ad
s creator
String
maxCompletedOrder The maximum number of completed orders specified by the ad
s creator
isPublic Boolean Indicates whether the ad is targeted for public or private
marketplace. Valid values: true,false
userLevel String Ad creator level. Valid values：common，certified，diamond
minKycLevel String The minimum identity verification level of the taker. Valid values:
1,2,3
1.9 Get Active ads
Get active ads for the user. Schema is similar to Get Ad API.
HTTP Request
GET /api/v5/p2p/ad/active-list
Request Parameters
Parameter Type Require Description
d
side String Yes Specifies the transaction side or direction. Use buy to indicate a
buy transaction, sell for a sell
transaction.
cryptoCurren String Yes The crypto currency symbol. Example: BTC
cy
fiatCurrency String Yes The fiat currency symbol. Example: USD
Response Parameters
Parameter Type Description
adId String Ad id
type String Ad price type. Valid values:
limit
floating_market
side String Specifies the transaction side or direction. Valid values:
buy
sell
cryptoCurrency String Crypto currency symbol
fiatCurrency String Fiat currency symbol
minOrderSize String Order lower limit
maxOrderSize String Order upper limit
availableAmount String The available crypto quantity currently available for buying and
selling
completedOrderCryptoA String The amount of crypto that has been traded till now
mount
completedOrderFiatAmou String The amount of fiat that has been traded till now
nt
onHoldAmount String The quantity that has been frozen but the order has not been
completed till now
unitPrice String Unit price
priceMargin String The price margin ratio for floating type ads. Applicable only for
ads with price type as floating price
creator Object Details of the ad creator
> userId String User Id
> nickName String Nick name of the user
> realName String Real name of the user
> type String User type. Valid values:
common
certified
diamond
all
> completedOrders String The number of orders completed by the user
> cancelledOrders String The number of orders canceled by the user
> completedSellOrders String The number of sell orders completed by the user
> completionRate String The order completion rate of the user
> kycLevel String The identity verification level of the user
> acceptStatus String Order acceptance status of the user. Valid values: 0 (do not
accept order), 1 (accept order)
> String Average payment time in seconds
avgPaymentTimeInSecon
ds
> String Average completion time in seconds
avgCompletionTimeInSec
onds
> createdTimestamp String User joining timestamp in milliseconds
> hasAlreadyTraded Boolea Specifies whether the user has traded in the past with the
n requester. Valid values: true, false
> Array of Collection of payment method basic info set by the maker.
paymentMethodBasicInfo Object Applicable for buy ads.
List
>> paymentMethod String Payment method name
>> isInstantSettlePayment Boolea Indicate whether the payment method instantly settle
n
>> transferSpeed String Indicates the speed of the payment method. Valid values:
0 (nil): No specific speed requirement or processing time
mentioned.
1 (real time): Payment is expected to be processed immediately
or in real-time.
2 (instant crypto release): Payment release or confirmation is
expected to be instant for cryptocurrency transactions.
3 (up to X days): Payment processing may take up to a certain
number of days, where X represents the specific number of days
mentioned.
minKycLevel String The minimum identity verification level of the taker. Valid values:
1,2,3
remark String Additional information or instructions for the ad for taker
createdTimestamp String Creation time of the ad
isHidden Boolea Specifies whether the ad is hidden or not
n
fiatPriceScale String Decimal places reserved for fiat currency
fiatPriceIncrement String Fiat currency increasing unit price gradient
fiatScale String Fiat Currency decimal places
cryptoScale String Crypto currency decimal places
isOwner Boolea Specifies whether the ad belongs to the user
n
minCompletedOrders String
The minimum number of orders completed by the taker
maxCompletedOrders String
The maximum number of orders completed by the taker
minSellOrders String
The minimum number of sell orders completed by the taker
minCompletionRate String
The minimum order completion rate of the taker
targetGroup String
User target group for the ad. Valid values:
common
certified
diamond
all
maxAvgCompleteTime String The maximum average completion time of the transaction
parties
isBlockTradeCategory Boolea Specifies whether the ad is a block trade ad (ad dealing with
n large amount)
isPriceOutOfRange Boolea Specifies whether index rate deviates too much
n
maxPaymentDurationInMi String The maximum time allowed for payment in minutes before
nutes timeout happens.
status String Order status. Valid values:
new
canceled
completed
creating
create_fail
canceling
cancel_fail
blacklistStatus String Blacklist status
merchantId String Merchant Id
status String
platformCommissionRate String Commission rate charged by the platform
isListedOnMarketplace Boolea Specifies whether the ad is listed on marketplace
n
unpaidOrderTimeoutInMi String Payment time in minutes
nutes
realFiatMaxAmountPerOr String Original order maximum amount
der
isSecurityLimitApplicable Boolea Specifies whether T+1 order
n
isProofRequired Boolea Specifies whether proof is required
n
verificationType String Specifies the verification type. Applies for Overseas Ads. Valid
values:
0 (no verification required)
1 (verification required)
verificationNotes Array of Notes for Verification Ads to be shown as a prompt to the taker
Object
>id Integer Verification note Id.
Valid values (CNY):
1 (Provide proof that the account funds used for payment have
been credited for more than X days)
Valid values (Overseas):
10 (Chat before payment)
11 (No 3rd party payment)
12 (Provide payment proof)
13 (ID verification)
>description String Text description of verification type
>viewType String For UI display can ignore for OpenAPI
> constraints Object Constraints specified by the user
>> active Boolea Specifies whether the constraint is active
n
>> max Integer Max payment account duration value
>> min Integer Min payment account duration value
>> maxLength Integer Max length for others constraint value
>variables Object Variables specified by the user for verification notes
>> num Integer Number
>> others String Miscellaneous
configuredPaymentMetho Array of Collection of maker payment information
dDetails objects
> paymentMethod String Payment method
> openStatus String Payment method switch state. Valid values:
open
close
unbound
> paymentMethodDetails Array of Collection of payment method details
objects
>> paymentMethodId String Payment method Id
>> accountNo String The account number of payment method
>> bankName String Bank name
minAccountAge String The number of days since the user has registered (sign-up date).
Example: 30
hiddenType String Order offline type. Valid values:
0
1
updatedTimestamp String Timestamp of latest modification of ad. Example: 1686652358497
String Maximum registration interval in days
userRegisteredIntervalInD
ays
latestUserRegisteredTime String Transaction party user maximum registration time. Example:
stamp 1686652358497
whitelistedCountries String Regions that the taker must be from, as set by the maker of the
ad
hiddenReason String All ads hidden reasons
hiddenCategory String Hidden Category. Valid values are:
1 (hide one)
0 (not hidden)
3 (out of stock)
blockedReasonList Array of Collection of all blocked reasons. Example: Your completion rate
strings is less than 0.5. We encourage you to increase it
1.10 Get Ad Config
Gets the ad config which is used to tell valid values for ad creation.
HTTP Request
GET /api/v5/p2p/ad/config
Request Parameters
Parameter Type
Requir Description
ed
side String Yes Specifies the transaction side or direction. Use buy to indicate a
buy transaction, sell for a sell
transaction.
cryptoCurrency String Yes The crypto currency symbol. Example: BTC
fiatCurrency String Yes The fiat currency symbol. Example: USD
isPublic Boolea No Indicates whether the ad is targeted for public or private
n marketplace. Valid values: true,false
Response Parameters
Parameter Type Description
blockTradeForUserAllow Boolea Specifies whether the user is eligible to place block trades. Valid
ed n values: true/false
blockTradeForFiatAllowe Boolea Specifies whether block trade is allowed for this fiat currency.
d n Valid values: true/false
minBlockTradeAmount String Specifies the transaction side or direction. Valid values:
buy
sell
orderLimits String Crypto currency symbol
> min String Limit lower value. Ad min and max values should be greater than
this value.
> max String Limit upper value. Ad min and max values should be less than this
value.
optimalPrice String Optimal price for buy/sell ads
tradableFiatCurrencies Array of Tradable fiat currencies based on kyc level of the user
Object
> currency String Fiat currency code. Examples: CNY, VND, USD
> symbol String Symbol of fiat currency. Examples: ￥, $
maxPaymentMethodsAll String Maximum number of payment methods allowed. Applicable only
owed for buy ads
maxDepositPaymentMet String Maximum number of payment methods allowed. Applicable only
hodsAllowed for sell ads
maxPaymentDurationAll String Provides possible values for maximum payment duration
owedValues (mayPaymentDuration in create ad API)
verificationNoteOptions Array of Type of verification options that the maker can set to be shown to
Object the taker for verification Ads. Only applicable for the CNY region
for now
optimalPrices Object Top buy top sell price
> String Current highest buy ad price
currentHighestBuyAdPric
e
> String Current lowest sell ad price
currentLowestSellAdPric
e
2. Order
2.1 Create Order
Creates a new ad.
HTTP Request
POST /api/v5/p2p/order/create
Request Parameters
Parameter Type Requir Description
ed
adId String Yes Ad id for which order would be placed against
cryptoAmount String Yes Crypto amount. Example: 1.1
cryptoCurrency String Yes Crypto currency for the ad. Example: "BTC"
fiatCurrency String Yes Fiat currency for the ad. Example: "USD"
makerPayment String No Maker payment method Id
MethodId
paymentMethod String Yes Payment method of the counterparty. When buying crypto, it's
the payment method of the maker.
totalFiatAmount String No Total fiat amount for the order. Example: 100.2
Response Parameters
Paramete Type Description
r
orderId String Id of the created order
status String Order status. Valid values: 2 (new), 3 (cancelled), 4 (completed)
orderProc String Order process status. Valid values:
essStatus 2 (new)
3 (cancelled)
4 (completed)
5 (creation in progress)
6 (creation failed)
7 (canceling)
8 (cancellation failed)
9 (completion in progress)
10 (completion failed)
2.2 Get Order
Gets the order information by order id.
HTTP Request
GET /api/v5/p2p/order
Request Parameters
Parame Type Require Description
ter d
orderId String Yes Order Id
Response Parameters
Parameter Type Description
orderId String Order Id
side String Specifies the transaction side or direction. Valid values: buy, sell
isBlockTradeCategor Boolean Indicates whether the transaction is classified as a block trade
y
orderStatus String Order status. Valid values: new, cancelled, completed
isFrozen Boolean Indicates whether the order is frozen
cryptoCurrency String Crypto currency symbol
fiatCurrency String Fiat currency symbol
unitPrice String The unit price of the order
priceMargin String The price margin ratio for floating type ads. Applicable only for ads
with price type as floating price
exchangeRate String Exchange rate
cryptoAmount String The amount of crypto currency traded
fiatAmount String The amount of fiat currency traded
paymentStatus String The payment status of the order. Valid values: unpaid, paid,
unreceived, confirmed, rejected
createdTimestamp String The timestamp when the order was created
completionTimesta String The timestamp when the order was completed
mp
updatedTimestamp String The timestamp of the last change made to the order
completionType String The type of completion for the order. Example: cancelled_by_buyer
expiredInSeconds String The expiration time of the order in seconds
expiredAfterInSecon String The expiration duration after completion in seconds
ds
frozenType String
The type of freeze applied to the order. Valid values: sellerRejectPaid,
customerService, sellerArbitration, appealFreeze
disputeStatus String The dispute status of the order. Valid values: 0 (not appealed), 1
(maker appealed), 2 (taker appealed), 3 (cancelled), 4 (completed)
disputeType String The type of dispute
disputeSubType String The subtype of dispute
disputeResult String The result of the dispute
disputeTime String The time of the dispute
hasMakerBeenRemin Boolean Indicates whether the maker has been reminded
ded
canRaiseDispute Boolean Indicates whether it is possible to raise dispute
reviewStatus String The review status of the order. Valid values: '1' (pending), '2'
(submitted), '3' (finalised), '4' (expired)
counterpartyDetail Object Counterparty details
> merchantId String Merchant id
> Object Taker collection payment method information
takerPaymentMetho
d
>> String Payment method Id
paymentMethodId
>> bankCode String Bank code
>> bankName String Bank name
>> bankBranchName String Bank branch name
>> accountNo String Payment method number. This could be bank card number, Alipay
account number, WeChat Id etc
>>paymentMethodN String Payment method name. It could be nick name of the user
ame
>> String WeChat QR code, Alipay QR code
paymentMethodQrC
odeUrl
>>type String Payment method type. Examples: BANK, ALIPAY, WXPAY,
WESTERN_UNION, PAY_PAL, SWIFT, PAY_NOW, PAYTM, QIWI
>> > currency String Fiat currency symbol. Example: CNY, USD
>> isDisabled Boolean Specifies whether the payment method is disabled
>>decodingUrl String Payment method QR code decoding URL
>>paymentDescripti String Payment method description. Example: bank payment, WeChat,
on Alipay
>> adsLinkedCount String Number of ads linked to this payment method
>>isInstantSettlePay Boolean Indicate whether the payment method instantly settle
ment
> orders String Number of buy/sell orders that the user has completed. Example: 10
> String Estimated crypto release time
estimatedReleaseTi
me
> userId String User Id
>nickName String Nick name of the user
> realName String Real name of the user
> type String User type. Valid values:
common
certified
diamond
> completedOrders String The number of orders completed by the user
> cancelledOrders String The number of orders canceled by the user
> String The number of sell orders completed by the user
completedSellOrders
>completionRate String The order completion rate of the user
>kycLevel String The identity verification level of the user
>acceptStatus String Order acceptance status of the user. Valid values: 0 (do not accept
order), 1 (accept order)
>avgPaymentTimeIn String Average payment time in seconds
Seconds
>avgCompletionTim String Average completion time in seconds
eInSeconds
>createdTimestamp String User joining timestamp in milliseconds
>hasAlreadyTraded Boolean Specifies whether the user has traded in the past with the requester.
Valid values: true, false
2.3 Get Orders by Filters
Get the order list filtered by parameters. Users can get the order list for the last 6 months.
HTTP Request
GET /api/v5/p2p/order/list
Request Parameters
Parameter Type Require Description
d
side String No Specifies the transaction side or direction. Use buy to indicate a
buy transaction, sell for a sell transaction, or all to include both buy
and sell transactions. Default: all
pageIndex String Yes Page index starting from 1. Default: 1
pageSize String Yes Number of orders to fetch. Default: 20
cryptoCurre String No Specifies crypto currencies. Valid values are comma-separated
ncies crypto currency symbols. Example: BTC, ETH
fiatCurrenci String No Specifies fiat currencies. Valid values are comma-separated fiat
es currency symbols. Example: CNY,USD
start String No Search start timestamp. Unix timestamp format in milliseconds.
end String No Search end timestamp. Unix timestamp format in milliseconds.
completion String No Specifies completion status category. Valid values:
Status all - all types of order are needed
pending - orders which aren't completed/cancelled
completed - orders which are completed/cancelled
Default: all
searchKeyw String No Search orders by either Order Id or User nickname
ord
Response Parameters
Parameter Type
Description
adId String
Id of the Ad against which order was placed
orderId String
Order Id
side String
Specifies the transaction side or direction. Valid values: buy,
sell
isBlockTradeCateg Boolea Indicates whether the transaction is classified as a block trade
ory n
orderStatus String Order status. Valid values: new, cancelled, completed
isFrozen Boolea Indicates whether the order is frozen
n
cryptoCurrency String Crypto currency symbol
fiatCurrency String Fiat currency symbol
unitPrice String The unit price of the order
priceMargin String The price margin ratio for floating type ads. Applicable only
for ads with price type as floating price
exchangeRate String Exchange rate
cryptoAmount String The amount of crypto currency traded
fiatAmount String The amount of fiat currency traded
paymentStatus String The payment status of the order. Valid values: unpaid, paid,
unreceived, confirmed, rejected
createdTimestamp String The timestamp when the order was created
completedTimesta String The timestamp when the order was completed
mp
updatedTimestam String The timestamp of the last change made to the order
p
completionType String The type of completion for the order. Example:
cancelled_by_buyer
expiredInSeconds String The expiration time of the order in seconds
expiredAfterInSeco String The expiration duration after completion in seconds
nds
frozenType String The type of freeze applied to the order. Valid values:
sellerRejectPaid, customerService, sellerArbitration,
appealFreeze
disputeStatus String The dispute status of the order. Valid values: 0 (not appealed),
1 (maker appealed), 2 (taker appealed), 3 (cancelled), 4
(completed)
disputeType String The type of dispute
disputeSubType String The subtype of dispute
disputeResult String The result of the dispute
disputeTime String The time of the dispute
hasMakerBeenRe Boolea Indicates whether the maker has been reminded
minded n
canRaiseDispute Boolea Indicates whether it is possible to raise dispute
n
reviewStatus String The review status of the order. Valid values: '1' (pending), '2'
(submitted), '3' (finalised), '4' (expired)
counterpartyDetail Object Counterparty details
>merchantId String Merchant id
>takerPaymentMet Object Taker collection payment method information
hod
>>paymentMethod String Payment method Id
Id
>>bankCode String Bank code
>>bankName String Bank name
>>bankBranchNa String Bank branch name
me
>>paymentMethod String Payment method number. This could be bank card number,
Number Alipay account number, WeChat Id etc
>>paymentMethod String Payment method name. It could be nick name of the user
Name
>>paymentMethod String WeChat QR code, Alipay QR code
QrCodeUrl
>>type String Payment method type. Examples: BANK, ALIPAY, WXPAY,
WESTERN_UNION, PAY_PAL, SWIFT, PAY_NOW, PAYTM, QIWI
>>>currency String Fiat currency symbol. Example: CNY, USD
>>isDisabled Boolea Specifies whether the payment method is disabled
n
>>decodingUrl String Payment method QR code decoding URL
>>paymentDescrip String Payment method description. Example: bank payment,
tion WeChat, Alipay
>>adsLinkedCount String Number of ads linked to this payment method
>>isInstantSettleP Boolea Indicate whether the payment method instantly settle
ayment n
>orders String Number of buy/sell orders that the user has completed.
Example: 10
>estimatedRelease String Estimated crypto release time
Time
>id String User Id
>nickName String Nick name of the user
>realName String Real name of the user
>targetGroup String User target group for the ad. Valid values:
common
certified
diamond
all
>completedOrders String The number of orders completed by the user
>cancelledOrders String The number of orders canceled by the user
>completedSellOr String The number of sell orders completed by the user
ders
>completionRate String The order completion rate of the user
>kycLevel String The identity verification level of the user
>acceptStatus String Order acceptance status of the user. Valid values: 0 (do not
accept order), 1 (accept order)
>avgPaymentTime String Average payment time in seconds
InSeconds
>avgCompletionTi String Average completion time in seconds
meInSeconds
>createdTimestam String User joining timestamp in milliseconds
p
>hasAlreadyTrade Boolea Specifies whether the user has traded in the past with the
d n requester. Valid values: true, false
2.4 Get Counterparty User Details
Obtain counterparty user information for the order.
HTTP Request
GET /api/v5/p2p/order/counterparty-user-info
Request Parameters
Parame Type Require Description
ter d
orderId String Yes Order id
Response Parameters
Parameter Type Description
merchantId String Merchant id
takerPaymentMeth Object Taker collection payment method information
od
>paymentMethodI String Payment method Id
d
>bankCode String Bank code
>bankName String Bank name
>bankBranchName String Bank branch name
>paymentMethodN String Payment method number. This could be bank card number, Alipay
umber account number, WeChat Id etc
>paymentMethodN String Payment method name. It could be nick name of the user
ame
>paymentMethodQ String WeChat QR code, Alipay QR code
rCodeUrl
>type String Payment method type. Examples: BANK, ALIPAY, WXPAY,
WESTERN_UNION, PAY_PAL, SWIFT, PAY_NOW, PAYTM, QIWI
>currency String Fiat currency symbol. Example: CNY, USD
>isDisabled String Specifies whether the payment method is disabled
>decodingUrl String Payment method QR code decoding URL
>paymentDescripti String Payment method description. Example: bank payment, WeChat, Alipay
on
>adsLinkedCount String Number of ads linked to this payment method
>isInstantSettlePay String Indicate whether the payment method instantly settle
ment
orders String Number of buy/sell orders that the user has completed. Example: 10
estimatedReleaseT String Estimated crypto release time
ime
userId String User Id
nickName String Nick name of the user
realName String Real name of the user
type String User type. Valid values:
common
certified
diamond
completedOrders String The number of orders completed by the user
cancelledOrders String The number of orders canceled by the user
completedSellOrde String The number of sell orders completed by the user
rs
completionRate String The order completion rate of the user
kycLevel String The identity verification level of the user
acceptStatus String Order acceptance status of the user. Valid values: 0 (do not accept
order), 1 (accept order)
avgPaymentTimeIn String Average payment time in seconds
Seconds
avgCompletionTim String Average completion time in seconds
eInSeconds
createdTimestamp String User joining timestamp in milliseconds
hasAlreadyTraded Boolean Specifies whether the user has traded in the past with the requester.
Valid values: true, false
2.5 Get Batch Counterparty Details for Orders
Obtain multiple counterparty user information for the orders.
HTTP Request
POST /api/v5/p2p/order/counterparty-user-list
Request Parameters
Parame Type Require Description
ter d
orderIds String Yes Order Ids
Response Parameters
Parameter Type Description
orderId String Order Id
realName Object Actual name of the counterparty
2.6 Get Trade Summary with User
Get a list of order cancellation reasons.
HTTP Request
GET /api/v5/p2p/order/trade-info
Request Parameters
Parame Type Require Description
ter d
userId String Yes Id of the user for which trade info is needed
Response Parameters
Paramete Type Description
r
tradeCoun String Number of trades
t
tradeAmo String Total amount traded
unt
side String Specifies the transaction side or direction.
2.7 Get Pending Order Details
Obtain pending order details for an ad.
HTTP Request
GET /api/v5/p2p/order/pending-order
Request Parameters
Parame Type Require Description
ter d
adId String Yes Ad id
Response Parameters
Parameter Type Description
orderId String Order Id
side String Specifies the transaction side or direction. Valid values: buy, sell
isBlockTradeCategory Boolean Indicates whether the transaction is classified as a block trade
orderStatus String Order status. Valid values: new, cancelled, completed
isFrozen Boolean Indicates whether the order is frozen
cryptoCurrency String Crypto currency symbol
fiatCurrency String Fiat currency symbol
unitPrice String The unit price of the order
priceMargin String
The price margin ratio for floating type ads. Applicable only for ads
with price type as floating price
exchangeRate String Exchange rate
cryptoAmount String The amount of crypto currency traded
fiatAmount String The amount of fiat currency traded
paymentStatus String The payment status of the order. Valid values: unpaid, paid,
unreceived, confirmed, rejected
createdTimestamp String The timestamp when the order was created
completionTimestamp String The timestamp when the order was completed
updatedTimestamp String The timestamp of the last change made to the order
completionType String The type of completion for the order. Example: cancelled_by_buyer
expiredInSeconds String The expiration time of the order in seconds
expiredAfterInSeconds String The expiration duration after completion in seconds
frozenType String The type of freeze applied to the order. Valid values:
sellerRejectPaid, customerService, sellerArbitration, appealFreeze
disputeStatus String The dispute status of the order. Valid values: 0 (not appealed), 1
(maker appealed), 2 (taker appealed), 3 (cancelled), 4 (completed)
disputeType String The type of dispute
disputeSubType String The subtype of dispute
disputeResult String The result of the dispute
disputeTime String The time of the dispute
hasMakerBeenRemind Boolean Indicates whether the maker has been reminded
ed
canRaiseDispute Boolean Indicates whether it is possible to raise dispute
reviewStatus String The review status of the order. Valid values: '1' (pending), '2'
(submitted), '3' (finalised), '4' (expired)
counterpartyDetail Object Counterparty details
>merchantId String Merchant id
>takerPaymentMethod Object Taker collection payment method information
>>paymentMethodId String Payment method Id
>>bankCode String Bank code
>>bankName String Bank name
>>bankBranchName String Bank branch name
>>paymentMethodNu String Payment method number. This could be bank card number, Alipay
mber account number, WeChat Id etc
>>paymentMethodNa String Payment method name. It could be nick name of the user
me
>>paymentMethodQrC String WeChat QR code, Alipay QR code
odeUrl
>>type String Payment method type. Examples: BANK, ALIPAY, WXPAY,
WESTERN_UNION, PAY_PAL, SWIFT, PAY_NOW, PAYTM, QIWI
>>>currency String Fiat currency symbol. Example: CNY, USD
>>isDisabled Boolean Specifies whether the payment method is disabled
>>decodingUrl String Payment method QR code decoding URL
>>paymentDescription String Payment method description. Example: bank payment, WeChat,
Alipay
>>adsLinkedCount String Number of ads linked to this payment method
>>isInstantSettlePaym String Indicate whether the payment method instantly settle
ent
>orders String Number of buy/sell orders that the user has completed. Example: 10
>estimatedReleaseTim String Estimated crypto release time
e
>userId String User Id
>nickName String Nick name of the user
>realName String Real name of the user
>targetGroup String User target group for the ad. Valid values:
common
certified
diamond
all
>completedOrders String The number of orders completed by the user
>cancelledOrders String The number of orders canceled by the user
>completedSellOrders String The number of sell orders completed by the user
>completionRate String The order completion rate of the user
>kycLevel String The identity verification level of the user
>acceptStatus String Order acceptance status of the user. Valid values: 0 (do not accept
order), 1 (accept order)
>avgPaymentTimeInS String Average payment time in seconds
econds
>avgCompletionTimeI String Average completion time in seconds
nSeconds
>createdTimestamp String User joining timestamp in milliseconds
>hasAlreadyTraded Boolean Specifies whether the user has traded in the past with the
requester. Valid values: true, false
2.8 Mark Order as Paid
Lets buyer mark the order as paid.
HTTP Request
POST /api/v5/p2p/order/mark-as-paid
Request Parameters
Parameter Type Requir Description
ed
orderId String Yes Id of the order for which payment is made
paymentProofFil String No Collections of payment proof file url
eUrls
makerPaymentM String No Maker payment method id
ethodId
rrnCode String No Retrieval Reference Number
Response Parameters
Paramete Type Description
r
orderId String Id of the order for which payment is made
2.9 Cancel Order
Cancels the order. Buyers cancel pending, unpaid, paid, or rejected orders, and sellers cancel
pending orders
HTTP Request
POST /api/v5/p2p/order/cancel
Request Parameters
Parame Type Require Description
ter d
orderId String Yes Id of the Order to be canceled
verificati String Yes Valid values:
onType 1, 2
Use 2 currently
amount String No Amount for which the order was placed. Example: 1.2
Response Parameters
Paramete Type Description
r
orderId String Id of the order which got cancelled
2.10 Mark Order as Unpaid
Lets seller mark the order as unpaid.
HTTP Request
POST /api/v5/p2p/order/mark-as-unpaid
Request Parameters
Parame Type Require Description
ter d
orderId String Yes Id of the order for which payment should be marked as unpaid
Response Parameters
Paramete Type Description
r
orderId String Id of the order for which payment is marked as unpaid
2.11 Release Crypto
Seller can release the crypto upon confirming the payment.
HTTP Request
POST /api/v5/p2p/order/release-crypto
Request Parameters
Parameter Type Requir Description
ed
orderId String Yes Id of the order for which crypto should be released
paymentProofFil String No Collections of payment proof file url
eUrls
verificationType String Yes Valid values:
1, 2
Use 2 currently
amount String No Amount received from the buyer. Example: 1.2
Response Parameters
Paramete Type Description
r
orderId String Id of the order for which crypto is released
2.12 Get Cancellation Reasons
Get a list of order cancellation reasons.
HTTP Request
GET /api/v5/p2p/order/cancel-reason-list
Request Parameters
Parame Type Require Description
ter d
orderId String Yes Order Id
Request Parameters
Paramete Type Description
r
reasonId String Reason Id
reason String Cancellation reason
subReaso Array of Sub reasons
ns Object
>reasonId String Sub-reason Id
>reason String Cancellation sub-reason
2.13 Get Unreleased Orders
Get order ids that haven't been processed for a long time.
HTTP Request
GET /api/v5/p2p/order/unreleased-orders
Response Parameters
Paramete Type Description
r
orderIds Array of Unreleased order Ids
String
waitingTi String Waiting time in minutes
meInMinu
tes
3. Payment Method
3.1 Add Payment Method
Adds a new payment method.
HTTP Request
GET /api/v5/p2p/payment-method/add
Request Parameters
Parameter Type Require Description
d
currency String Yes Fiat currency symbol. Examples: CNY, VND
type String Yes Type of payment method. Examples: BANK, ALIPAY, WXPAY,
WESTERN_UNION, PAY_PAL, SWIFT, PAY_NOW, PAYTM, QIWI
isEnabled Boolean Yes Specifies whether payment method should be enabled. Valid
values: true, false
application String Yes Type of application. Valid values: -1: (Disabled) 0 (Enabled), 1
Type (Deposit payment method, used for receiving payment), 2
(Withdrawal Payment method, used for paying)
details Object Yes Key-value pairs of fields required for adding payment method
where key is field name and value is field value. Example:
{"accountNo": "1234"}
Response Parameters
Paramete Type Description
r
payment String Id of the added Payment method
MethodId
3.2 Get Payment Method
Get payment method info.
HTTP Request
GET /api/v5/p2p/payment-method
Request Parameters
Parameter Type Require Description
d
paymentM String Yes Payment method id
ethodId
Response Parameters
Paramete Type Description
r
payment String Payment method Id
MethodId
bankCode String Bank code
bankNam String Bank name
e
bankBran String Bank branch name
chName
payment String Payment method number. This could be bank card number, Alipay account
MethodN number, WeChat Id etc
umber
payment String Payment method name. It could be nick name of the user
MethodN
ame
payment String WeChat QR code, Alipay QR code
MethodQr
CodeUrl
type String
Payment method type. Examples: BANK, ALIPAY, WXPAY, WESTERN_UNION,
PAY_PAL, SWIFT, PAY_NOW, PAYTM, QIWI
currency String Fiat currency symbol. Example: CNY, USD
isDisable Boolean Specifies whether the payment method is disabled
d
decoding String Payment method QR code decoding URL
Url
payment String Payment method description. Example: bank payment, WeChat, Alipay
Descriptio
n
adsLinked String Number of ads linked to this payment method
Count
isInstantS Boolean Indicate whether the payment method instantly settle
ettlePaym
ent
3.3 Get Payment Methods
Get all payment methods.
HTTP Request
GET /api/v5/p2p/payment-method/list
Response Parameters
Paramete Type Description
r
payment String Payment method Id
MethodId
bankCode String Bank code
bankNam String Bank name
e
bankBran String Bank branch name
chName
payment String Payment method number. This could be bank card number, Alipay account
MethodN number, WeChat Id etc
umber
payment String Payment method name. It could be nick name of the user
MethodN
ame
payment String WeChat QR code, Alipay QR code
MethodQr
CodeUrl
type String Payment method type. Examples: BANK, ALIPAY, WXPAY, WESTERN_UNION,
PAY_PAL, SWIFT, PAY_NOW, PAYTM, QIWI
currency String Fiat currency symbol. Example: CNY, USD
isDisable Boolean Specifies whether the payment method is disabled
d
decoding String Payment method QR code decoding URL
Url
payment String Payment method description. Example: bank payment, WeChat, Alipay
Descriptio
n
adsLinked String Number of ads linked to this payment method
Count
isInstantS Boolean Indicate whether the payment method instantly settle
ettlePaym
ent
3.4 Update Payment Method
Update the payment method.
HTTP Request
POST /api/v5/p2p/payment-method/update
Request Parameters
Parameter Type Require Description
d
paymentM String Yes Id of the Payment Method which needs to be updated
ethodId
currency String Yes Fiat currency symbol. Examples: CNY, VND
type String Yes Type of payment method. Examples: BANK, ALIPAY, WXPAY,
WESTERN_UNION, PAY_PAL, SWIFT, PAY_NOW, PAYTM, QIWI
isEnabled Boolean Yes Specifies whether payment method should be enabled. Valid
values: true, false
application String Yes Type of application. Valid values: -1: (Disabled) 0 (Enabled), 1
Type (Deposit payment method, used for receiving payment), 2
(Withdrawal Payment method, used for paying)
details Object Yes Key-value pairs of fields required for adding payment method
where key is field name and value is field value. Example:
{"accountNo": "1234"}
Response Parameters
Paramete Type Description
r
payment String Id of the updated Payment method
MethodId
3.5 Delete Payment Method
Delete the payment method.
HTTP Request
GET /api/v5/p2p/payment-method/delete
Request Parameters
Parameter Type Require Description
d
paymentM String Yes Id of the Payment Method which needs to be deleted
ethodId
Response Parameters
Paramete Type Description
r
payment String Id of the Payment Method which got deleted
MethodId
3.6 Update Payment Method Status
Delete the payment method.
HTTP Request
GET /api/v5/p2p/payment-method/update-status
Request Parameters
Parameter Type Require Description
d
paymentM String Yes Payment Method Id for which status needs to be updated
ethodId
disable Boolean Yes Specifies whether to disable the payment method
Response Parameters
Paramete Type Description
r
payment String Id of the Payment Method for which status got updated
MethodId
3.7 Get Supported Payment Methods
Get all payment methods which are supported by the currencies specified.
HTTP Request
GET /api/v5/p2p/payment-method/supported-list
Request Parameters
Parameter Type Require Description
d
currencies String Yes Fiat currencies for which supported payment methods are needed.
Valid values are comma-separated fiat currency symbols. Example:
CNY,USD
Response Parameters
Parameter Type Description
paymentMetho String Payment method
d
icon String Icon for the payment method
applicationTyp String Type of application. Valid values: -1: (Disabled) 0 (Enabled), 1 (Deposit
e payment method, used for receiving payment), 2 (Withdrawal Payment
method, used for paying)
currency String Fiat currency symbol
4. P2P Ticker
4.1 Get Swap Price
Get Swap Price.
HTTP Request
GET /api/v5/p2p/p2p-ticker/swap
Request Parameters
Parameter Type Require Description
d
cryptoCurr String Yes The crypto currency symbol. Example: BTC
ency
fiatCurrenc String Yes The fiat currency symbol. Example: USD
y
usdtAmou String Yes Amount of USDT
nt
Response Parameters
Type Description
Paramete
r
price String Price
swapFiatI String Swap fiat Id
d
swapAmo String Exchange amount
unt
swapFiat String Conversion quantity accuracy
Scale
fiatSymb String Fiat currency symbol. Examples: ￥,$
ol
4.2 Get All Crypto prices
Get all crypto prices for a fiat currency.
HTTP Request
GET /api/v5/p2p/p2p-ticker/all
Request Parameters
Parameter Type Require Description
d
fiatCurrenc String Yes The fiat currency symbol. Example: USD
y
Response Parameters
Paramete Type Description
r
prices String Mapping of Crypto currency symbol to price. Example: BTC -> 0.01
4.3 Get Platform ticker price
Get the price for the currency pair.
HTTP Request
GET /api/v5/p2p/p2p-ticker/platform-ticker
Request Parameters
Parameter Type Require Description
d
price String Yes Price
Response Parameters
Paramete Type Description
r
price String Price for the currency pair
4.4 Get Estimated price
Get estimated trading price for the currency pair.
HTTP Request
GET /api/v5/p2p/p2p-ticker/estimated-price
Request Parameters
Parameter Type Require Description
d
cryptoCurr String Yes The crypto currency symbol. Example: BTC
ency
fiatCurrenc String Yes The fiat currency symbol. Example: USD
y
side String No Specifies the transaction side or direction. Use buy to indicate a buy
transaction, sell for a sell
transaction.
depositNa String No Deposit name. Example: 'OKEX P2P'
me
paymentM String No Payment method. Example: bank
ethod
Response Parameters
Paramete Type Description
r
price String Price for the currency pair
5. User
5.1 Get Basic Information
Gets the basic information for the user.
HTTP Request
GET /api/v5/p2p/user/basic-info
Response Parameters
Parameter Type Description
userId String User Id
nickName String Nick name of the user
realName String Real name of the user
phoneNumber String Phone number of the user
email String Email of the user
type String User type. Valid values:
common
certified
diamond
completedOrders String The number of orders completed by the user
completedSellOrders String The number of sell orders completed by the user
cancelledOrders String The number of orders canceled by the user
completionRate String The order completion rate of the user
kycLevel String The identity verification level of the user. Valid values: 1, 2, 3
acceptStatus String Order acceptance status of the user. Valid values: 0 (do not accept
order), 1 (accept order)
avgPaymentTimeInSe String Average payment time in seconds
conds
avgCompletionTimeI String Average completion time in seconds
nSeconds
createdTimestamp String User joining timestamp in milliseconds
5.2 Get Id for UID
Get P2P user Id by UID (visible on Web/Mobile).
HTTP Request
GET /api/v5/p2p/user/id
Request Parameters
Parameter Type Require Description
d
uid String Yes UID of the user
Response Parameters
Paramete Type Description
r
userId String User Id of the user
5.3 Get Balance
Get balance for the user.
HTTP Request
GET /api/v5/p2p/user/balance
Request Parameters
Parameter Type Require Description
d
currencySy String Yes Currency symbol. Example: BTC
mbol
Response Parameters
Parameter Type Description
availableAmount String The available crypto quantity currently available for buying and selling
onHoldAmount String The quantity that has been frozen but the order has not been
completed till now
sellOrTransferLimit String Sell or transfer limit
currencySymbol String Currency symbol. Example: BTC
isSecurityLimitAppl Boolean Specifies whether the ad is T+1 ad
icable
5.4 Get Blacklist Users
Get details of blacklisted users.
HTTP Request
GET /api/v5/p2p/user/blacklist-users
Request Parameters
Parameter Type Require Description
d
currencySy String Yes Currency symbol. Example: BTC
mbol
Response Parameters
Parameter Type Description
userName String User name
createdTimestamp String Timestamp of the blacklisted action. Unix timestamp format in
milliseconds
buyerAvgPaidTime String The buyer average payment time in minutes
sellerAvgComplete String The seller's average release time in minutes
dTime
userType String User type. Valid values: common,certified,diamond
completionRate String Completion rate
orders String Number of total order. Includes completed and cancelled orders
userId String User Id
5.5 Add Blacklist User
Add user to the blacklist.
HTTP Request
POST /api/v5/p2p/user/add-user-to-blacklist
Request Parameters
Parameter Type Require Description
d
userId String Yes Id of the user who needs to be blacklisted
reasons String No Reasons for blacklisting. Comma separated reasons can be provided
otherReas String No Any other reason for blocking
on
orderId String No Order Id
Response Parameters
Parameter Type Description
userId String Id of the user who got blacklisted
5.6 Remove User from Blacklist
Add user to the blacklist.
HTTP Request
POST /api/v5/p2p/user/remove-user-from-blacklist
Request Parameters
Parameter Type Require Description
d
userId String Yes Id of the user who needs to be removed from the blacklist
Response Parameters
Parameter Type Description
userId String Id of the user who got removed from the blacklist
5.7 Get User statistics
Get current user badge related information.
HTTP Request
GET /api/v5/p2p/user/statistics
Response Parameters
Parameter Type Description
newOrders String Number of Orders in progress
newAds String Number of ads in progress
appealOrders String Number of orders in appeal
completedAppealO String Number of completed orders with appeal
rders
cancelledAppealOr String Number of cancelled orders with appeal
ders
waitPaidOrders String Number of orders pending payment
waitReleaseOrder String Number of to-be-released orders
cancelledOrders String Number of orders canceled by the user
completedOrders String Number of orders the user has completed
pendingActions String Number of user's pending actions
5.8 Update Online Status
Updates user online status. If the user chooses to be offline, no ad can be placed against the ads
created by the user.
HTTP Request
POST /api/v5/p2p/user/update-online-status
Request Parameters
Parameter Type Require Description
d
status String Yes User online status. Valid values: hidden (makes user offline), show
(makes user online)
Response Parameters
Parameter Type Description
status String Updated online status
6. Merchant
6.1 Get Basic Information
Gets the basic information of the merchant.
HTTP Request
GET /api/v5/p2p/merchant/basic-info
Response Parameters
Parameter Type Description
nickname String Nick name of the user
avatarImage String User image URL
description String Description of the merchant
status String Status of the merchant. Valid values: 0 (under review), 1 (passed
review), -1 (rejected)
remark String Remark
6.2 Get Merchant info by share code
Get shared information by sharing code.
HTTP Request
GET /api/v5/p2p/merchant/share-info
Request Parameters
Parameter Type Require Description
d
shareCode String Yes Share Code
Response Parameters
Parameter Type Description
realName String Real name of the user
userId String Id of the user
completedOrd String Number of orders completed by the user
ers
completionRat String Completion rate
e
isSelf Boolean Specifies whether the user is the requester
6.3 Get sharable basic info
Gets the basic information of the merchant along with the QR code which can be shared.
HTTP Request
GET /api/v5/p2p/merchant/share-profile
Response Parameters
Parameter Type Description
merchantId String Id of the Merchant
avatarImage String User image URL
totalOrders String Total orders
tradedUsers String Number of people merchant traded with
currencyPairs Array of Collection of currencies the merchant traded in.
Object
> cryptoCurrency String The crypto currency symbol. Example: BTC
> fiatCurrency String The fiat currency symbol. Example: USD
qrCode String Share link
password String Share password
6.4 Get Profile Information
Get merchant's profile (from the merchant himself/herself, or from others).
HTTP Request
GET /api/v5/p2p/merchant/profile
Request Parameters
Parameter Type Require Description
d
userId String No Id of the user for which information in required
Response Parameters
Parameter Type Description
merchantId String Id of the Merchant
avatarImage String User image URL
auditStatus String Audit status. Valid values: -1 (audit failed), 0 (audit in progress), 1
(audit passed), 2 (initialization completed, after N hours of audit
passed, the status changes to this status
completedBuyOrders String Total completed buy orders
tradedUsers String Number of people merchant traded with
merchantInfo30DayOr Array of 30 day order info
derInfo Object
> String 30 day completed orders count
completedOrders30Da
y
> String The number of users served for completed orders within 30 days
servedUsersComplete
dOrders30Day
> String 30 day completion rate
completionRate30Day
> String 30 day completion rate for buy orders
completionRateBuyOr
ders30Day
> String 30 day completion rate for sell orders
completionRateSellOr
ders30Day
positiveReviews String Number of positive reviews
negativeReviews String Number of negative reviews
positiveReviewPercent String Positive review percentage
age
totalReviews String
Number of reviews given for the user
commonOrderTotal String
The total transaction amount of the current site within half a year
(usd)
blacklistUserCount String Number of times the user has been blocked
followerCount String Followers count
isDisabled Boolean Specifies whether the account is frozen
countryId String KYC country
merchantRegisteredTi String Merchant registration timestamp. Unix timestamp format in
mestamp milliseconds
countryName String Country name
countryIcon String Country flag
isKycVerified Boolean Specifies whether the merchant is KYC verified
isPhoneVerified Boolean Specifies whether the user has completed phone verification
isEmailVerified Boolean Specifies whether the user has completed email verification
blacklistStatus String Blacklist status of the user. Valid values: NO_BLACK (No blacklist
relationship), BLACK_OTHER (Current user blacklisted the other
side), BLACKED (The other side blacklisted current user),
BLACK_EACH_OTHER (Current user and other use blacklisted each
other)
isFollowingUser Boolean Specifies whether the requester follows the user
isSelf Boolean Specifies whether the requester is the user itself
depositAmount String Merchant's deposit amount
depositCurrency String Merchant's deposit currency
6.5 Get Merchant Ads
Get merchant's add list (not for merchant himself/herself).
HTTP Request
GET /api/v5/p2p/merchant/ads
Request Parameters
Parameter Type Require Description
d
userId String Yes Id of the user for which ads are required
Response Parameters
Parameter Type Description
sellAds String Collection of sell ads. Schema is same as that of buy ads.
buyAds String Collection of buy ads.
> adId String Ad id
> type String Ad price type. Valid values:
limit
floating_market
> side String Specifies the transaction side or direction. Valid values:
buy
sell
> cryptoCurrency String Crypto currency symbol
> fiatCurrency String Fiat currency symbol
> minOrderSize String Order lower limit
> maxOrderSize String Order upper limit
> availableAmount String The available crypto quantity currently available for buying and
selling
> unitPrice String Unit price
> priceMargin String The price margin ratio for floating type ads. Applicable only for
ads with price type as floating price
> minKycLevel String The minimum identity verification level of the taker. Valid
values: 1,2,3
> remark String Additional information or instructions for the ad for taker
> createdTimestamp String Creation time of the ad
> isHidden Boolea Specifies whether the ad is hidden or not
n
> fiatPriceScale String Decimal places reserved for fiat currency
> fiatPriceIncrement String Fiat currency increasing unit price gradient
> fiatScale String Fiat Currency decimal places
> cryptoScale String Crypto currency decimal places
> minCompletedOrders String The minimum number of orders completed by the taker
> maxCompletedOrders String The maximum number of orders completed by the taker
> minSellOrders String The minimum number of sell orders completed by the taker
> minCompletionRate String The minimum order completion rate of the taker
> String The maximum time allowed for payment in minutes before
maxPaymentDurationInMi timeout happens.
nutes
> targetGroup String User target group for the ad. Valid values:
common
certified
diamond
all
> isSecurityLimitApplicable Boolea Specifies whether T+1 order
n
> isProofRequired Boolea Specifies whether proof is required
n
> verificationType String Specifies the verification type. Applies for Overseas Ads. Valid
values:
0 (no verification required)
1 (verification required)
paymentMethods String Collection of payment methods. Example: bank, aliPay, wxPay
fiatSymbol String Fiat symbol. Examples：￥,$
6.6 Get Followings
Gets the following list for the merchant.
HTTP Request
GET /api/v5/p2p/merchant/followings
Request Parameters
Parameter Type Require Description
d
pageIndex String Yes Current page index. Index starts from 1. Default value: 1
pageLengt String Yes Size of each page. Default value: 20
h
Response Parameters
Parameter Type Description
userId String Current page index. Index starts from 1. Default value: 1
merchantId String Size of each page. Default value: 20
nickname String Nick name of the merchant
realName String Real name of the merchant
avatarImage String Avatar image URL
registeredTimestamp String Registration timestamp. Unix timestamp format in milliseconds
userType String Type of the user. Valid values：common，certified，diamond
kycLevel String The identity verification level of the user. Valid values: 1, 2, 3
hasAlreadyTraded Boolean Specifies whether requester has traded with the following merchant
hasOnlineAd Boolean Specifies whether the merchant has online ad
6.7 Update following status
Follow/unfollow a user.
HTTP Request
POST /api/v5/p2p/merchant/update-following-status
Request Parameters
Parameter Type Require Description
d
userId String Yes Id of the user who should be followed/unfollowed
shouldFoll Boolean Yes Specifies whether to follow the user. Valid values: true (to follow),
ow false (un-follow)
Response Parameters
Parameter Type Description
userId String Id of the user who was followed/unfollowed
6.8 Update Basic Information
Update merchant's basic information.
HTTP Request
POST /api/v5/p2p/merchant/update-basic-info
Request Parameters
Parameter Type Require Description
d
avatarImag String Yes Merchant image URL
e
description String Yes Description of the merchant
7. Currency
7.1 Get Fiat Currencies
Retrieve supported Fiat Currencies for P2P.
HTTP Request
GET /api/v5/p2p/currency/fiat-currency-list
Response Parameters
Parameter Type Description
currency String The fiat symbol. Example: USD
name String Full name of currency
symbol String Fiat currency symbol. Examples: ￥,$
countryIcon String Country Icon
isBlockTradeSupporte Boolean Specifies whether block trade is supported
d
7.3 Get Currency Pair information
Retrieve supported Crypto currency pairs for a P2P fiat market.
HTTP Request
GET /api/v5/p2p/currency/currency-pair-list
Request Parameters
Parameter Type Require Description
d
fiatCurrenc String Yes The fiat currency symbol. Example: USD
y
Response Parameters
Parameter Type Description
cryptoCurrency String The crypto currency symbol. Example: BTC
fiatCurrency String The fiat currency symbol. Example: USD
cryptoSymbol String Crypto currency symbol
fiatName String Full name of fiat currency
fiatSymbol String Fiat currency symbol. Examples: ￥,$
fiatPriceScale String Decimal places reserved for fiat currency
fiatPriceIncrement String Fiat currency increasing unit price gradient
fiatScale String Fiat Currency decimal places
cryptoScale String Crypto currency decimal places
cryptoName String Full name of crypto currency
countryIcon String Country icon
8. Dispute
8.1 Get Dispute Types
Get available dispute types based on order.
HTTP Request
GET /api/v5/p2p/dispute/types
Request Parameters
Parameter Type Require Description
d
orderId String Yes Order Id
side String No Specifies the transaction side or direction. Use buy to indicate a buy
transaction, sell for a sell
transaction.
Response Parameters
Parameter Type Description
disputeId String Dispute id
subReason String Dispute subreason
code String Dispute code
hasSubType Boolean Specifies whether the dispute has sub-type
subType String Collections of sub-types if dispute has any
suggestions Array of Collection of suggestions. Schema is the same as the original object.
Object
> suggestText String Main suggestion message
> children Array of Sub-points for each suggestion
String
videoSuggestion String Video proof request suggestion message
imageSuggestion String Image proof request suggestion message
isImageSubmissionNe Boolean Indicates if the user needs to submit an image
eded
isRemarkSubmission Boolean Indicates if the user needs to submit a remark
Needed
isVideoSubmissionNe Boolean Indicates if the user needs to submit video
eded
Sample response:
1 {
2 "code": 0,
3 "data": [
4 {
5 "sell": [
6 {
7 "code": "14",
8 "disputeId": "SX14",
9 "hasSubType": true,
10 "imageSuggestion": "",
11 "isImageSubmissionNeeded": false,
12 "isRemarkSubmissionNeeded": true,
13 "isVideoSubmissionNeeded": true,
14 "subReason": "I received the payment but the order is
canceled",
15 "subType": [
16 {
17 "code": "2",
18 "disputeId": "SX1402",
19 "hasSubType": false,
20 "imageSuggestion": "",
21 "isImageSubmissionNeeded": false,
22 "isRemarkSubmissionNeeded": true,
23 "isVideoSubmissionNeeded": true,
24 "subReason": "Transfer the crypto to the buyer",
25 "subType": [],
26 "suggestions": [
27 {
28 "children": [],
29 "suggestText": "Try reaching out to the
other party to see if you can resolve the issue\n"
30 },
31 {
32 "children": [],
33 "suggestText": "Raise a dispute if you're
unable to resolve it."
34 }
35 ],
36 "videoSuggestion": ""
37 },
38 {
39 "code": "3",
40 "disputeId": "SX1403",
41 "hasSubType": false,
42 "imageSuggestion": "",
43 "isImageSubmissionNeeded": false,
44 "isRemarkSubmissionNeeded": true,
45 "isVideoSubmissionNeeded": true,
46 "subReason": "Customer Support to get account
information for refund",
47 "subType": [],
48 "suggestions": [
49 {
50 "children": [],
51 "suggestText": "Try reaching out to the
other party to see if you can resolve the issue\n"
52 },
53 {
54 "children": [],
55 "suggestText": "Raise a dispute if you're
unable to resolve it."
56 }
57 ],
58 "videoSuggestion": ""
59 }
60 ],
61 "suggestions": [
62 {
63 "children": [],
64 "suggestText": "Try reaching out to the other
party to see if you can resolve the issue\n"
65 },
66 {
67 "children": [],
68 "suggestText": "Raise a dispute if you're unable
to resolve it."
69 }
70 ],
71 "videoSuggestion": ""
72 }
73 ],
74 "buy": [
75 {
76 "code": "10",
77 "disputeId": "BX10",
78 "hasSubType": true,
79 "imageSuggestion": "",
80 "isImageSubmissionNeeded": false,
81 "isRemarkSubmissionNeeded": true,
82 "isVideoSubmissionNeeded": true,
83 "subReason": "I have paid but order is canceled",
84 "subType": [
85 {
86 "code": "1",
87 "disputeId": "BX1001",
88 "hasSubType": false,
89 "imageSuggestion": "",
90 "isImageSubmissionNeeded": false,
91 "isRemarkSubmissionNeeded": true,
92 "isVideoSubmissionNeeded": true,
93 "subReason": "I can't contact the counterparty",
94 "subType": [],
95 "suggestions": [
96 {
97 "children": [],
98 "suggestText": "If you have made the
payment but did not mark the order as paid, the seller has the obligation to
refund you or accept your new order. Refund fee asked by the seller is at
your own cost.\n"
99 },
100 {
101 "children": [],
102 "suggestText": "You can send ^the payment
proof^ and reach a mutual agreement with the seller using our chat."
103 },
104 {
105 "children": [],
106 "suggestText": "If you can't reach the
buyer, you can continue your dispute submission to our Customer Support."
107 }
108 ],
109 "videoSuggestion": "If you have already made
payment for the order, please send us video proofs that contain the following
information:\n\n1. Your bank account or payment platform used for the
order.\n\n2. Your name and bank account number.\n\n3. The transaction date
and the order amount.\n\n4. The P2P order page on the app (not on a separate
bank statement).\n\n5. The seller's bank account number or email ID used for
the order."
110 },
111 ],
112 "suggestions": [
113 {
114 "children": [],
115 "suggestText": "If you have made the payment but
did not mark the order as paid, the seller has the obligation to refund you
or accept your new order. Refund fee asked by the seller is at your own
cost.\n"
116 },
117 {
118 "children": [],
119 "suggestText": "You can send ^the payment proof^
and reach a mutual agreement with the seller using our chat."
120 },
121 {
122 "children": [],
123 "suggestText": "If you can't reach the buyer, you
can continue your dispute submission to our Customer Support."
124 }
125 ],
126 "videoSuggestion": "If you have already made payment for
the order, please send us video proofs that contain the following
information:\n\n1. Your bank account or payment platform used for the
order.\n\n2. Your name and bank account number.\n\n3. The transaction date
and the order amount.\n\n4. The P2P order page on the app (not on a separate
bank statement).\n\n5. The seller's bank account number or email ID used for
the order."
127 }
128 ],
129 "appealUrge": []
130 }
131 ],
132 "msg": ""
133 }
8.2 Create Dispute
Creates dispute for an order.
HTTP Request
POST /api/v5/p2p/dispute/create
Request Parameters
Parameter Type Require Description
d
orderId String Yes Order Id for which dispute should be created
disputeTyp String Yes Type of dispute
e
subDispute String No Type of sub-dispute
Type
messageTe String No Remark, necessary when dispute type is others
xt
imageUrls Array of No Image proof urls
String
videoUrls Array of No Video proof urls
String
disputeTyp String No Dispute type UID
eUid
Response Parameters
Parameter Type Description
disputeId String Id of the created dispute
8.3 Get Dispute Details
Get dispute details including messages.
HTTP Request
GET /api/v5/p2p/dispute/dispute-details
Request Parameters
Parameter Type Require Description
d
orderId String Yes Id of the order for which dispute information is needed
Response Parameters
Parameter Type Description
disputerSide String Specifies disputer side. Valid values: 0 (buyer), 1 (seller)
isDisputer String Specifies whether the current user is the disputer. Valid values: true,
false
disputeReason String Reason for the dispute
disputeSubReason String Sub-reason for the dispute
userLastReadTimesta String Last read timestamp of the user
mp
messages Array of Collections of message details
Object
> message String Message text
> sender String Sender of the message. Valid values: 0 (Self), 1 (Customer Support),
2 (Counterparty)
> senderName String Name of the message sender
> imageUrls String Image urls
> videoUrls String Video urls
> timestamp String Message sent timestamp. Unix timestamp format in milliseconds
Sample Response:
1 {
2 "code": 0,
3 "data": [
4 {
5 "disputeReason": "I received the payment but the order is
canceled",
6 "disputeSubReason": "Transfer the crypto to the buyer",
7 "disputerSide": "1",
8 "isDisputer": true,
9 "messages": [
10 {
11 "imageUrls": [],
12 "message": "",
13 "sender": "0",
14 "senderName": "",
15 "timestamp": "1721269451000",
16 "translatedMessage": "",
17 "videoUrls": []
18 },
19 {
20 "imageUrls": [],
21 "message": "",
22 "sender": "1",
23 "senderName": "abcd",
24 "timestamp": "1721269451000",
25 "translatedMessage": "",
26 "videoUrls": [
27
"https://static.coinall.ltd/cdn/oksupport/c2c/20240718_a8005793-9826-4c95-
b25d.mp4"
28 ]
29 },
30 {
31 "imageUrls": [],
32 "message": "",
33 "sender": "0",
34 "senderName": "",
35 "timestamp": "1721269431000",
36 "translatedMessage": "",
37 "videoUrls": []
38 },
39 {
40 "imageUrls": [],
41 "message": "",
42 "sender": "1",
43 "senderName": "test4fiat2",
44 "timestamp": "1721269431000",
45 "translatedMessage": "",
46 "videoUrls": [
47
"https://static.coinall.ltd/cdn/oksupport/c2c/20240718_f42ce0bb-a2c0-4c43-
9e2.mp4"
48 ]
49 }
50 ]
51 }
52 ],
53 "msg": ""
54 }
8.4 Send message
Send a message for the dispute.
HTTP Request
POST /api/v5/p2p/dispute/sendMessage
Request Parameters
Parameter Type Requir Description
ed
orderId String Yes Order Id
message String No Message text
imageUrls Array of String No User-uploaded image URLs
videoUrls Array of String No User-uploaded video URLs
Response Parameters
Parameter Type Description
id String Order Id for which evidence got updated
8.5 Cancel Dispute
Cancels the dispute.
HTTP Request
POST /api/v5/p2p/dispute/cancel
Request Parameters
Parameter Type Requir Description
ed
orderId String Yes Order Id
Response Parameters
Parameter Type Description
orderId String Id of the order for which dispute got cancelled
9. Chat
9.1 Get Chat history for order
Get chat history based on order. The messages are ordered from the latest to the oldest. System-
generated messages are not returned.
HTTP Request
GET /api/v5/p2p/chat/history
Request Parameters
Parameter Type Require Description
d
orderId String Optional • If the orderId is specified, the API will return all chat
messages related to that specific order. Note that once the order
is completed, no further chat messages can be retrieved for that
order.
• If the orderId is not provided, the API will return all available
chat messages between the counterparty
lastMessag String No Specifies the last message sequence number. Eg: "123"
eSequence This param is required if messages are required to be fetched
backword.
pageSize String Yes Specifies the number of messages to be retrieved.
Response Parameters
Parameter Type Description
sentTimestamp String Epoch timestamp for the message sent time
isSentBySelf String Specifies whether requestor is the sender as well
content String Text of the content. Eg: "Hello"
contentUrl Boolean If the message is of a media type (like an image/video, etc.), the URL
is returned. Content present at this URL can be retrieved for 30 days
from the time the content is uploaded.
lastMessageSequence String The sequence number of the message. Eg: "123"
9.2 Send message
Send message for the order to the counterparty.
HTTP Request
POST /api/v5/p2p/chat/send-message
Request Parameters
Parameter Type Requir Description
ed
orderId String Yes Order Id. Eg: "12345"
content String No Text of the content. Eg: "Hello"
contentUrl String No If the message is of a media type (like an image/video, etc.),
then specify the url. URL can be generated by calling file upload
API.
contentType String Yes Type of content.
101 => Text
102 => Image
112 => Video
Response Parameters
Parameter Type Description
isSentSuccessfully Boolean Specifies whether the message was sent successfully to the other
user or not.
10. File
10.1 Upload file
HTTP Request
POST /api/v5/p2p/file/upload
The input is multipart file.
Request Parameters
Parameter Type Requir Description
ed
file Multipa Yes
rt
Response Parameters
Parameter Type Description
path String Path of the uploaded file. Eg: "http://abc.com/xyz"
You might also like
- ETradeFinancial-API Technical DocumentationNo ratings yetETradeFinancial-API Technical Documentation146 pages
- (Master) ShopeePay Acquiring Service API (Internal Only. Please Export PDF For Partner)No ratings yet(Master) ShopeePay Acquiring Service API (Internal Only. Please Export PDF For Partner)145 pages
- Under Balanced Managed Pressure DrillingNo ratings yetUnder Balanced Managed Pressure Drilling19 pages
- Image Compression (Chapter 8) : CS474/674 - Prof. BebisNo ratings yetImage Compression (Chapter 8) : CS474/674 - Prof. Bebis128 pages
- Magento Enterprise Edition 1 10 User's GuideNo ratings yetMagento Enterprise Edition 1 10 User's Guide69 pages
- WeChat Payment API (OverseasCommonModeV1.3)No ratings yetWeChat Payment API (OverseasCommonModeV1.3)108 pages
- Beam Deflection - Moment Area Method PDFNo ratings yetBeam Deflection - Moment Area Method PDF10 pages
- Objective:: Power Plant Lab (Me-223L) Experiment No: 6 Title: Demonistration of Steam EngineNo ratings yetObjective:: Power Plant Lab (Me-223L) Experiment No: 6 Title: Demonistration of Steam Engine5 pages
- The Motivation and Attitudes Towards Learning Slang in English A Study of The Fourth-Year Undergr100% (1)The Motivation and Attitudes Towards Learning Slang in English A Study of The Fourth-Year Undergr79 pages
- Simpl Pay in 3: API Integration Sequence Diagram 2 API Integration Explanation 3 API Specifications 4No ratings yetSimpl Pay in 3: API Integration Sequence Diagram 2 API Integration Explanation 3 API Specifications 423 pages
- Downward Compatibility:: Click On Tools - UtilityNo ratings yetDownward Compatibility:: Click On Tools - Utility2 pages
- Stormgain Public Api: Coingecko StandardsNo ratings yetStormgain Public Api: Coingecko Standards11 pages
- Massey Ferguson MF 3610 TRACTOR Service Parts Catalogue Manual (Part Number 1637182)No ratings yetMassey Ferguson MF 3610 TRACTOR Service Parts Catalogue Manual (Part Number 1637182)16 pages
- Payeezy Direct API Integration Guide: April 2015No ratings yetPayeezy Direct API Integration Guide: April 20158 pages
- IPOS ERPAPIDocumentation 091121 0609 36028No ratings yetIPOS ERPAPIDocumentation 091121 0609 3602855 pages
- 1.0 Executive Summary: Abdm3313 EntrepreneurshipNo ratings yet1.0 Executive Summary: Abdm3313 Entrepreneurship17 pages
- Brochure - Fibra-Cel Disks Questions and AnswersNo ratings yetBrochure - Fibra-Cel Disks Questions and Answers4 pages
- Proportional Relief Valves, High Pressure: SS-4R3ANo ratings yetProportional Relief Valves, High Pressure: SS-4R3A2 pages
- Security Aspects in IoT Based Cloud ComputingNo ratings yetSecurity Aspects in IoT Based Cloud Computing12 pages
- Steps Involved in Production and Utilization of A TV ProgrammeNo ratings yetSteps Involved in Production and Utilization of A TV Programme5 pages
- CenterFirst - API Integration Document - UAT v3.0.1No ratings yetCenterFirst - API Integration Document - UAT v3.0.124 pages
- MVolaApi-Documentation-API Merchant Pay v1.0No ratings yetMVolaApi-Documentation-API Merchant Pay v1.09 pages
- SV Epg-202306.1-Api-Spec en Core 20230914No ratings yetSV Epg-202306.1-Api-Spec en Core 20230914541 pages
- Child Dissociation The Descriptive Psychopathology Analysis of A CaseNo ratings yetChild Dissociation The Descriptive Psychopathology Analysis of A Case14 pages