orders
Cancel order
orders
Cancel order
Cancel a specific order by changing its status to CANCELLED. Requires write access.
PATCH
/
v0
/
orders
/
{orderIdOrNumber}
/
cancel
curl --request PATCH \
--url https://api.fungies.io/v0/orders/{orderIdOrNumber}/cancel \
--header 'Content-Type: application/json' \
--header 'x-fngs-public-key: <api-key>' \
--header 'x-fngs-secret-key: <api-key>' \
--data '{}'{
"status": "<string>",
"data": {
"order": {
"object": "order",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"status": "PENDING",
"value": 0,
"tax": 0,
"fee": 0,
"totalItems": 0,
"country": null,
"currency": null,
"currencyDecimals": null,
"createdAt": 4503599627370495,
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user": null,
"orderNumber": "<string>"
}
}
}Path Parameters
PATCH /v0/orders/:orderIdOrNumber/cancel Parameter
Body
application/json · object
PATCH /v0/orders/:orderIdOrNumber/cancel Request body
The body is of type object.
Response
200
application/json
PATCH /v0/orders/:orderIdOrNumber/cancel Positive response
Allowed value:
"success"Available options:
PENDING, PAID, FAILED, UNPAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, EXPIRED Required range:
0 <= x <= 9007199254740991Available options:
order Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Available options:
AFN, ALL, DZD, AOA, ARS, AMD, AWG, AUD, AZN, BSD, BDT, BBD, BZD, BMD, BOB, BAM, BWP, BRL, BHD, GBP, BND, BGN, BIF, BYN, KHR, CAD, CVE, KYD, KWD, XAF, XPF, CLP, CNY, COP, KMF, CDF, CRC, HRK, CZK, DKK, DJF, DOP, XCD, EGP, ETB, EUR, FKP, FJD, GMD, GEL, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, HUF, ISK, INR, IDR, ILS, JMD, JPY, JOD, KZT, KES, KGS, LAK, LBP, LSL, LRD, MOP, MKD, MGA, MWK, MYR, MVR, MRO, MUR, MXN, MDL, MNT, MAD, MZN, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NGN, NOK, OMR, PKR, PAB, PGK, PYG, PEN, PHP, PLN, QAR, RON, RUB, RWF, SHP, SVC, WST, STD, SAR, RSD, SCR, SLL, SGD, SBD, SOS, ZAR, KRW, LKR, SRD, SZL, SEK, CHF, TJS, TZS, THB, TND, TOP, TTD, TRY, UGX, UAH, AED, UYU, USD, UZS, VUV, VEF, VND, XOF, YER, ZMW, SLE Required range:
-9007199254740991 <= x <= 9007199254740991curl --request PATCH \
--url https://api.fungies.io/v0/orders/{orderIdOrNumber}/cancel \
--header 'Content-Type: application/json' \
--header 'x-fngs-public-key: <api-key>' \
--header 'x-fngs-secret-key: <api-key>' \
--data '{}'{
"status": "<string>",
"data": {
"order": {
"object": "order",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"status": "PENDING",
"value": 0,
"tax": 0,
"fee": 0,
"totalItems": 0,
"country": null,
"currency": null,
"currencyDecimals": null,
"createdAt": 4503599627370495,
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user": null,
"orderNumber": "<string>"
}
}
}