Recurring Payments

Setup recurring payment

This endpoint allows you to configure recurring payment execution
POST/api/2/eurowallet/payments/recurring

Request

beneficiaryId
integer required
Beneficiary identifier (the ID can be found in the client portal, in the Beneficiaries page)
recurrenceType
string required
The frequency (interval) with which the payment must be made
Possible values: WEEKLY, MONTHLY, QUARTERLY
day
integer required
The specific day of the selected interval when the payment should be made
For WEEKLY, the date should be within 1-7 range (each number corresponds to each day of the week)
For MONTHLY, the date should be within 1-31 range (each number corresponds to each day of the month)
For QUARTERLY, the date should be within 1-92 range (each number corresponds to each day of the calendar quarter)
time
string required
The specific time when the payment should be made

Format: HH:mm:ss, 24-hour, UTC time zone
enabled
boolean required
If true, the recurrence will be enabled. If false, the recurrence will be disabled.

Response

200 OK

This response body is emty

Error codes

CodeMessage
30000Depends on request (e.g. when validation fails if invalid beneficiary ID provided)
30010When some field is invalid

Examples

POST url: /api/2/eurowallet/payments/recurring
POST data: beneficiaryId=1&recurrenceType=MONTHLY&day=15&time=18%3A00&enabled=true

Commentaries

Beneficiaries

By definition, recurrence can only be set up for a pre-defined payment (payment templates).

Therefore, you first need to go to the customer portal, to the Beneficiaries page, and create a new entry there.

Get exchange rate

This endpoint allows you to get an exchange rate for an outgoing payment through the SWIFT network

Cancel recurring payment

This endpoint allows you to cancel a payment recurrence