Skip to main content
POST
/
authentications
/
recurring
Initial recurring
curl --request POST \
  --url https://sandbox.hellgate.io/authentications/recurring \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": 1000,
  "currency_code": "EUR",
  "recurring_expiry": "20231231",
  "recurring_frequency": 28,
  "source": {
    "type": "token",
    "token_id": "71820e49-6822-4df1-8db5-d245456172b6"
  }
}
'
{
  "id": "7dcb4365-a948-4b41-a2d2-a7bffa2d3994",
  "amount": 1000,
  "currency_code": "EUR",
  "action_requirement": {
    "type": "use_sdk",
    "session_id": "d5b8e449-13da-4594-bf00-643146fb35d1"
  },
  "created_at": "2023-10-10T00:00:00Z",
  "purchase_date": "20241010000000",
  "recurring_expiry": "20231231",
  "recurring_frequency": 28,
  "use_case": "INITIAL_RECURRING",
  "source": {
    "type": "token",
    "token_id": "71820e49-6822-4df1-8db5-d245456172b6"
  },
  "status": "PROCESSING"
}
Beta Feature

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
amount
integer
required

The amount given in minor units (e.g. use 700 for 7€). Some currencies do not support minor units (e.g. Japanese Yen). In this case send in the full value, .i.e. 100 for 100 JPY.

Required range: x >= 0
​
currency_code
string
required

The three letter currency code. See: ISO-4217

​
recurring_expiry
string<yyyyMMdd>
required

The date when the recurring should expiry.

​
recurring_frequency
integer
required

Indicates the minimum number of days between authorisations.

​
source
object
required

The payment credentials for this authentication request.

TypeDescription
tokenAn already existing Commerce token can be used as source for the authentication.
​
challenge_preference
enum<string>
default:CHALLENGE

The preference with respect to an eventual challenge.

There is no guarantee that the preference can be fulfilled.

Available options:
CHALLENGE,
NO_PREFERENCE,
NO_CHALLENGE
​
purchase_date
string

The data when the purchase was made. Requires the format yyyyMMddHHmmss and defaults to now.

​
merchant_id
string<uuid>

The ID of the merchant for whom the authentication is requested

​
cardholder_information
object

Response

Authentication created

​
id
string<uuid>
required

The ID of the authentication

​
amount
integer
required

The amount given in minor units (e.g. use 700 for 7€). Some currencies do not support minor units (e.g. Japanese Yen). In this case send in the full value, .i.e. 100 for 100 JPY.

Required range: x >= 0
​
created_at
string<datetime>
required

The date-time the authentication was created (following ISO 8601)

​
currency_code
string
required

The three letter currency code. See: ISO-4217

​
status
enum<string>
required
Available options:
PROCESSING,
COMPLETED,
FAILED
​
source
object
required

The payment credentials for this authentication request.

TypeDescription
tokenAn already existing Commerce token can be used as source for the authentication.
​
use_case
enum<string>
required
Available options:
ONE_OFF,
INITIAL_RECURRING,
INITIAL_INSTALLMENT,
SUBSEQUENT_RECURRING,
SUBSEQUENT_INSTALLMENT
​
action_requirement
object
​
authentication_result
object

The final result of the authentication. It holds in the cardholder authentication data (CAVV) and if there is a network token present, the token authentication data (TAVV).

​
challenge_preference
enum<string>
default:CHALLENGE

The preference with respect to an eventual challenge.

There is no guarantee that the preference can be fulfilled.

Available options:
CHALLENGE,
NO_PREFERENCE,
NO_CHALLENGE
​
recurring_expiry
string

The date when the latest subsequent authentication can happen. Requires the format yyyyMMdd.

​
recurring_frequency
integer

Indicates the minimum number of days between authentications.

​
failure_details
object[]

The reasons why an authentication failed during processing in Commerce.

​
finished_at
string<datetime>

The date-time the authentication was finished (following ISO 8601)

​
original_authentication
string<uuid>

The ID of the original authentication in case of subsequent authentications

​
merchant_id
string<uuid>

The ID of the merchant for whom the authentication is requested

​
number_of_installments
integer

Indicates the maximum number of authorisations permitted for installment payments.

​
purchase_date
string

The data when the purchase was made. Requires the format yyyyMMddHHmmss and defaults to now.