API Reference

Create payout

post
https://sandbox.orkestrapay.io/payouts

Web method describing the payout operation.

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

Total amount of the payout

string

Unique marchant order ID

string
enum
required

Currency in ISO 4217 format

Allowed:
string
enum
required

Payment method type.

Allowed:
pix
object

Payout PIX data

beneficiary
object
required

Beneficiary of the payout data

receivingBankAccount
object

Receiver's bank account data

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 12 months ago

What’s Next

How to call web-method in the case of any failure.

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

    Updated 12 months ago

    What’s Next

    How to call web-method in the case of any failure.