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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Expire a Session Copy

Update a PaymentIntent