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

Transfer Experience

The transfer process through Pix arrangement can provide two different experiences:

  • Payer;
  • Payee.

Payer


The following entities are part of the payer transfer experience:

  • User (Payer);
  • DOCK PartnerDOCK Partner - Any and every entity that has a contract to use directly the services offered by DOCK is considered a DOCK Partner.s;
  • DOCK Bank Partner (Pix Direct Partner);
  • DOCK;
  • Central Bank of Brazil (BACEN);
  • Payment Service Provider (PSP) of the Payee.

The flowchart below presents the payer transfer experience in detail.

🚧

Image Quality

If you have difficulty accessing the flowchart below, click here to access the image in a higher resolution.

Payer Transfer flowchart.

Flowchart Captions

Step

Description

1

The user starts a Payment and selects an option of transfer (DICT Key or QR Code)

2

If the DICT key is selected, the user inputs the data

3/4

The DOCK Partner calls the GET /dict/validate endpoint in DOCK, which validates the key

5

The DICT Key is validated

6

If the QR code is selected, the user scans the QR code

7/8/9

The DOCK Partner calls the POST /decode endpoint in DOCK which, decodes the QR Code

10/11/12

DOCK sends the response to the partner (Sub Issuer), that sends a message to the user with the availability of the QR code or DICT Key

13

The user confirms the information of payment

14/15

The DOCK Partner calls the POST /transfers endpoint and DOCK receives the request

16

DOCK validates the account and balance of the payer

17

If it is not valid, creates a message of failure to send to the Payer in step 34

18

If it is valid, the Pix Direct Partner sends the information of payment to BACEN

19/20

BACEN receives and validates the transaction (information of account and balance)

21

If it is not valid, creates a message of failure to send to the Payer in step 34

22

If it is valid, BACEN blocks the Instant Payment Account Value

23

A message is sent to the PSP of the payee with the information of payment

24/25

The PSP of the payee receives the message from BACEN and validates the transaction

26

If it is not valid, creates a message of failure to send to the Payer in step 28

27

If it is valid, creates a message of success payment

28

The PSP of the payee sends a message with the payment information to BACEN

29

BACEN receives the response from the PSP of the payee and if is rejected goes to step 21

30

If it is accepted, BACEN adjusts balance in the Instant Payment account a creates a message of success

31

BACEN sends a response to the Pix Direct Partner and the PSP of the Payee in steps 32 and 45

32

The Pix Direct partner receives the BACEN's message. If it is of failure, it goes to step 17

33

If it is a success, DOCK adjusts the balance of the payment account and creates a message of success payment

34

DOCK send a message to the DOCK Partner through webhook

35

The DOCK Partner receives the information via webhook (TRANSFERS_PAYER)

36/37

The DOCK Partner sends a response to the user, which has the result of payment

38

The user can view the payment information by search in the app

39/40

If the user searches for Pix transfer information, the DOCK Partner calls the GET /transfers/receipts endpoint

41/42

DOCK receives the request from the DOCK Partner and retrieves the transfer information

43/44

DOCK sends the transfer information to the DOCK Partner, which receives the response

45

The PSP of the payee receives the response from BACEN

46

The PSP of the payee adjust balance and creates a message of success to the payee

Payee


The following entities are part of the payee transfer experience:

  • User (Payee);
  • DOCK Partners;
  • DOCK;
  • DOCK Bank Partner (Pix Direct Partner);
  • BACEN;
  • PSP (Payer).

The flowchart below presents the payer transfer experience in detail.

🚧

Image Quality

If you have difficulty accessing the flowchart below, click here to access the image in a higher resolution.

Payee Transfer flowchart.

Flowchart Captions

Step

Description

1

The external user starts a Payment and selects an option of transfer (DICT Key or QR Code)

2

The PSP of the payer validates the transaction

3

If it is not valid, creates a message of failure to send to the Payer

4

If it is valid, the PSP of the Payer sends the information of payment to BACEN

5/6

BACEN receives and validates the transaction (information of account and balance)

7

If it is not valid, creates a message of failure to send to the Payer in step 18

8

If it is validated, block Instant Payment Account Value

9

Sends the message to the Pix Direct Partner of DOCK

10/11

Pix Direct Partner/DOCK receives the message from BACEN and validates the transaction

12

If it is not valid, creates a message of failure to send to the Payer in step 14

13

If it is valid, creates a message of success payment

14

Send the message to BACEN

15

Receives the message from the Pix Direct Partner, if the payment is rejected, goes to step 7

16

If it is accepted, adjusts balance in the Instant Payment account and creates a message of success

17

BACEN sends a response to the PSP receiver and the Pix Direct Partner in steps 18 and 31

18/19

The Pix Direct Partner receives the response from BACEN and adjusts balance of the payment account and creates a message of success payment

20

DOCK send a message to the DOCK Partner (Sub Issuer) through webhook

21

The DOCK Partner receives the information via webhook (TRANSFERS_PAYEE)

22/23

The DOCK Partner sends a response to the user, which has the result of the payment

24

The user can view the payment information by search in the app

25/26

If the user searches for Pix transfer information, the DOCK Partner calls the GET /transfers/receipts endpoint

27/28

DOCK receives the request from the DOCK Partner and retrieves the transfer information

29/30

DOCK sends the transfer information to the DOCK Partner, which receives the response

31

The PSP of the payer receives the response from BACEN

32

The PSP of the payer adjust balance and creates a message of success to the payee

Technical Documentation


To see the technical resources about this product, you can access our technical documentation by clicking on the link below:

Pix (FaaS)
Pix (BaaS)

Updated 3 months ago


Transfer Experience


Suggested Edits are limited on API Reference Pages

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