API Explorer
  1. ONLINE PAYMENTS
  2. Online Payments API
  3. Payment sessions

Authorize recurring payment

post
https://psp-staging.aerahost.com/uccnp/v1/payment/authorize-recurring

Charges a stored payment instrument without the shopper present (a merchant-initiated payment).

Send the recurringReference from the first payment in transactionData.recurringReference. Follow the agreement from the first payment: for SCHEDULED, at least recurringFrequency days after the previous payment, and never after recurringExpiry.

The response contains a new pspReference for this payment. If transactionData.immediateCapture is false, capture it with Capture payment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The request body for Authorize recurring payment.

transactionData
object
required

The amount, your reference, and the recurringReference of the agreement.

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

Your merchant ID from Aera.

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

Updated 11 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.payments.v1+json

Updated 11 days ago

Did this page help you?