WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Setup Intents
  • API introduction
  • Error code
  • Checkout
    • Create a Session
      POST
    • Expire a Session
      POST
    • Retreive a Session
      GET
    • List All Checkout Sessions
      GET
    • Retrieve a Checkout Session's line items
      GET
    • Expire a Session Copy
      POST
  • 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
  • Setup Intents
    • Create a SetupIntent
      POST
    • Retrieve a SetupIntent
      GET
    • Cancel a SetupIntent
      POST
    • List all SetupIntents
      GET
    • List all SetupAttempts
      GET
    • Update a SetupIntent
      POST
    • Confirm a SetupIntent
      POST
  • Refunds
    • Create a refund
      POST
    • Retrieve a refund
      GET
  • 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
  • Charges
    • Retrieve a charge
    • List all charges
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Payment Methods
    • Create a PaymentMethod
    • Retrieve a PaymentMethod
    • Retrieve a Customer's PaymentMethod
    • Update a PaymentMethod
    • List PaymentMethods
    • List a Customer's PaymentMethods
    • Attach a PaymentMethod to a Customer
    • Detach a PaymentMethod from a Customer
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • 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
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • 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. Setup Intents

Update a SetupIntent

POST
/v1/setup_intents/{id}

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
{
    "customer": "string",
    "description": "string",
    "metadata": {},
    "payment_method": "string",
    "payment_method_types": [
        "string"
    ],
    "payment_method_options": {
        "card": {
            "request_three_d_secure": "string"
        }
    },
    "payment_method_data": {
        "type": "card",
        "billing_details": {
            "address": {
                "city": "string",
                "country": "string",
                "line1": "string",
                "line2": "string",
                "postal_code": "string",
                "state": "string"
            },
            "email": "string",
            "name": "string",
            "phone": "string"
        },
        "card": {
            "exp_month": "string",
            "exp_year": "string",
            "number": "string",
            "cvc": "string",
            "name": "string"
        },
        "wechat_pay": {
            "payment_code": "string"
        },
        "alipayplus": {
            "payment_code": "string"
        }
    }
}

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/setup_intents/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "customer": "string",
    "description": "string",
    "metadata": {},
    "payment_method": "string",
    "payment_method_types": [
        "string"
    ],
    "payment_method_options": {
        "card": {
            "request_three_d_secure": "string"
        }
    },
    "payment_method_data": {
        "type": "card",
        "billing_details": {
            "address": {
                "city": "string",
                "country": "string",
                "line1": "string",
                "line2": "string",
                "postal_code": "string",
                "state": "string"
            },
            "email": "string",
            "name": "string",
            "phone": "string"
        },
        "card": {
            "exp_month": "string",
            "exp_year": "string",
            "number": "string",
            "cvc": "string",
            "name": "string"
        },
        "wechat_pay": {
            "payment_code": "string"
        },
        "alipayplus": {
            "payment_code": "string"
        }
    }
}'

Responses

🟢200OK
application/json
Body

Example
{
    "id": "string",
    "object": "string",
    "cancellation_reason": "string",
    "client_secret": "string",
    "created": 0,
    "customer": "string",
    "description": "string",
    "last_setup_error": {
        "code": "string",
        "decline_code": "string",
        "message": "string",
        "param": "string",
        "payment_method": {
            "id": "string",
            "object": "string",
            "created": 0,
            "customer": "string",
            "metadata": {},
            "livemode": true,
            "billing_details": {
                "address": {
                    "city": "string",
                    "country": "string",
                    "line1": "string",
                    "line2": "string",
                    "postal_code": "string",
                    "state": "string"
                },
                "email": "string",
                "name": "string",
                "phone": "string"
            },
            "type": "card",
            "card": {
                "brand": "string",
                "checks": {
                    "address_line1_check": "string",
                    "address_zip_check": "string",
                    "cvc_check": "string"
                },
                "country": "string",
                "exp_month": 0,
                "exp_year": 0,
                "fingerprint": "string",
                "funding": "string",
                "last4": "string",
                "metadata": {}
            }
        },
        "payment_method_type": "string",
        "type": "string"
    },
    "latest_attempt": "string",
    "livemode": true,
    "mandate": "string",
    "metadata": {},
    "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": "string",
    "payment_method_options": {
        "card": {
            "request_three_d_secure": "string"
        }
    },
    "payment_method_types": [
        "string"
    ],
    "single_use_mandate": "string",
    "status": "string",
    "return_url": "string"
}
Modified at 2023-01-28 08:29:31
Previous
List all SetupAttempts
Next
Confirm a SetupIntent
Built with