Visão geral #

Há quatro etapas para criar um checkout completo:

1. Criar um produto
2. Criar um preço
3. Criar um checkout
4. Vá até o caixa para concluir o pagamento

Criar um produto #

Produtos e preços são recursos essenciais para muitas integrações do WooshPay. Os produtos definem o que sua empresa oferece, sejam bens ou serviços.

Solicitação

{
    "name": "example product",
    "active":true,
    "description": "alguma descrição",
    "metadata":{
        "key1": "value1",
        "key3": "value3"
    },
    "url": "www.example.com"
}

Resposta

{
    "id": "prod_1554351292598452224",
    "object": "product" (produto),
    "created" (criado): 1665642282000,
    "active": true,
    "description" (descrição): "alguma descrição",
    "metadata": {
        "key1": "value1",
        "key2": "value2"
    },
    "name" (nome): "example product",
    "livemode": falso,
    "url": "www.example.com",
    "updated": 1665642282000,
    "images": null
}

Criar um preço #

Os preços definem quanto e com que frequência cobrar pelos produtos. Você pode criar um único ou vários preços para um produto.

Solicitação 1: vincular diretamente o produto existente

{
    "currency": "GBP",
    "product":"prod_1554351292598452224",
    "unit_amount":5,
    "active":true,
    "metadata":{
        "key1": "value1",
        "key2": "value2"
    },
    "nickname": "algum apelido",
    "product_data":null,
    "lookup_key": "test_lookup_key"
}

Solicitação 2: Crie um novo produto enquanto cria um preço

{
    "currency": "GBP",
    "product":null,
    "unit_amount":5,
    "active":true,
    "metadata":{
        "key1": "value1",
        "key2": "value2"
    },
    "apelido": "fengli",
    "product_data":{
        "id":null,
        "name": "exemplo de produto",
        "active":true,
        "description": "muito delicioso",
        "metadata":{
            "key1": "value1",
            "key2": "value2"
        },
        "url": "www.example.com"
    },
    "billing_scheme": "testscheme",
    "lookup_key": "test_lookup_key"
}

Resposta

{
    "id":"price_1554384814788837376",
    "object": "price",
    "created":1659429194000,
    "active":true,
    "currency": "GBP",
    "metadata":{
        "key1": "value1",
        "key2": "value2"
    },
    "nickname": "algum apelido",
    "product":{
        "id":"prod_1554351292598452224",
        "object": "product",
        "created":1659421201000,
        "active":true,
        "description": "muito delicioso",
        "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"
}

Criar checkout #

Uma sessão de checkout é a representação programática do que o cliente vê quando é redirecionado para o formulário de pagamento. Você pode configurá-la com opções como:

• itens_linha para cobrar
• moedas a serem usadas

Você também precisa especificar:

• A success_urlEm seu site, há uma página para redirecionar o cliente depois que ele concluir o pagamento.
• A cancel_urlSe o cliente clicar em seu logotipo no Checkout, o cliente será redirecionado para uma página em seu site.

Observação: as sessões de checkout expiram 24 horas após a criação.

Solicitação

{
    "cancel_url": "www.example.com",
    "mode": "payment",
    "success_url": "www.wooshpay.com",
    "line_items":[
        {
            "price_data":{
                "currency": "GBP",
                "product":null,
                "unit_amount":5,
                "active":true,
                "metadata":{
                    "key1": "value1",
                    "key2": "value2"
                },
                "apelido": "fengli",
                "product_data":{
                    "id":null,
                    "name": "exemplo de produto",
                    "active":true,
                    "description": "muito delicioso",
                    "metadata":{
                        "key1": "value1",
                        "key2": "value2"
                    },
                    "url": "www.example.com"
                },
                "billing_scheme": "testscheme",
                "lookup_key": "test_lookup_key"
            },
            "quantity":1
        }
    ]
}

Resposta

{
    "id":"cs_1580071142008291328",
    "objeto": "checkout.session",
    "created":1665553291000,
    "currency": "GBP",
    "customer":"",
    "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":{
        "object": "list",
        "data":[
            {
                "id":"li_1580071142847152128",
                "object": "item",
                "currency": "GBP",
                "description": "example product",
                "price":{
                    "id":"price_1580071142859735040",
                    "object": "price",
                    "created":1665553291000,
                    "active":true,
                    "currency": "GBP",
                    "metadata":{
                        "key1": "value1",
                        "key2": "value2"
                    },
                    "apelido": "fengli",
                    "product":{
                        "id":"prod_1580071142880706560",
                        "object": "product",
                        "created":1665553291000,
                        "active":true,
                        "description": "alguma descrição",
                        "metadata":{
                            "key1": "value1",
                            "key2": "value2"
                        },
                        "name": "exemplo de produto",
                        "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"
}

Redirecionar o URL #

Depois de criar uma sessão de checkout, redirecione seu cliente para o URL retornado na resposta.