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

Create a PaymentIntent

POST
/v1/payment_intents
After the PaymentIntent is created, attach a payment method and confirm to continue the payment.
When confirm=true is used during creation, it is equivalent to creating and confirming the PaymentIntent in the same call. You may use any parameters available in the confirm API when confirm=true is supplied.

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 *****************
Header Params

Body Params application/json

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

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,
    "canceled_at": null,
    "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-07-04 02:42:06
Previous
Error Code
Next
Update a PaymentIntent
Built with