Criar pedido com Pagar com PagBank (QR Code)

Através desse endpoint é possível criar um pedido com QR Code, gerado através da API Order que pode ser pago com o Pagar com 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 qr_codes, e informar o PAGBANK no objeto "arrangements", o QR code será gerado automaticamente e pode ser pago com Pagar com PagBank através do app PagBank (utilizando o saldo e o cartão de crédito á vista)

Por padrão o QR code gerado tem validade de 24 horas.

É premissa informar o "PAGBANK" no array "arrangements, para que o QR Code aceite o pagamento com a Carteira Digital.

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": "Thais Lisboa",
        "email": "[email protected]",
        "tax_id": "12345678909",
        "phones": [
            {
                "country": "55",
                "area": "11",
                "number": "965667655",
                "type": "MOBILE"
            }
        ]
    },
    "items": [
        {
            "name": "Referencia do Item 1",
            "quantity": 1,
            "unit_amount": 100
        }
    ],
    "qr_codes": [
        {
            "amount": {
                "value": 130
            },
            "arrangements": ["PAGBANK"]
        }
    ],
    "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://webhook.site/cf0e295e-1cf9-4daf-ada9-ea6e52a5e332"
    ]
}

"reference_id": "ex-00001",
    "created_at": "2022-08-25T13:47:58.081781084-03:00",
    "customer": {
        "name": "Thais Lisboa",
        "email": "[email protected]",
        "tax_id": "12345678909",
        "phones": [
            {
                "type": "MOBILE",
                "country": "55",
                "area": "11",
                "number": "965667655"
            }
        ]
    },
    "items": [
        {
            "name": "Referencia do Item 1",
            "quantity": 1,
            "unit_amount": 100
        }
    ],
    "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"
        }
    },
    "qr_codes": [
        {
            "id": "QRCO_6E58A0E0-B77B-4E32-8A77-2DF3361FFE5F",
            "expiration_date": "2022-08-26T23:59:59-03:00",
            "amount": {
                "value": 130
            },
            "text": "00020101021226580014BR.COM.PAGBANK01366E58A0E0-B77B-4E32-8A77-2DF3361FFE5F52048999530398654041.305802BR5919Thais Lisboa Nonato6009Sao Paulo6304B7DB",
            "arrangements": ["PAGBANK"],
            "links": [
                {
                    "rel": "QRCODE.PNG",
                    "href": "https://api.pagseguro.com/qrcode/QRCO_6E58A0E0-B77B-4E32-8A77-2DF3361FFE5F/png",
                    "media": "image/png",
                    "type": "GET"
                },
                {
                    "rel": "QRCODE.BASE64",
                    "href": "https://api.pagseguro.com/qrcode/QRCO_6E58A0E0-B77B-4E32-8A77-2DF3361FFE5F/base64",
                    "media": "text/plain",
                    "type": "GET"
                }
            ]
        }
    ],
    "notification_urls": [
        "https://webhook.site/cf0e295e-1cf9-4daf-ada9-ea6e52a5e332"
    ],
    "links": [
        {
            "rel": "SELF",
            "href": "https://api.pagseguro.com/orders/ORDE_9E3B018C-AF30-4756-A663-8F14931FDD5D",
            "media": "application/json",
            "type": "GET"
        },
        {
            "rel": "PAY",
            "href": "https://api.pagseguro.com/orders/ORDE_9E3B018C-AF30-4756-A663-8F14931FDD5D/pay",
            "media": "application/json",
            "type": "POST"
        }
    ]
}

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 Transacional	Descrição
PAID	Indica que a cobrança está paga (capturada).
IN_ANALYSIS	Indica que o PagBank está analisando o risco da transação.
DECLINED	Indica que a cobrança foi negada pelo PagBank ou Emissor.
CANCELED	Indica que a cobrança foi cancelada.

Tabela de erro

A tabela a seguir apresenta os possíveis códigos de erros na geração do QR Code com "arrangements"

Código	Descrição	Cenário
40002	must have at least 1 element	A lista de QR Code não pode estar vazia.
40002	allowed value is [PAGBANK]	O campo "Arragements" não pode ter valor diferente de PAGBANK.
40002	must have 1 element	O campo "Arragements" não pode estar vazio.
40001	must not be null	O campo "Arrangments" não pode conter valor nulo (null).

Atenção: Para Simular o Pagamento, será necessário baixar o aplicativo PagBank na loja Play Store/Apple Store em Produção.