Create direct payment session

post

https://psp-staging.aerahost.com/uccnp/v1/session/payment/create-direct

Starts a payment with a payment method the shopper already chose in your checkout, without showing Aera's checkout page. Use it for a stored card, Vipps MobilePay or Apple Pay.

Send the payment method in paymentMethodInfo.paymentMethodDetails. For a stored card, send the card's paymentInstrumentReference from Get payment instruments in paymentInstrumentsProfileData.

If the shopper must authenticate, the response contains a paymentSessionUrl. Redirect the shopper to it. If not, the response has no paymentSessionUrl, and you can check the result with Get payment status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The request body for Create direct payment session.

merchantData

object

required

Where to send the shopper after checkout, where to send notifications, and how to show the checkout.

transactionData

object

required

The amount, your reference, and how the payment is captured and stored.

paymentInstrumentsProfileData

object

Identifies the shopper, so Aera can show, pre-select or store their payment instruments.

paymentMethodInfo

object

required

The payment method and payment instrument to use.

Headers

merchant-id

string

required

^[a-zA-Z0-9\-]{1,13}$

Your merchant ID from Aera.

idempotency-key

uuid

required

A unique ID for this request, in UUID v7 format. Use a new key for every new request. If a request fails because of a timeout or network error, send it again with the same key. Aera then doesn't process it twice. It will remember this key for 30 days in the test system and two days in the production system. When a key is found the expected response will be returned.

Responses

200Request processed. If the response has a paymentSessionUrl, redirect the shopper to it.

400Bad request. A required field is missing or a value is invalid. responseInfo.message says which.

401Unauthorized. The API key or access token is missing, invalid or expired.

403Forbidden. Your credentials don't give access to this merchant or this operation.

409Conflict. The operation isn't allowed in the payment's current state, or the idempotency-key was already used for a different request.

429Too many requests. Wait and try again.

500Internal server error. Try again later. If it keeps failing, contact Aera support with responseInfo.cid.