v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB

Frequent Payment

Request Authorisation

Create a new authorisation on a given Frequent Payment

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">frequent:create</code>

post/frequent/authorisation/{id}

Path parameters

idstring uuid required

Resource Identification

Request body

transaction_keystring

Your internal key identifying this authorisation.

force_3dsboolean

Whether or not you want to force the 3DS authentication.

descriptivestring required

This will appear in the bank statement/MB WAY application.

valuenumber double required

Value will be rounded to 2 decimals.

Example request

{
  "mbway_sdk": {
    "initial_timestamp": "2018-01-01 23:59:59",
    "merchant_operation_id": "TESTACCOUNT5436"
  },
  "transaction_key": "transaction_key_123",
  "descriptive": "Descriptive Example",
  "value": 10.5
}

Response

Created

idstring uuid

Unique identifier for the authorization

statusstring

Status of the request

messagestring[]

Array of status messages

Example response

{
  "id": "4c67e74b-a256-4e0a-965d-97bf5d01bd50",
  "status": "ok",
  "message": [
    "Your request was successfully created"
  ]
}