API Reference
  1. WEBHOOKS

Payout Notification

post
https://yoururl.com/webhooks/payout
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int64
Defaults to 123456789

Unique ID for the payout

float
Defaults to 100

Amount of the payout transaction

string
Defaults to PIX

Payment method of the payout

metadata
object

Payout metadata example

string
Defaults to 2023-12-04T10:15:30.000Z

Payout creation timestamp

string
Defaults to 2023-12-04T12:00:00.000Z

Processment timestamp

string
enum
Defaults to PAID

Payout status

Allowed:
decline
object

Decline reason, not available for success statuses.

Headers
string
Defaults to Basic Zl9wdrX2RlZl91JrX2Rc3I6b3w==
Responses

Updated about 2 years ago

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

Updated about 2 years ago