- API introduction
- Error code
- Checkout
- Payment Intents
- Setup Intents
- Refunds
- Payouts
- Charges
- Webhooks
- Events
- Payment Methods
- Files
- Disputes
- Balance
- Products
- Prices
- Payment Links
- Customers
- Invoices
- Invoice Items
- Invoice Line Item
- Subscriptions
- Subscription Items
- Issuing
- Coupons
- Promotion Code
- Accounts
- Fx Quote
Cancel a PaymentIntent
POST
/v1/payment_intents/{id}/cancel
Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status=’requires_capture’, the remaining amount_capturable will automatically be refunded.
Request
Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:passwordExample:
Authorization: Basic *****************Path Params
Header Params
Body Params application/json
Example
{
"cancellation_reason":"customer cancelled"
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://apitest.wooshpay.com/v1/payment_intents//cancel' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
"cancellation_reason":"customer cancelled"
}'Responses
🟢200OK
application/json
Body
Example
{
"id": "string",
"object": "string",
"created": 0,
"currency": "string",
"customer": "string",
"amount": 0,
"status": "string",
"description": "string",
"metadata": {},
"livemode": true,
"shipping": {
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postal_code": "string",
"state": "string"
},
"carrier": "string",
"name": "string",
"phone": "string",
"tracking_number": "string"
},
"merchant_order_id": "string",
"client_secret": "string",
"last_payment_error": {
"code": "string",
"message": "string",
"payment_method": {},
"type": "string",
"decline_code": "string"
},
"next_action": {
"type": "string",
"redirect_to_url": {
"return_url": "string",
"url": "string"
},
"ddc_redirect": {
"return_url": "string",
"url": "string"
},
"challenge_redirect": {
"return_url": "string",
"url": "string"
},
"alipayplus_handle_redirect": {
"return_url": "string",
"schemeUrl": "string",
"applinkUrl": "string",
"normalUrl": "string"
},
"alipay_handle_redirect": {
"native_data": "string",
"native_url": "string",
"return_url": "string",
"url": "string"
},
"wechat_pay_display_qr_code": {
"data": "string",
"data_ur": "string",
"image_url_png": "string",
"image_url_svg": "string"
},
"wechat_pay_redirect_to_android_app": {
"native_url": "string"
},
"wechat_pay_redirect_to_ios_app": {
"native_url": "string"
},
"wechat_pay_redirect_to_web": {
"url": "string"
},
"wechat_pay_official_account_params": {
"appId": "string",
"timeStamp": "string",
"nonceStr": "string",
"signType": "string",
"paySign": "string",
"package": "string"
},
"truemoney_handle_redirect": {
"url": "string"
},
"akulaku_handle_redirect": {
"url": "string"
},
"bank_transfer_id_handle_redirect": {
"url": "string"
},
"promptpay_handle_redirect": {
"url": "string"
},
"dana_handle_redirect": {
"url": "string"
},
"shopeepay_handle_redirect": {
"url": "string"
},
"gcash_handle_redirect": {
"url": "string"
},
"rabbit_line_pay_handle_redirect": {
"url": "string"
},
"alipay_hk_handle_redirect": {
"url": "string"
},
"bpi_handle_redirect": {
"url": "string"
},
"pix_handle_redirect": {
"url": "string",
"qrcode": "string",
"timeout": 0
},
"oxxo_handle_redirect": {
"timeout": "string",
"bar_code": "string",
"url": "string"
},
"spei_display_details": {}
},
"payment_method_types": [
"alipay"
],
"payment_method_options": {
"card": {
"request_three_d_secure": "any",
"setup_future_usage": "on_session",
"capture_method": "string",
"tax_id": "string"
},
"alipayplus": {
"terminal_type": "APP",
"os_type": "IOS"
},
"alipay_hk": {
"terminal_type": "APP",
"os_type": "IOS"
},
"alipay": {
"terminal_type": "APP",
"os_type": "IOS"
},
"wechat_pay": {
"terminal_type": "WEB",
"client_ip": "string",
"os_type": "IOS",
"openid": "string"
},
"sepa_debit": {},
"akulaku": {
"terminal_type": "WEB",
"os_type": "IOS"
},
"truemoney": {
"terminal_type": "WEB",
"os_type": "IOS"
},
"kakaopay": {
"terminal_type": "WEB",
"os_type": "IOS"
},
"shopeepay": {
"terminal_type": "string",
"os_type": "string"
},
"dana": {
"terminal_type": "string",
"os_type": "string"
},
"pix": {
"tax_id": "string"
}
},
"payment_method": "string",
"receipt_email": "string",
"canceled_at": 0,
"cancellation_reason": "string",
"confirmation_method": "string",
"3ds_status": {
"cavv": "string",
"eci": 0,
"status": "string",
"three_d_result": "string",
"three_d_enrollment": "string",
"three_d_secure_version": "string",
"xid": "string",
"three_d_secure_server_transaction_id": "string"
},
"amount_capturable": 0,
"return_url": "string",
"quantity": 0,
"latest_charge": "string",
"merchant_user_id": "string",
"amount_received": 0,
"capture_method": "string",
"invoice": "string",
"setup_future_usage": "off_session",
"localization": {
"applied": true,
"source": {
"amount": "string",
"currency": "string"
},
"localized": {
"amount": "string",
"currency": "string"
},
"fx": {
"rate": "string"
}
}
}Modified at 2024-07-09 07:46:40