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
    • 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

Update a PaymentIntent

POST
/v1/payment_intents/{id}
Updates properties on a PaymentIntent object without confirming.
Depending on which properties you update, you may need to confirm the PaymentIntent again. For example, updating the payment_method will always require you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties via the confirm API 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
id
string 
required
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json
Body Params application/json
currency
string 
required
Three-letter ISO currency code, in uppercase. Must be a supported currency.
customer
string 
optional
ID of the Customer
amount
integer 
required
Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00or100tocharge¥100,azero−decimalcurrency)..Theamountvaluesupportsuptoeightdigits(e.g.,avalueof99999999foraUSDchargeof999,999.99).
description
string 
optional
An arbitrary string attached to the object. Often useful for displaying to users.
metadata
object 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
shipping
object (Shipping) 
optional
Shipping information for this PaymentIntent.
address
object (Address) 
optional
carrier
string 
optional
The delivery service that shipped a physical product, such as FedEx, UPS, USPS, etc.
name
string 
optional
Recipient name.
phone
string 
optional
Recipient phone (including extension).
tracking_number
string 
optional
The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
merchant_order_id
string 
optional
The order ID created in merchant's order system that corresponds to this PaymentIntent
payment_method_types
array[string]
optional
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
Allowed values:
alipayalipay_hkboostcardtruemoneygcashkakaopaytouchngorabbit_line_paydanaklarnaidealgiropaysofortepstrustlybancontactp24unionpayfpxmcashgrabpaybank_transfer_idqrispromptpayovoshopeepayupiboletopaynowpix9paystitchbpi
payment_method_options
object (Payment Method Options) 
optional
Payment-method-specific configuration for this PaymentIntent.
card
object 
optional
alipayplus
object 
optional
alipay_hk
object 
optional
alipay
object 
optional
wechat_pay
object 
optional
sepa_debit
object 
optional
akulaku
object 
optional
truemoney
object 
optional
kakaopay
object 
optional
shopeepay
object 
optional
dana
object 
optional
pix
object 
optional
payment_method
string 
optional
ID of the payment method used in this PaymentIntent.
quantity
integer 
optional
The quantity of the items being purchased.
merchant_user_id
string 
optional
The user ID created in merchant's order system that corresponds to this PaymentIntent
capture_method
string 
optional
Possible enum values：automatic（default），manual
setup_future_usage
enum<string> 
optional
Indicates that you intend to make future payments with this PaymentIntent’s payment method. Providing this parameter will attach the payment method to the PaymentIntent’s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
Allowed values:
off_sessionon_session
payment_method_data
string 
optional
If provided, this object will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.
Example
{
    "amount":10,
    "currency":"USD",
    "confirm":true,
    "payment_method_data" : {
        "type":"card",
        "card":{
            "exp_month":"12",
            "exp_year":"2026",
            "number":"4111111111111111",
            "cvc":"123"
        },
        "billing_details":{
            "address": {
                "line1": "XX mansion",
                "line2": "XX Town",
                "city": "city",
                "state": "California",
                "country": "US",
                "postal_code": "55555"
            },
            "name": "Tom"
        }
    },
    "description": "product description",
    "quantity": 2,
    "metadata" : {
        "key1": "value1"
    },
    "merchant_user_id": "123456",
    "merchant_order_id": "Order112344343",
    "shipping": {
        "address":{
            "line1": "XX mansion",
            "line2": "XX Town",
            "city": "city",
            "state": "California",
            "country": "US",
            "postal_code": "xxx xxx"
        },
        "name": "tom",
        "phone": "xxxx"
    },
    "return_url":"https://your.website"
}

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/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "amount":10,
    "currency":"USD",
    "confirm":true,
    "payment_method_data" : {
        "type":"card",
        "card":{
            "exp_month":"12",
            "exp_year":"2026",
            "number":"4111111111111111",
            "cvc":"123"
        },
        "billing_details":{
            "address": {
                "line1": "XX mansion",
                "line2": "XX Town",
                "city": "city",
                "state": "California",
                "country": "US",
                "postal_code": "55555"
            },
            "name": "Tom"
        }
    },
    "description": "product description",
    "quantity": 2,
    "metadata" : {
        "key1": "value1"
    },
    "merchant_user_id": "123456",
    "merchant_order_id": "Order112344343",
    "shipping": {
        "address":{
            "line1": "XX mansion",
            "line2": "XX Town",
            "city": "city",
            "state": "California",
            "country": "US",
            "postal_code": "xxx xxx"
        },
        "name": "tom",
        "phone": "xxxx"
    },
    "return_url":"https://your.website"
}'

Responses

🟢200OK
application/json
Body
id
string 
optional
Unique identifier for the object, like 'pi_xxx'
object
string 
optional
'payment_intent'
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
currency
string 
required
Three-letter ISO currency code, in uppercase. Must be a supported currency.
customer
string 
optional
ID of the Customer
amount
integer 
required
Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00or100tocharge¥100,azero−decimalcurrency)..Theamountvaluesupportsuptoeightdigits(e.g.,avalueof99999999foraUSDchargeof999,999.99).
status
string 
optional
Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded
description
string 
optional
An arbitrary string attached to the object. Often useful for displaying to users.
metadata
object 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
livemode
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
shipping
object (Shipping) 
optional
Shipping information for this PaymentIntent.
address
object (Address) 
optional
carrier
string 
optional
The delivery service that shipped a physical product, such as FedEx, UPS, USPS, etc.
name
string 
optional
Recipient name.
phone
string 
optional
Recipient phone (including extension).
tracking_number
string 
optional
The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
merchant_order_id
string 
optional
The order ID created in merchant's order system that corresponds to this PaymentIntent
client_secret
string 
optional
The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
last_payment_error
object 
optional
The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
code
string 
optional
For some errors that could be handled programmatically, a short string indicating the error code reported.
message
string 
optional
A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
payment_method
object 
optional
The PaymentMethod object for errors returned on a request involving a PaymentMethod.
type
string 
optional
The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error.
decline_code
string 
optional
For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one.
next_action
object (Next Action) 
optional
If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
type
string 
optional
Type of the next action to perform
redirect_to_url
object 
optional
ddc_redirect
object 
optional
challenge_redirect
object 
optional
alipayplus_handle_redirect
object 
optional
alipay_handle_redirect
object 
optional
wechat_pay_display_qr_code
object 
optional
wechat_pay_redirect_to_android_app
object 
optional
wechat_pay_redirect_to_ios_app
object 
optional
wechat_pay_redirect_to_web
object 
optional
wechat_pay_official_account_params
object 
optional
truemoney_handle_redirect
object 
optional
akulaku_handle_redirect
object 
optional
bank_transfer_id_handle_redirect
object 
optional
promptpay_handle_redirect
object 
optional
dana_handle_redirect
object 
optional
shopeepay_handle_redirect
object 
optional
gcash_handle_redirect
object 
optional
rabbit_line_pay_handle_redirect
object 
optional
alipay_hk_handle_redirect
object 
optional
bpi_handle_redirect
object 
optional
pix_handle_redirect
object 
optional
oxxo_handle_redirect
object 
optional
spei_display_details
object 
optional
payment_method_types
array[string]
optional
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
Allowed values:
alipayalipay_hkboostcardtruemoneygcashkakaopaytouchngorabbit_line_paydanaklarnaidealgiropaysofortepstrustlybancontactp24unionpayfpxmcashgrabpaybank_transfer_idqrispromptpayovoshopeepayupiboletopaynowpix9paystitchbpi
payment_method_options
object (Payment Method Options) 
optional
Payment-method-specific configuration for this PaymentIntent.
card
object 
optional
alipayplus
object 
optional
alipay_hk
object 
optional
alipay
object 
optional
wechat_pay
object 
optional
sepa_debit
object 
optional
akulaku
object 
optional
truemoney
object 
optional
kakaopay
object 
optional
shopeepay
object 
optional
dana
object 
optional
pix
object 
optional
payment_method
string 
optional
ID of the payment method used in this PaymentIntent.
receipt_email
string 
optional
Email address that the receipt for the resulting payment will be sent to.
canceled_at
integer 
optional
Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
cancellation_reason
string 
optional
Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) .
confirmation_method
string 
optional
Possible enum values：
automatic (Default)
PaymentIntent can be confirmed using a publishable key. After next_action s are handled, no additional confirmation is required to complete the payment.
manual
All payment attempts must be made using a secret key. The PaymentIntent returns to the requires_confirmation state after handling next_actions, and requires your server to initiate each payment attempt with an explicit confirmation.
3ds_status
object 
optional
The status of 3DS result
cavv
string 
optional
This is the Cardholder Authentication Verification Value, indicating that the transaction has been authenticated. This only exists when no challenge is required, i.e., a successful frictionless authentication.
eci
integer 
optional
This is the Electronic Commerce Indicator code, which gets returned by the card issuer indicating whether the cardholder was successfully authenticated. Note that in some cases the eci value includes a leading zero, e.g., 01 or 02. Visa, Amex, JCB, and Diners Club 5 – Identifies a successfully authenticated transaction. 6 – Identifies an attempted authenticated transaction. 7 – Identifies a non-authenticated transaction. Mastercard 0 – Identifies a non-authenticated transaction. 1 – Identifies an attempted authenticated transaction. 2 – Identifies a successfully authenticated transaction. This only exists when no challenge is required, i.e., a frictionless authentication.
status
string 
optional
This is the status of the Authentication request.
Possible values are:
COMPLETED – The transaction has been completed.
PENDING – The transaction has not been completed yet.
FAILED – The authentication request failed.
three_d_result
string 
optional
This indicates the outcome of the authentication. Possible values are:
Y – The cardholder successfully authenticated with their card issuer.
A – The cardholder authentication was attempted.
N – The cardholder failed to successfully authenticate with their card issuer.
U – Authentication with the card issuer was unavailable.
C – Challenge Required; additional authentication is required.
R – Rejected transaction.
three_d_enrollment
string 
optional
This indicates whether the cardholder is enrolled in 3D Secure. Possible values are:
Y – Cardholder authentication is available
N – Cardholder is not enrolled in authentication
U – Cardholder authentication unavailable
three_d_secure_version
string 
optional
This is the 3D secure protocol version.
xid
string 
optional
This is the transaction identifier returned by the card issuer. This exists only for 3DS 1.0.2.
three_d_secure_server_transaction_id
string 
optional
The 3D Secure Server transaction Id. This exists only for 3D Secure 2.
amount_capturable
integer 
optional
Amount that can be captured from this PaymentIntent.
return_url
string 
required
The url that the cutomer will be redirected to.
quantity
integer 
optional
The quantity of the items being purchased.
merchant_user_id
string 
optional
The user ID created in merchant's order system that corresponds to this PaymentIntent
amount_received
integer 
optional
Amount that was collected by this PaymentIntent.
capture_method
string 
optional
Possible enum values：automatic（default），manual
invoice
string 
optional
ID of the invoice that created this PaymentIntent, if it exists.
Example
{
    "id": "pi_1604012360740110336",
    "object": "payment_intent",
    "created": 1671261323000,
    "currency": "USD",
    "amount": 10,
    "status": "succeeded",
    "description": "product description",
    "metadata": {
        "key1": "value1"
    },
    "livemode": false,
    "shipping": {
        "address": {
            "city": "city",
            "country": "US",
            "line1": "XX mansion",
            "line2": "XX Town",
            "state": "California",
            "postal_code": "xxx xxx"
        },
        "carrier": null,
        "name": "tom",
        "phone": "xxxx",
        "tracking_number": null
    },
    "customer": null,
    "quantity": 2,
    "invoice": null,
    "merchant_user_id": "123456",
    "merchant_order_id": "Order112344343",
    "client_secret": "pi_1604012360740110336_secret_YYFHuk8Lago3RSqjbVFe68AA",
    "last_payment_error": null,
    "next_action": null,
    "payment_method_types": "[\"wechat_pay\",\"alipay\",\"card\"]",
    "receipt_email": null,
    "cancel_at": "",
    "cancellation_reason": null,
    "confirmation_method": "automatic",
    "payment_method_options": "{\"card\":{\"request_three_d_secure\":\"auto\",\"capture_method\":\"automatic\"}}",
    "3ds_status": null,
    "amount_capturable": null,
    "return_url": "https://your.website",
    "payment_method": "pm_1604012357044928512",
    "amount_received": null,
    "capture_method": "automatic"
}
Modified at 2024-02-27 07:28:33
Previous
Create a PaymentIntent
Next
Cancel a PaymentIntent
Built with