API Reference

Create Order

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

Web method describing the order creation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
Defaults to b95e8d4c-8920-4cdd-805e-d4b9c21b619a

Unique marchant order ID

string
Defaults to Merchant purchase

Soft descriptor of the merchant

double
Defaults to 10

Total amount of the order

string
enum

Currency in ISO 4217 format, except for USDT

Allowed:
metadata
object

Metadata object that saves any key-value pair

boolean
Defaults to false

Defines if payment by the other customer is allowd (Ex: Client with a different CPF).

charges
array of objects

Charges of the order

charges
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 12 months ago

What’s Next

Web-method that should be called when a payout is required.

    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

    Web-method that should be called when a payout is required.