Create a collection intent

You can use this endpoint to create a collection intent

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Attributes to create a collection intent

In this scheme, you obtain information about the collection intent, such as the amount of the intent, the date on which the collection intent was made, the note, reference and data about the payer, such as the document number, document type and name of the person who paid. You can also find out the status of the collection intent.

string
required

Indicates the format for resource's ID

amount
object
required

Money schema

string
required

Bank code used by PSE to make the collection

string
required

The user IP address

string | null

Note indicated by the user of the client

payer
object
required
payment
object
required
boolean | null

Sets the preference for whether the collection intent should use realtime transfers. Will only be true if the system allows it.

string
required

The URL to redirect when the collection intent successfully completes through the provider.

string | null

Reference indicated by the client or by the user of the client

Headers
uuid

Idempotency key in UUID v4 format

Responses

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