POST /orders

Creates an order to be used for partial payments. Make a POST /orders call before making a /payments call when processing payments with different payment methods.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Idempotency-Key String No

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body fields

Name Type Required Description
expiresAt String No

The date when the order should expire. If not provided, the default expiry duration is 1 day.

ISO 8601 format: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30+01:00.

amount Object Yes

The total amount of the order.

amount.value Integer Yes

The amount of the transaction, in minor units.

amount.currency String Yes

The three-character ISO currency code.

merchantAccount String Yes

The merchant account identifier, with which you want to process the order.

reference String Yes

A custom reference identifying the order.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.