BolePix (Boleto + Pix)
Chame a API do Bolepix para solicitar pagamentos via boleto bancário com pix integrado.
Importante:
Essa opção não calcula juros e multa de atraso para o PIX.
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": "bolepix",
"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",
"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
boleto.tipo_juros_dia
string
Obrigatório: Não
Esse campo deve ser informado com o tipo "perc" ou "valor".
boleto.taxa_juros_dia
string
Obrigatório: Não
Esse campo deve ser informado com opercentual de juros ao dia
boleto.tipo_multa
string
Obrigatório: Não
Esse campo deve ser informado com o tipo "perc". Isso mostra que a taxa_multa deve ser percentual
boleto.taxa_multa
string
Obrigatório: Não
Esse campo deve ser informado com o valor da multa em percentual
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",
"qr_code_pix": "00020109991226860014BR.GOV.BCB.PIX2564qrcode-h.bancoarbi.com.br/gi/v2/eb14eb99994942789a6620176a010a955204000053039865802BR5912YYYYo XXXXX6009Joinville62070503***6304BF8F"
},
"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 Bolepix 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"
}
]
}
]
}
Atualizado
Isto foi útil?