v1

latestOpenAPI 3.1.02026-07-2022194782.1 KB

Orders

Create an order

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.

post/orders

Headers

Idempotency-Keystring

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

Request body

expiresAtstring

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.

merchantAccountstring required

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

referencestring required

A custom reference identifying the order.

Response

OK - the request has succeeded.

additionalDataobject

Contains additional information about the payment. Some data fields are included only if you select them first: Go to Customer Area > Developers > Additional data.

expiresAtstring required

The date that the order will expire.

orderDatastring required

The encrypted data that will be used by merchant for adding payments to the order.

pspReferencestring

Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.

referencestring

The reference provided by merchant for creating the order.

refusalReasonstring

If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes resultCode and refusalReason values.

For more information, see Refusal reasons.

resultCode'Success' required

The result of the order creation request. The value is always Success.