Creates a payment request

Creates a payment request, which will be processed asynchronously. In the body of the request is the drawee document_number which is used to reference the retailer that will be charged. Also its informed the due_date, which is used to limit the max date of the last usable receivable. This request will be sent to the receivables registry system, and once the necessary value is reserved from the available receivables, the payment is set to PROCESSED. If the retailer does not have the necessary amount available among its receivables, the payment will be changed to REFUSED. After all receivables, affected by the payment request, are setlled, then the payment is changed to SETTLED. All status changes will trigger a webhook notification.

Path Params
uuid
required

Unique vendor identifier.

Body Params

Create Payment Request Data

uuid
required

Unique payment identifier. With this reference, it will be possible to search for its payment data

integer
required

Payment amount in cents

date
required

Start of date range for the use of receivables

date
required

End of date range for the use of receivables

drawee
object
required
uuid

Unique bank account identifier. Bank account needs to be registered. If this field is empty, the system will infer a default vendor bank account.

metadata
object

Key, Value properties. Can you chose which data you wanna storage associated a invoice.

uuid
required

Unique merchant identifier. Select the merchant receive receivable

Responses
204

There's no content for that Collection.

401

Necessary Authentication token or you pass a invalid Token.

403

Necessary permission scope.

404

Resource not found.

406

Not acceptable for the Server.

500

Internal server error.

503

Service Unavailable.

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json