Página de Checkout (E-com)

Como usar a Página de Checkout Pagsmile para criar um pagamento no Brasil.

Payin através da página de checkout Pagsmile

POST https://gateway-test.pagsmile.com/trade/create

Este endpoint permite que você envie um pagamento usando a página de checkout Pagsmile

Headers

Name
Type
Description

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

Request Body

Name
Type
Description

app_id*

string

App Id criado no dashboard

- Max. 32 chars -

method

string

Se estiver vazio, todos os métodos ativados serão mostrados. Se não estiver vazio, apenas o método selecionado será mostrado. Confira aqui todos os métodos.

out_trade_no*

string

ID fornecido pelo merchant em seu sistema - Max. 64 chars -

notify_url*

string

Para onde a Pagsmile enviará a notificação

timestamp*

string

yyyy-MM-dd HH:mm:ss - Max. 19 chars -

subject*

string

motivo do pagamento ou título do item

- Max. 128 chars -

order_amount*

string

valor do pedido - 0.01 ~ 999999999 -

(consulte o limite de valor para diferentes métodos)

order_currency*

string

moeda do pedido - Max. 3 chars -

content*

string

detalhes do motivo do pagamento ou detalhes do item. Isso será mostrado na fatura do banco.

- Max. 255 chars -

buyer_id*

string

ID do usuário do merchant

channel

string

use somente quando método = Wallet

trade_type*

string

fixed value: WEB

return_url

sring

url de redirecionamento da web quando o pagamento for concluído

timeout_express

string

m(minutes), h(hours), d(days), c(always end in current day).

Used to control the expiration time of submitting an order (from initial to processing). (90m in default, max 15d)

version*

string

fixed value: 2.0

cancellation_express

string

m(minutos), h(horas), d(dias). O valor deve ser um número inteiro.

Usado para cancelar um pedido. Ex: 90m Utilizado para controlar o tempo de expiração de uma ordem de processamento.

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900083",
    "out_trade_no": "202201010354003",
    "web_url": "http://checkout-testv2.pagsmile.com?prepay_id=123456",
    "prepay_id":"123456"
}

Exemplo

curl --location --request POST 'https://gateway-test.pagsmile.com/trade/create' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "charset": "UTF-8",
    "app_id": "162************38",
    "out_trade_no": "202201010354002",
    "order_currency": "BRL",
    "order_amount": "12.01",
    "subject": "item name",
    "content": "20 item description",
    "trade_type": "WEB",
    "timeout_express": "15d",
    "timestamp": "2022-01-01 03:54:01",
    "notify_url": "http://merchant/callback/success",
    "buyer_id": "buyer_0101_0001",
    "version": "2.0",
    "customer" : {
        "identification": {
            "type": "CPF",
            "number": "50284414001"
        },
        "name": "customer user name",
        "email": "test@gmail.com",
        "phone": "5511987654321",
    	"buyer_id": "buyer_0101_0001",
        "ip": "127.0.0.1"
    },
    "address":{
   	       "postal_code":"38082365",
               "country":"address test country",
               "state":"address state123",
               "city":"address city123",
               "street":"address streetqqq",
               "street_number":"4567",
               "neighborhood":"neighbor address222"
   			 },
    "billing": {
        "address": {
               "postal_code":"38082365",
               "country":"billingtest country001",
               "state":"billingstate123",
               "city":"billingcity123",
               "street":"billingstreetqqq",
               "street_number":"22222",
               "neighborhood":"billingneighborhood222"
        },
        "identification": {
            "type": "cpf",
            "number": "50284414727"
        },
        "email": "email@test.com",
        "name": "test",
        "phone": "5511987654321"
    },
    "shipping": {
        "address": {
               "postal_code":"38082365",
               "country":"Brazil",
               "state":"shipping state123",
               "city":"shipping city123",
               "street":"shipping streetqqq",
               "street_number":"4567",
               "neighborhood":"shipping hood222"
        },
        "identification": {
            "type": "cpf",
            "number": "50284414727"
        },
        "email": "email@test.com",
        "name": "test",
        "phone": "5511987654321"
    },
    "products": [
        {
            "quantity": "1",
            "name": "product 1",
            "url": "https://www.pagsmile.com/product/1",
            "description": "this is a product"
        },
        {
            "quantity": "1",
            "name": "product 2",
            "url": "https://www.pagsmile.com/product/2",
            "description": "this is a product"
        },
        {
            "quantity": "3",
            "name": "product 3",
            "url": "https://www.pagsmile.com/product/3",
            "description": "this is a product"
        },
        {
            "quantity": "4",
            "name": "product 4",
            "url": "https://www.pagsmile.com/product/4",
            "description": "this is a product"
        }
    ]
}'

O Returnurl não é necessário nos parâmetros de solicitação. Entretanto, se necessário, você pode sobrescrevê-lo anexando o return_url após o web_url ao redirecionar.

http://checkout.pagsmile.com?prepay_id={$prepay_id}

↓↓↓

http://checkout.pagsmile.com?prepay_id={$prepay_id}&return_url=encodeURIComponent({$return_url})

Importante: 162************38 é o App Id de teste da Pagsmile para o ambiente Sandbox, e eMTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== é o token de autorização associado ao aplicativo de teste id.

Use seu próprio app_id e gere seu próprio token de autorização ao testar.

PreviousCheckout Page (Geral)NextIntegração direta

Last updated