WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Payment Intents
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
      POST
    • Retrieve a refund
      GET
  • Webhooks
    • Create a Webhook
      POST
    • List All Webhooks
      GET
    • Retrieve a Webhook
      GET
    • Delete a Webhook
      DELETE
    • Update a Webhook
      POST
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • 订阅计划升降级与按比例分摊
      • subscription
        • 创建订阅
        • confirm
        • 更新item
        • 支付invoice
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
    • Expire a Session Copy
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Payment Intents

Cancel a PaymentIntent

POST
/v1/payment_intents/{id}/cancel
A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.
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.
You cannot cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

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:password
Example:
Authorization: Basic *****************
Path Params

Header Params

Body Params application/json

Example
{
    "cancellation_reason":"customer cancelled"
}

Request 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"
}
Modified at 2024-07-09 07:46:40
Previous
Update a PaymentIntent
Next
Capture a PaymentIntent
Built with