Vue d'ensemble #

La création d'une caisse complète se fait en quatre étapes :

1. Créer un produit
2. Créer un prix
3. Créer une caisse
4. Passer à la caisse pour terminer le paiement

Créer un produit #

Les produits et les prix sont des ressources essentielles pour de nombreuses intégrations WooshPay. Les produits définissent ce que votre entreprise propose, qu'il s'agisse de biens ou de services.

Demande

{
    "name" : "example product",
    "active":true,
    "description" : "une description",
    "metadata":{
        "key1" : "value1",
        "key3" : "value3"
    },
    "url" : "www.example.com"
}

Réponse

{
    "id" : "prod_1554351292598452224",
    "object" : "produit",
    "created" : 1665642282000,
    "active" : true,
    "description" : "some description",
    "métadonnées" : {
        "key1" : "value1",
        "key2" : "valeur2"
    },
    "name" : "exemple de produit",
    "livemode" : false,
    "url" : "www.example.com",
    "updated" : 1665642282000,
    "images" : null
}

Créer un prix #

Les prix définissent le montant et la fréquence de facturation des produits. Vous pouvez créer un ou plusieurs prix pour un produit.

Demande 1：Lier directement le produit existant

{
    "devise" : "GBP",
    "product":"prod_1554351292598452224",
    "unit_amount":5,
    "active":true,
    "metadata":{
        "key1" : "value1",
        "key2" : "value2"
    },
    "pseudo" : "un pseudo",
    "product_data":null,
    "lookup_key" : "test_lookup_key"
}

Demande 2：Créer un nouveau produit tout en créant un prix

{
    "devise" : "GBP",
    "product":null,
    "unit_amount":5,
    "active":true,
    "metadata":{
        "key1" : "value1",
        "key2" : "value2"
    },
    "pseudo" : "fengli",
    "product_data":{
        "id":null,
        "name" : "example product",
        "active":true,
        "description" : "très délicieux",
        "metadata":{
            "key1" : "value1",
            "key2" : "value2"
        },
        "url" : "www.example.com"
    },
    "billing_scheme" : "testscheme",
    "lookup_key" : "test_lookup_key"
}

Réponse

{
    "id":"price_1554384814788837376",
    "objet" : "prix",
    "created":1659429194000,
    "active":true,
    "currency" : "GBP",
    "metadata":{
        "key1" : "value1",
        "key2" : "value2"
    },
    "pseudo" : "un pseudo",
    "produit":{
        "id":"prod_1554351292598452224",
        "objet" : "produit",
        "created":1659421201000,
        "active":true,
        "description" : "très délicieux",
        "metadata":{
            "key1" : "value1",
            "key3" : "value3"
        },
        "name" : "taiwan fengli",
        "livemode":false,
        "url" : "www.example.com",
        "updated":1659422039000
    },
    "type" : "one_time",
    "livemode":false,
    "unit_amount":5,
    "billing_scheme" : "per_unit",
    "lookup_key" : "test_lookup_key"
}

Créer une caisse #

Une session de paiement est la représentation programmatique de ce que voit votre client lorsqu'il est redirigé vers le formulaire de paiement. Vous pouvez la configurer avec des options telles que :

• articles_de_ligne pour charger
• devises à utiliser

Vous devez également préciser :

• A success_urlune page sur votre site web pour rediriger votre client après qu'il ait effectué le paiement.
• A cancell_urlLe site web de l'entreprise, une page sur votre site web pour rediriger votre client s'il clique sur votre logo à la caisse.

Remarque : les sessions de vérification expirent 24 heures après leur création.

Demande

{
    "cancel_url" : "www.example.com",
    "mode" : "payment",
    "success_url" : "www.wooshpay.com",
    "line_items" :[
        {
            "price_data":{
                "devise" : "GBP",
                "produit":null,
                "unit_amount":5,
                "active":true,
                "metadata":{
                    "key1" : "value1",
                    "key2" : "value2"
                },
                "pseudo" : "fengli",
                "product_data":{
                    "id":null,
                    "name" : "example product",
                    "active":true,
                    "description" : "très délicieux",
                    "metadata":{
                        "key1" : "value1",
                        "key2" : "value2"
                    },
                    "url" : "www.example.com"
                },
                "billing_scheme" : "testscheme",
                "lookup_key" : "test_lookup_key"
            },
            "quantity":1
        }
    ]
}

Réponse

{
    "id":"cs_1580071142008291328",
    "objet" : "checkout.session",
    "created":1665553291000,
    "devise" : "GBP",
    "client" :"",
    "mode" : "payment",
    "livemode":false,
    "shipping":null,
    "status" : "open",
  "url" : "https://checkouttest.wooshpay.com/pay/cs_test_1580071142008291328?key=pk_test_dGVzdDpXWUg1eUF4OXZpUUF4UHNoYmdRRjVTTTE=",
    "cancel_url" : "www.baidu.com",
    "client_reference_id":null,
    "customer_email":null,
    "line_items":{
        "objet" : "liste",
        "data" :[
            {
                "id":"li_1580071142847152128",
                "object" : "item",
                "devise" : "GBP",
                "description" : "exemple de produit",
                "price":{
                    "id":"price_1580071142859735040",
                    "objet" : "prix",
                    "created":1665553291000,
                    "active":true,
                    "devise" : "GBP",
                    "metadata":{
                        "key1" : "value1",
                        "key2" : "value2"
                    },
                    "pseudo" : "fengli",
                    "produit":{
                        "id":"prod_1580071142880706560",
                        "objet" : "produit",
                        "created":1665553291000,
                        "active":true,
                        "description" : "une description",
                        "metadata":{
                            "key1" : "value1",
                            "key2" : "value2"
                        },
                        "name" : "example product",
                        "livemode":false,
                        "url" : "www.example.com",
                        "updated":1665553291000,
                        "images":null
                    },
                    "type" : "one_time",
                    "livemode":false,
                    "unit_amount":5,
                    "billing_scheme" : "per_unit",
                    "lookup_key" : "test_lookup_key"
                },
                "quantity":1,
                "amount_subtotal":5,
                "amount_total":5
            }
        ],
        "url":null,
        "has_more":null
    },
    "payment_intent":"pi_1580071150141046784",
    "payment_method_types":null,
    "payment_status" : "unpaid",
    "success_url" : "www.wooshpay.com",
    "amount_subtotal":5,
    "amount_total":5,
    "billing_address_collection" : "auto",
    "expires_at":1665639691214,
    "payment_link" :"",
    "payment_method_options":null,
    "phone_number_collection":null,
    "shipping_address_collection":null,
    "client_secret":"pi_1580071150141046784_secret_bsOGcAMewpe6orzCbZHMlomu"
}

Redirection de l'URL #

Après avoir créé une session de paiement, redirigez votre client vers l'URL renvoyée dans la réponse.