Tela de Checkout

Use a API do Checkout para gerar uma página de pagamento segura

Os parâmetros fornecidos aqui são obrigatórios para criar o link de pagamento, garantindo que métodos de pagamento relevantes como Boleto, PIX e mais sejam apresentados automaticamente aos compradores. Além dos parâmetros obrigatórios, oferecemos campos opcionais que podem ser incluídos para aprimorar a experiência do usuário. Esses campos permitem que informações pré-preenchidas, como endereço, documentos e outros dados pessoais, sejam transferidos automaticamente, evitando que os usuários tenham que digitá-los novamente quando chegarem à nossa página de pagamento.

POST /v2/transaction/checkout

Chamada

curl -v --location --request POST 'https://api-uat.jumppag.com/v2/transaction/checkout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Joao Silva",
            "email": "[email protected]",
            "document": {
                "number": "12345678909",
                "type": "CPF"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "BRL",
            "amount": 100.00,
        },
        "branch": "YourCompanyOrBranchName",
        "country": "BRA",
        "notification_url": "https://mysite.com/api/notification",
        "redirect_url": "https://mysite.com/success"
    }'

Detalhes dos parâmetros

customer.id

string

Obrigatório: sim

Identificador exclusivo para o cliente em seu sistema. Este valor deve permanecer consistente em todas as transações para o mesmo cliente

customer.name

string

Obrigatório: sim

O nome completo do cliente que está fazendo o pagamento. Deve corresponder ao nome nos documentos de identificação do cliente

customer.email

string

Obrigatório: sim

O endereço de e-mail do cliente. Este será usado para enviar confirmações de pagamento e notificações

customer.document.number

string

Obrigatório: sim

O número de identificação oficial do cliente. Normalmente é uma identidade nacional ou outro documento emitido pelo governo

customer.document.type

string

Obrigatório: sim

O tipo de documento fornecido pelo cliente. Tipos comuns incluem ID nacional ou carteira de motorista. Lista de documentos permitidos .

transaction.id

string

Obrigatório: sim

Um identificador exclusivo para a transação. Este ID deve ser gerado pelo seu sistema para rastrear o processo de pagamento específico

transaction.currency

string

Obrigatório: sim

A moeda na qual a transação está sendo conduzida. Use códigos de moeda padrão ISO 4217 (por exemplo, USD, PEN).

transaction.amount

decimal (10,2)

Obrigatório: sim

O valor total da transação na moeda especificada. Este valor deve ser um valor numérico (use ponto em vez de vírgula) Eg: 300.10

branch

string

Obrigatório: não

O identificador específico da agência ou local onde a transação está sendo processada, se aplicável

country

string

Obrigatório: sim

O código do país onde a transação está ocorrendo. O formato é ISO 3166-1 alpha-3 (por exemplo, BRA para o Brasil).

payment_method

array

Obrigatório: sim

O método de pagamento utilizado para a transação, como transferência bancária, cartão de crédito...

notification_url

string

Obrigatório: sim

A URL para a qual as notificações de pagamento serão enviadas. Certifique-se de que esta URL esteja acessível e configurada para lidar com o formato de notificação

redirecionamento_url

string

Obrigatório: não

A URL para a qual o cliente será redirecionado após concluir o pagamento. Este parâmetro é opcional e normalmente usado para fornecer uma página de sucesso ou falha

Resposta

Sucesso

{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "url": "https://checkout-uat.jumppag.com/v1/cbfc1b2e-b1d7-42c0-8dc5-ffe94d64938e/cGADUcGFK9DJJvbGV0dyxwaXgsYmFua190cmAODHcg==/eyJkf3j982b2N1bWVuJAH8FHXIiOiIxMjM0NTY3ODkka90F8HJR5cGUiOiJDUEYifSwadhugcmEiOltdfQ=="
        "transaction_id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "expires_in": 1722108649
    }
}

Erro

{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}