Transfers
Create Recurring
Create a recurring transfer
POST
/
transfer
/
recurring
Authorizations
x-api-key
string
headerrequiredx-api-secret
string
headerrequiredBody
application/json
startDate
string
requiredThe date when the recurring transaction starts.
circle
enum<string>
requiredThe frequency of the recurring transaction.
Available options:
daily, weekly, monthly destination
enum<string>
requiredThe destination type for the transfer.
Available options:
bank_account, wallet bankCode
string
requiredThe code of the bank for the transaction.
amount
integer
requiredThe amount to be paid out in each recurrence.
accountOrPhoneNumber
string
requiredThe account number or phone number of the recipient.
isTotal
boolean
requiredIndicates if the recurring payment is a total payment.
Response
200 - application/json
status
boolean
Indicates whether the recurring request was successful.
statusCode
integer
The status code of the response.
data
object
message
string
A message providing additional information about the recurring response.