Boletos Bancários

Criar Boleto

POST /bank-billets
Importante registrar o boleto através de algum dos campos abaixo para futura identificação:
  • our_number - Nosso Número
  • barcode - Código de Barras
  • identification_field - Linha Digitável
Campo Obrigatório Tipo Tamanho Descrição
amount Sim Number   Valor do boleto
due_date Sim Date   Data de vencimento
customer_document_number Não String 0-25 Número do boleto controlado pelo cliente
description Não String 0-150 Descrição do produto ou serviço
discount_type Não String   Tipo de desconto (possíveis valores)
discount_limit_date Não Date   Data limite para o desconto (Obrigatória se discount_type é diferente de none e auto)
discount_value Não Number   Valor do desconto (Obrigatório se discount_type é igual a value)
discount_percentage Não Number   Percentual do desconto (Obrigatório se discount_type é igual a percentage)
virtual_account Não String 0-12 Número da Conta Virtual (Se nulo, utiliza a conta virtual padrão configurada no padmoney)
interest_monthly_percentage Não Number   Juros de mora (Se nulo, utiliza os valores configurados na conta padmoney)
fine_for_delay Não Number   Multa por atraso (Se nulo, utiliza os valores configurados na conta padmoney)
payer Sim Group   `customer` é uma alias para `payer`
> person_type Sim String   Tipo da pessoa (possíveis valores)
> name Sim String 1 - 100  
> cnpj_cpf Sim String    
> email Não String 5 - 100  
> phone_number Não String 11 - 16  
> zipcode Sim String 8  
> address Sim String 1 - 100  
> neighborhood Sim String 1 - 50  
> address_number Sim String 1 - 60  
> address_complement Não String 0 - 100  
> city_name Sim String 2 - 100  
> state Sim String 2 Unidades Federativas do Brasil
url_notification Não URL 0 - 256 Define uma URL de Notificação específica para o Boleto
code_notification Não String 0 - 36 Define um Código de Notificação específica para o Boleto
partner_id Não String 0 - 100 ID do Parceiro (Encontrado no painel do Padmoney em Programa de Afiliados)

Tipos disponíveis de Desconto

  • none Inexistente (Valor padrão)
  • auto Desconto de acordo com configuração predefinida
  • value Valor fixo até a data informada
  • percentage Percentual até a data informada

Tipos de Pessoa

  • individual Pessoa Física
  • juridical Pessoa Jurídica

Exemplo da requisição 

{
  "amount": 1.99,
  "due_date": "2017-01-01",
  "document_number": "42",
  "description": "",
  "discount_type": "auto",
  "discount_limit_date": null,
  "discount_value": null,
  "discount_percentage": null,
  "payer": {
    "person_type": "individual",
    "name": "Mony",
    "cnpj_cpf": "25411417260",
    "email": "[email protected]",
    "phone_number": "",
    "zipcode": "29090630",
    "address": "Rua Alan Turing",
    "neighborhood": "Bairro das Laranjeiras",
    "address_number": "42",
    "address_complement": "2o andar",
    "city_name": "Vitória",
    "state": "ES"
  }
}
[{
  "id": "02805593-3315-9b78-75d0-b7ff9d700596",
  "request_id": "bd34bc2a-bbb1-908f-458c-6a7945fe377c",
  "document_number": "42",
  "due_date": "2017-01-01",
  "our_number": "000000003083-1",
  "barcode": "03391775600000012999987654300000000308800101",
  "identification_field": "03399987675430000000403088001015177560000001299",
  "status": "opened",
  "url": "https://print.padmoney.com/bank-billets/2bm1984"
}]
{}

Cancelar Boleto

PUT /bank-billets/{id}/cancel

Você pode cancelar apenas boletos com status Emitido opened ou Vencido overdue.

Poderá ser informado como ID do Boleto:

  • ID do Boleto
  • Nosso Número
  • Linha Digitável
{
  "id": "f9607ac2-45ff-4fc3-99de-33fcb277477a",
  "request_id": "6BC42661-E9B6-49E1-A429-A5D9ABB65746",
  "our_number": "000000000042-X",
  "status": "canceling"
}
{}
No body returned for response

Listar Boletos

GET /bank-billets?page=1&per_page=50

Parâmetros

Parâmetro Obrigatório Tipo Descrição
page Não Number Número da Página
per_page Não Number Quantidade de Registros por página (Máximo de 250) 
[
  {
    "id": "abed7ef2-7188-de46-8f9a-596038713644",
    "payer": {
      "name": "Mony",
      "document": "14770932065",
      "email": "[email protected]",
      "zipcode": "29092270",
      "address": "Avenida Engenheiro Charles Bitran ",
      "neighborhood": "Jd Camburi",
      "address_number": "42",
      "address_complement": "",
      "city_name": "Vitória",
      "state": "ES"
	},
    "document_number": "70",
    "our_number": "0000012345-6",
    "document_date": "2017-01-01",
    "due_date": "2017-02-01",
    "processed_at": "2017-01-01",
    "amount": "1.99",
    "status": "opened",
    "barcode": "",
    "identification_field": ""
  },
  {...},
  {...},
  {...},
  {...}
]
{}
No body returned for response

Consultar Boleto

GET /bank-billets/{id}

Poderá ser informado como ID do Boleto:

  • ID do Boleto
  • Nosso Número
  • Código de Barras
  • Linha Digitável
{
  "id": "66f6dfd9-bdcb-4508-9fec-20be8b28df50",
  "request_id": "6BC42661-E9B6-49E1-A429-A5D9ABB65746",
  "document_number": "74",
  "our_number": "000000000074-4",
  "document_date": "2017-11-27",
  "due_date": "2017-01-01",
  "processed_at": "2017-01-01",
  "amount": "1.99",
  "canceled_at": null,
  "paid_at": null,
  "paid_amount": null,
  "barcode": "03399702600000001999897033500000000007440101",
  "identification_field": "03399897093350000000600074401019970260000000199",
  "status": "opened",
  "payer": {
    "person_type": "individual",
    "name": "Mony",
    "cnpj_cpf": "25411417260",
    "email": "[email protected]",
    "phone_number": "",
    "zipcode": "29090630",
    "address": "Rua Alan Turing",
    "neighborhood": "Bairro das Laranjeiras",
    "address_number": "42",
    "address_complement": "2o andar",
    "city_name": "Vitória",
    "state": "ES"
  }
}
{}
No body returned for response

Consultar Boleto por Status

GET /bank-billets/status?q=opened&date=2017-01-01

Parâmetros

Parâmetro Obrigatório Tipo Descrição
q Sim String Status do Boleto (possíveis valores)
date Não Date Data de movimentação do Boleto
page Não Number Número da Página
per_page Não Number Quantidade de Registros por página (Máximo de 250)

Valores disponíveis como Status

  • canceled Cancelado
  • canceling Cancelando
  • pending Em liquidação
  • opened Emitido
  • generating Gerando
  • paid Liquidado
  • rejected Rejeitado
  • overdue Vencido 
[
  {
    "id": "daaddb8d-eec1-034e-242e-9bc548bb3e84",
    "request_id": "6BC42661-E9B6-49E1-A429-A5D9ABB65746",
    "document_number": "74",
    "our_number": "000000000074-4",
    "document_date": "2017-11-27",
    "due_date": "2017-01-01",
    "processed_at": "2017-01-01",
    "amount": "1.99",
    "paid_at": null,
    "paid_amount": null,
    "barcode": "03399702600000001999897033500000000007440101",
    "identification_field": "03399897093350000000600074401019970260000000199",
    "status": "opened",
    "payer": {
      "person_type": "individual",
      "name": "Mony",
      "cnpj_cpf": "25411417260",
      "email": "[email protected]",
      "phone_number": "",
      "zipcode": "29090630",
      "address": "Rua Alan Turing",
      "neighborhood": "Bairro das Laranjeiras",
      "address_number": "42",
      "address_complement": "2o andar",
      "city_name": "Vitória",
      "state": "ES"
    }
  },
  {...},
  {...}
]
{}
No body returned for response