Create recurring payment session

post

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

Creates a payment session for the first payment of a recurring agreement, and stores the shopper's payment instrument for later payments.

Describe the agreement in recurringInfo:

SCHEDULED: payments at a fixed interval, such as a subscription. The amount can vary.
UNSCHEDULED: payments at varying times and amounts.

The shopper completes the first payment on Aera's hosted checkout, as with Create payment session. If you don't charge anything now, set amountDetails.amount to 0.

When the shopper has paid, get the recurringReference from Get payment status or Get payment instruments. Use it to charge the later payments with Authorize recurring payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The request body for Create recurring 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

Limits or configures the payment methods in this session. Leave out to offer all payment methods enabled for your merchant account.

recurringInfo

object

required

The terms of the recurring agreement the shopper accepts with the first payment.

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

200Session created. Redirect the shopper to paymentSessionUrl.

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.