Create

POST

/api/customer-vault/38/recurring-payment

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "name": "Monthly subscription",
    "description": "Cinema Membership",
    "amount": 3,
    "execute": {
        "frequency": 1,
        "period": "month"
    },
    "valid": {
        "from": "2020-01-01",
        "to": "2020-12-31"
    },
    "payment": {
        "max": 12
    },
    "terminal": {
        "id": 1
    },
    "customer": {
        "id": 38,
        "card": {
            "id": 1
        }
    },
    "dba": {
        "id": 72
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/customer-vault/38/recurring-payment' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Monthly subscription",
    "description": "Cinema Membership",
    "amount": 3,
    "execute": {
        "frequency": 1,
        "period": "month"
    },
    "valid": {
        "from": "2020-01-01",
        "to": "2020-12-31"
    },
    "payment": {
        "max": 12
    },
    "terminal": {
        "id": 1
    },
    "customer": {
        "id": 38,
        "card": {
            "id": 1
        }
    },
    "dba": {
        "id": 72
    }
}'

Responses

🟢200Create

application/json

Body

Example

{
    "id": "1",
    "name": "Monthly subscription",
    "description": "Cinema Membership",
    "amount": "3.00",
    "execute": {
        "frequency": 1,
        "period": "month"
    },
    "valid": {
        "from": "2020-01-01",
        "to": "2020-12-31"
    },
    "payment": {
        "next": "2020-02-01 00:00:00",
        "last": null,
        "max": 12,
        "attempt": {
            "date": null,
            "retries": null
        }
    },
    "terminal": {
        "id": 1
    },
    "customer": {
        "id": 38,
        "card": {
            "id": 1,
            "number": 4489,
            "token": "H3ViuS1XiX9w4489",
            "exp": "2020-12-31",
            "order": 50,
            "status": "Expired"
        }
    },
    "status": null,
    "archived": null
}

Modified at 2025-08-09 05:39:41

Update

List