Creates a Pay-Out order

Create pay-out order with inputed information. pixKey is either the key associated to a bank account, or a BR Code, which is the content of a QR code. A BR Code can either have the amount specified or not. If it is specified, the amount field should be left in blank, otherwise, it must be specified as well. The taxId field is only necessary if paying a natural person (CPF). Fill name, ispb, branchCode, accountNumber and accountType if you don't want to use a pix key

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

Id of a subaccount

Body Params

Order information

string

Either PixKey or BRCode

string
integer
string

External id you can input to help later conciliation. Up to 40 alphanumeric characters.

string
string
string
string
enum
Allowed:
Responses

401

Authorization failure

429

Rate limited

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