API Reference

Create recurring payment

put
https://api.valmarpayments.com/transactions/recurring

Creates a new recurring payment schedule. Transactions are automatically submitted on the configured frequency until cancelled or the total occurrences are reached.

Query Params
uuid

Entity UUID to act as Required when authenticating with a Bearer token; may be omitted with Basic (API key) authentication, where the entity is resolved from the API key.

Body Params

Recurring payment schedule

Recurring payment schedule

integer
required
≥ 0
string
enum

How to handle weekends/holidays

Allowed:
string
string
integer
-1 to 31

For MONTHLY (legacy): 1-31 (or -1 for last day)

integer
0 to 6

Day selection configuration

string
string
string
string
enum
required

Recurring payment specific fields

Allowed:
string
string
enum
required
Allowed:
monthlyConfig
object

For MONTHLY (new): flexible day or week/day configuration

string
required
paymentDetails
object
required

Information regarding the payment method. Required fields vary by method.

semiMonthlyConfig
object

For SEMI_MONTHLY: flexible scheduling config

string
enum
string
required
integer
required
≥ 1
string
enum
required
Allowed:
Responses

Updated 1 day 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/json

Updated 1 day ago

Did this page help you?