Need help with your first order?
Authorizations
Headers
The dated version of the API, if not specified a default is used. See API versioning for more information.
A unique string that prevents order duplication. See Idempotency for more information.
Whether to process the order synchronously or asynchronously. If this header is omitted we default to async. See which mode to use to help you decide which execution mode is right for your use case. Sync orders are limited to a single order item.
async
, sync
Body
The details of the order to create.
Payment method for the order. Select the ACCOUNT_BALANCE
you want to pay for the order from
Pay using your account balance.
The list of items to be included in the order. Each item ordered results in a single payout link. The maximum number of items per order is 200.
1 - 200
elementsFree format text reference for the order. Not visible to the end user. Will be visible to you in the Runa web portal.
128
"Your own reference text"
Response
Response that will be returned in sync execution mode. Order has successfully been completed.
Used for an order that has completed. This class is typically used when returning a single order to the client. Used for orders that have completed. This class is typically used when returning a list of orders to the client.
Status of the order. The status of the order.
COMPLETED
"PROCESSING"
The ID of the order.
"O-01H5WQGHKCBB85MQFM68S9KJ5Q"
UTC timestamp, in ISO 8601 format, when the order was submitted.
The payment method used for the order. Account balance payment.
The currency of the order, represented by ISO 4217 currency codes. Please check the currency section in the guidelines for how to use this field.
"USD"
The total price of the order. This includes any applicable fees.
"10"
The total discount of the order.
"1"
The list of items that were included in the order. Each item represents a single payout link.
UTC timestamp, in ISO 8601 format, when the order was completed.
Free format text reference for the order. Not visible to the end user. Will be visible to you in the Runa web portal.
128
"Your own reference text"
A mapping of the subtotal of the order using the payout currency as a key.
{ "USD": { "value": "10.00", "fx": null } }