Boleto

Chame a API do Boleto para solicitar pagamentos via boleto bancário.

POST /v2/payin

Chamada

curl -v --location --request POST 'https://api-uat.jumppag.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813dda",
            "name": "John Doe",
            "email": "[email protected]",
            "document": {
                "type": "CPF",
                "number": "12345678909"
            },
            "phone": "+5511912345678",
            "address": {
                "address_1": "Rua da avenida",
                "address_2": "Quadra 01",
                "number": "100",
                "neighborhood": "Londrina",
                "city": "Florianópolis",
                "state": "SC",
                "postal_code": "12332-343",
                "country_code": "BRA"
            }
        },
        "country": "BRA",
        "payment_method": "boleto",
        "notification_url": "https://webhook.site/asdfasdf",
        "transaction": {
            "id": "b7178a51-3c86-4c08-80ac-49f2b93c58bc",
            "currency": "BRL",
            "amount": 2
        },
        "boleto": {
            "campo_livre": "CampoLivre",
            "data_vencimento": "2025-03-22",
            "tipo_juros_dia": "perc", 
            "taxa_juros_dia": "2", 
            "tipo_multa": "perc",
            "taxa_multa": "0.333",
            "desconto_1_tipo": "perc",
            "desconto_1_dias": "2",
            "desconto_1_taxa": "10",
            "mensagens": {
                "msg_1": "",            
                "msg_2": "",
                "msg_3": "",
                "msg_4": "",
                "msg_5": ""
            }
        }
    }'

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.phone

string (E.164)

Obrigatório: não

O número de telefone do cliente, incluindo o código do país. Este parâmetro pode ser opcional ou obrigatório dependendo do método de pagamento usado. https://www.twilio.com/docs/glossary/what-e164

customer.birthdate

string

Obrigatório: não

A data de nascimento do cliente, fornecida no formato mm-dd-yyyy. Este parâmetro pode ser necessário dependendo dos regulamentos do país ou do método de pagamento

customer.document.number

string Format: 99999999999 / 9999999999999

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 (CPF or CNPJ)

Obrigatório: sim

O tipo de documento fornecido pelo cliente. Os tipos comuns incluem ID nacional ou carteira de motorista. Lista de documentos permitidos . Padrão: CPF

customer.address.addres_1

string

Obrigatório: sim

O endereço principal do cliente

customer.address.addres_2

string

Obrigatório: não

Informações adicionais de endereço, como número do apartamento ou suíte

customer.address.city

string

Obrigatório: sim

A cidade em que o cliente reside

customer.address.country_code

string

Obrigatório: sim

O código de país ISO 3166-1 alfa-3 para o endereço do cliente.

customer.address.neightborhood

string

Obrigatório: sim

O bairro ou distrito do endereço do cliente

customer.address.number

string

Obrigatório: sim

O número da rua do endereço

customer.address.postal_code

string

Obrigatório: sim

O código postal ou CEP do endereço do cliente

customer.address.state

string

Obrigatório: sim

O estado ou região do endereço do cliente

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 (BRL or USD)

Obrigatório: sim

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

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

transaction.expire

integer (11)

Obrigatório: não

O tempo em segundos até que a transação expire e não seja mais válida

branch

string min: 1 | max: 255

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

string

Obrigatório: sim

O método de pagamento utilizado para a transação, como pix, boleto...

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

boleto.campo_livre

string

Obrigatório: Não

Campo de preenchimento livre

boleto.data_vencimento

string

Obrigatório: sim

Exemplo: 2020-02-15 Máximo até 10 dias corridos

boleto.tipo_juros_dia

string

Obrigatório: Não

Esse campo deve ser informado com o tipo "perc" ou "vlr". Isso mostra que a taxa_multa deve ser percentual ou valor fixo

boleto.taxa_juros_dia

string

Obrigatório: Não

Esse campo deve ser informado em percentual caso tipo seja "perc" e valor caso o tipo seja "vlr"

boleto.tipo_multa

string

Obrigatório: Não

Esse campo deve ser informado com o tipo "perc" ou "vlr". Isso mostra que a taxa_multa deve ser percentual ou valor fixo

boleto.taxa_multa

string

Obrigatório: Não

Esse campo deve ser informado com o valor da multa em percentual caso tipo seja "perc" e valor caso o tipo seja "vlr"

boleto.desconto_1_tipo

string

Obrigatório: Não

Esse campo deve ser informado com o tipo "perc" ou "vlr". Isso mostra que a desconto_1_taxa deve ser percentual caso tipo seja "perc" ou desconto_1_taxa deve ser decimal caso tipo seja "vlr"

boleto.desconto_1_taxa

string

Obrigatório: Não

Esse campo deve ser informado com o valor do desconto

boleto.desconto_1_dias

string

Obrigatório: Não

Esse campo deve ser informado com o numero de dias antes da data de vencimento para se aplicar o desconto. Ex.: vencimento dia 25/01/2025 informei em boleto.desconto_1_dias 5. Assim o desconto será aplicado ate o pagamento ser feito no dia 20/01/2025

boleto.desconto_2_tipo

string

Obrigatório: Não

Esse campo deve ser informado com o tipo "perc" ou "vlr". Isso mostra que a desconto_2_taxa deve ser percentual caso tipo seja "perc" ou desconto_2_taxa deve ser decimal caso tipo seja "vlr"

boleto.desconto_2_taxa

string

Obrigatório: Não

Esse campo deve ser informado com o valor do desconto

boleto.desconto_2_dias

string

Obrigatório: Não

Esse campo deve ser informado com o numero de dias antes da data de vencimento para se aplicar o desconto. Ex.: vencimento dia 25/01/2025 informei em boleto.desconto_2_dias 5. Assim o desconto será aplicado ate o pagamento ser feito no dia 20/01/2025

boleto.desconto_3_tipo

string

Obrigatório: Não

Esse campo deve ser informado com o tipo "perc" ou "vlr". Isso mostra que a desconto_3_taxa deve ser percentual caso tipo seja "perc" ou desconto_3_taxa deve ser decimal caso tipo seja "vlr"

boleto.desconto_3_taxa

string

Obrigatório: Não

Esse campo deve ser informado com o valor do desconto

boleto.desconto_3_dias

string

Obrigatório: Não

Esse campo deve ser informado com o numero de dias antes da data de vencimento para se aplicar o desconto. Ex.: vencimento dia 25/01/2025 informei em boleto.desconto_3_dias 5. Assim o desconto será aplicado ate o pagamento ser feito no dia 20/01/2025

boleto.mensagens.msg_1

string

Obrigatório: Não

boleto.mensagens.msg_2

string

Obrigatório: Não

boleto.mensagens.msg_3

string

Obrigatório: Não

boleto.mensagens.msg_4

string

Obrigatório: Não

boleto.mensagens.msg_5

string

Obrigatório: Não

Resposta

{
	"requestId": "67437fd917d0d7ebc5b361aa6cba01c6\/17091068426296675474",
	"data": {
		"id": "24d075a2-2b97-44a4-b9d8-5f25bbbc5c95",
		"status": "pending",
		"expires_in": 1727213203,
		"payment": {
			"method": "boleto",
			"url": "https://uat-api.jumppag.com/boleto/c307e2b5-87987fsdfgsgf",
			"bar_code": "34191.09164 767678 8768 6876 7867 897689689679768"
		},
		"values": {
			"source_total": "2.00000000",
			"source_currency": "BRL",
			"exchanged_total": "2.00",
			"exchanged_currency": "BRL",
			"exchange": "1.00",
			"fee": "0.02000000"
		}
	}
}

Detalhes da resposta

Link: visão geral

Cancelar Boleto e transação na Jump

POST /v2/bankslip/cancel

Chamada

curl -v --location --request POST 'https://api-uat.jumppag.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "transaction_uid": "b48a0728-9ff4-47ee-8f1b-92d2d5813dda"
    }'

Detalhes do parâmetro

transaction_uid

string

Resposta

{
    "requestId": "cb3154c0-4a10-4620-b647-0f6c5e59c245",
    "moreInformation": [
        {
            "transaction_uid": "7fe250c3-41be-419e-9bda-378f79c190ff",
            "message": "Boleto cancelado com sucesso!",
            "code": "SUCCESS",
            "detail": [
                {
                    "idrequisicaoparceiro": "7fe250c341be419e9bda378f79c190ff-831",
                    "idrequisicaoarbi": "20250513758183@1542061354659",
                    "idmodulo": 2,
                    "idtransacao": 10,
                    "idstatus": 201,
                    "descricaostatus": "Sucesso",
                    "resultado": "Baixa executada"
                }
            ]
        }
    ]
}

AnteriorPIX PróximoBolePix (Boleto + Pix)

Atualizado há 4 meses

Isto foi útil?

hashtagPOST /v2/payin

hashtagChamada

hashtagDetalhes dos parâmetros

hashtagcustomer.id

hashtagcustomer.name

hashtagcustomer.email

hashtagcustomer.phone

hashtagcustomer.birthdate

hashtagcustomer.document.number

hashtagcustomer.document.type

hashtagcustomer.address.addres_1

hashtagcustomer.address.addres_2

hashtagcustomer.address.city

hashtagcustomer.address.country_code

hashtagcustomer.address.neightborhood

hashtagcustomer.address.number

hashtagcustomer.address.postal_code

hashtagcustomer.address.state

hashtagtransaction.id

hashtagtransaction.currency

hashtagtransaction.amount

hashtagtransaction.expire

hashtagbranch

hashtagcountry

hashtagpayment_method

hashtagnotification_url

hashtagboleto.campo_livre

hashtagboleto.data_vencimento

hashtagboleto.mensagens.msg_2

hashtagboleto.mensagens.msg_3

hashtagboleto.mensagens.msg_4

hashtagboleto.mensagens.msg_5

hashtagResposta

hashtagDetalhes da resposta

hashtagCancelar Boleto e transação na Jump

hashtagPOST /v2/bankslip/cancel

hashtagChamada

hashtagDetalhes do parâmetro

hashtagtransaction_uid

hashtagResposta

POST /v2/payin

Chamada

Detalhes dos parâmetros

customer.id

customer.name

customer.email

customer.phone

customer.birthdate

customer.document.number

customer.document.type

customer.address.addres_1

customer.address.addres_2

customer.address.city

customer.address.country_code

customer.address.neightborhood

customer.address.number

customer.address.postal_code

customer.address.state

transaction.id

transaction.currency

transaction.amount

transaction.expire

branch

country

payment_method

notification_url

boleto.campo_livre

boleto.data_vencimento

boleto.mensagens.msg_2

boleto.mensagens.msg_3

boleto.mensagens.msg_4

boleto.mensagens.msg_5

Resposta

Detalhes da resposta

Cancelar Boleto e transação na Jump

POST /v2/bankslip/cancel

Chamada

Detalhes do parâmetro

transaction_uid

Resposta