lighthouse.dock.tech

Dock Lighthouse

Welcome to Dock Lighthouse! You'll find comprehensive guides and documentation to help you start working with our products as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

The world of payment slips is customized on Dock’s services by our Payment Slip API (cash-in API). It presents two different types of payment slip: Recharger and Invoice.

First of all, it is important to understand what are payment slips and how they work.

What is a payment slip?


Payment slip is a document strongly used in Brazil as a payment method, standardized by the Brazilian Federation of Banks (FEBRABAN). Through a payment slip, either virtual or printed, the issuer (payee or beneficiary) of the document receives the amount determined on it in their account.

See the payment slip example on the image below. The description of the fields is shown in the following sections.

Payment slip example (dummy data).

Mandatory Fields

To generate a payment slip it is mandatory to fill out the fields in the table below:

Number

Field Name

Description

1

Issuing Bank

Logo of the bank that generated the payment slip. It may also contain the logo of the payment slip's Receiving Institution.

2

Bank Prefix Number

Prefix number of the bank that generated the payment slip. It must include the verifying digit, separated by an hyphen (-).

3

Barcode Number

Number referring to the barcode, also known as "Linha Digitável". This number can be used to validate the payment slip.

4

Place of Payment

Places where the payment slip can be paid.

5

Payee (or beneficiary)

It is the party to whom the payment slip is generated. This entity will receive the payment

8

Payer

It is the party designated to pay the payment slip.

9

Guarantor Drawer or Co Beneficiary

Also known as "Beneficiário Final", it is the party designated to intermediate the payment slip. Normally, the guarantor drawer and the payee are the same, but there are some cases where the guarantor drawer is a third-party.

10

Barcode

Bar code used to validate the payment slip. It must follow a pattern according to FEBRABAN's documentation.

11

Due Date

Expiration date of the payment slip. Based on this date, the payment slip is liable to discounts, fines, and interests.

14

Document Amount

Amount for which the payment slip was generated.

Optional Fields

The fields below, although not necessary to generate a payment slip, can be used to improve users' payment experience.

Number

Field

Description

6

Document Date

Date when the document that generated the payment slip was issued.

7

Instructions

Instructions about how to handle the payment slip.

12

Bank Branch/Beneficiary Code

Prefix number of the bank branch that generated the payment slip and payee or product account number.

13

"Our Number"/Document Code

Identification code of the billing that generated the payment slip followed by the number of the document used by Dock when signed the contract with the partner bank.

15

Discounts

Discounts referring to the payment slip amount.

16

Other Deductions

Other deductions referring to the payment slip amount.

17

Fines and Interests

Fines and interests that the payment slip is liable to.

18

Other Increases

Other increases that the payment slip is liable to.

19

Charged Amount

Total amount of the payment sli (document amount - discounts - other deductions + fares + interests + other increases).

20

Wallet

Billing modality used to generate the payment slip. This field will always come as 500 on Payment Slip API.

21

Currency

Abbreviation of the currency used to generate the payment slip.

22

Document Type

Type of document used to generate the payment slip, which can be:\

  • DM (trade bill or "duplicata mercantil");
  • DS (service bill or "duplicata de serviços");\
  • NP (promissory note or "nota promissória).

23

Acceptance

Indicates if the payer has signed a document taking responsability of paying the payment slip. It allows the payee to contest the payment slip on the court.

24

Processing Date

It is the date when the payment slip was generated.

Updated 4 months ago


Overview


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.