Criar pedido com Pagar com PagBank (Deeplink)

Através desse endpoint é possível criar um pedido com Deeplink, que pode ser pago com o super app Pagbank.

📘

Acesse o guia do serviço Pagar com PagBank para mais informações sobre seu funcionamento e funcionalidades disponíveis.

Ao informar um valor no objeto deep_links, o deeplink será gerado automaticamente. Ele pode ser pago com o super app PagBank (saldo ou cartão de crédito).

O Deeplink gerado aceita apenas um pagamento aprovado, ou seja, após uma tentativa de pagamento concluída com sucesso usando o app Pagbank, o mesmo não aceitará outros pagamentos. No momento, só é possível gerar um Deeplink por pedido.

📘

Duração do Deeplink

O Deeplink estará disponível até o final do dia seguinte à data de criação.

🚧

Use somente em ambiente Mobile

O pagamento só pode ser realizado através do super App do PagBank, disponibilize este link somente em ambientes Mobile, onde o Pagador possa utilizar o App.

👍

Permitir com que o Pagador volte para o site/app do e-commerce

Caso o integrador queira redirecionar o Pagador de volta para o site/app do seu e-commerce após confirmação do pagamento, é só informar o campo "redirect_url" dentro do bloco deeplinks.

Tipos de links válidos:
Universal Link = "https://www.teste.com.br"
URL Scheme = "app://teste.app"

curl --location --request POST 'https://sandbox.api.pagseguro.com/orders' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reference_id": "ex-00001",
    "customer": {
        "name": "Jose da Silva",
        "email": "[email protected]",
        "tax_id": "12345678909",
        "phones": [
            {
                "country": "55",
                "area": "11",
                "number": "999999999",
                "type": "MOBILE"
            }
        ]
    },
    "items": [
        {
            "name": "nome do item",
            "quantity": 1,
            "unit_amount": 500
        }
    ],
    "deep_links": [
        {
            "amount": {
                "value": 500
            },
            "redirect_url": "https://www.teste.com.br"
        }
    ],
    "shipping": {
        "address": {
            "street": "Avenida Brigadeiro Faria Lima",
            "number": "1384",
            "complement": "apto 12",
            "locality": "Pinheiros",
            "city": "São Paulo",
            "region_code": "SP",
            "country": "BRA",
            "postal_code": "01452002"
        }
    },
    "notification_urls": [
        "https://meusite.com/notificacoes"
    ]
}'
{
    "id": "ORDE_EE377FA2-020C-4D9C-B87D-CE73942AF59E",
    "reference_id": "ex-00001",
    "created_at": "2021-10-07T21:31:25.01175845-03:00",
    "customer": {
        "name": "Jose da Silva",
        "email": "[email protected]",
        "tax_id": "12345678909",
        "phones": [
            {
                "type": "MOBILE",
                "country": "55",
                "area": "11",
                "number": "999999999"
            }
        ]
    },
    "items": [
        {
            "name": "nome do item",
            "quantity": 1,
            "unit_amount": 500
        }
    ],
    "shipping": {
        "address": {
            "street": "Avenida Brigadeiro Faria Lima",
            "number": "1384",
            "complement": "apto 12",
            "locality": "Pinheiros",
            "city": "São Paulo",
            "region_code": "SP",
            "country": "BRA",
            "postal_code": "01452002"
        }
    },
    "deep_links": [
        {
            "url": "https://pagseguro.uol.com.br/para-seu-negocio/aplicativos/minha-conta/download?f=order&r=f4e747ac-20c4-400c-a2b5-98624a4feae6",
            "amount": {
                "value": 500
            }
           "redirect_url": "https://www.teste.com.br"
        }
    ],
    "notification_urls": [
        "https://meusite.com/notificacoes"
    ],
    "links": [
        {
            "rel": "SELF",
            "href": "https://api.pagseguro.com/orders/ORDE_EE377FA2-020C-4D9C-B87D-CE73942AF59E",
            "media": "application/json",
            "type": "GET"
        },
        {
            "rel": "PAY",
            "href": "https://api.pagseguro.com/orders/ORDE_EE377FA2-020C-4D9C-B87D-CE73942AF59E/pay",
            "media": "application/json",
            "type": "POST"
        }
    ]
}

📘

Simule pagamentos utilizando Deeplink

Acesse a página Simular pagamento Pagar com PagBank (Deeplink ) para aprender como realizar realizar a simulação do pagamento do pedido criado utilizando o sistema de Deeplink do Pagar com PagBank

Status de eventos transacionais

A tabela a seguir apresenta os possíveis status para transações realizadas com Cartão de Crédito e Saldo PagBank.

Status TransacionalDescrição
PAIDIndica que a cobrança está paga (capturada).
IN_ANALYSISIndica que o PagBank está analisando o risco da transação.
DECLINEDIndica que a cobrança foi negada pelo PagBank ou Emissor.
CANCELEDIndica que a cobrança foi cancelada.

Tabela de erro

A tabela a seguir apresenta os possíveis códigos de erros na criação do pedido.

CódigoDescriçãoCenário
40002Criação do pedido com redirect_url inválida. A URL precisa atender ao seguinte padrão: ^([a-zA-Z0-9]+://)(.*)$Não pode informar link inválido
Ex: ftp:/teste.com