GetRecurringPayment
Endpoint
Overview
The "GetRecurringPayment" endpoint is a GET request. It is used to get all recurring payments created in your account.
The endpoint on Swagger is: Payment_GetRecurringPayment.
Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.
Request Header
Add "Authorization": "Bearer {Token}" to request header. Token of demo configuration can be found here.
Request Model
The request is a GET request without any parameters.
Response Model
After viewing the Response Model that you will get as a result of your request, here, you will find full details about the Data Model of this API endpoint. Let's check it and its contents.
Response Field | Type | Description |
---|---|---|
RecurringPayment | array of RecurringPaymentModel objects |
RecurringPaymentModel
Response Field | Type | Description |
---|---|---|
RecurringId | string | |
RecurringStatus | string | Active Uncompleted Completed Canceled Draft |
CreationDate | string | |
RecurringValue | number | |
RecurringType | string | Custom Daily Weekly Monthly |
IntervalDays | integer | |
ExecutedTimes | integer | |
LastPayDate | string | |
NextPayDate | string | |
IsActive | boolean | |
RecurringInvoices | array of RecurringInvoicesModel objects |
RecurringInvoicesModel
Response Field | Type | Description |
---|---|---|
InvoiceId | integer | |
CustomerReference | string | |
CustomerName | string | |
CustomerMobile | string | |
CreatedDate | string | |
InvoiceStatus | string |
Sample Messages
/v2/GetRecurringPayment
{
"IsSuccess": true,
"Message": "",
"ValidationErrors": null,
"Data": {
"RecurringPayment": [
{
"RecurringId": "RECUR2136",
"RecurringStatus": "Canceled",
"CreationDate": "2021-04-13T11:57:51.733",
"RecurringValue": 50,
"RecurringType": "Custom",
"IntervalDays": 1,
"ExecutedTimes": 0,
"LastPayDate": "2021-04-13T11:57:51.733",
"NextPayDate": "2021-04-14T00:00:00",
"IsActive": false,
"RecurringInvoices": null
},
{
"RecurringId": "RECUR2171",
"RecurringStatus": "Active",
"CreationDate": "2021-04-22T15:17:56.38",
"RecurringValue": 50,
"RecurringType": "Custom",
"IntervalDays": 180,
"ExecutedTimes": 0,
"LastPayDate": "2021-04-22T15:17:56.38",
"NextPayDate": "2021-10-19T00:00:00",
"IsActive": true,
"RecurringInvoices": null
},
{
"RecurringId": "RECUR2137",
"RecurringStatus": "Uncompleted",
"CreationDate": "2021-04-13T12:06:41.067",
"RecurringValue": 50,
"RecurringType": "Custom",
"IntervalDays": 1,
"ExecutedTimes": 2,
"LastPayDate": "2021-04-15T04:02:45.717",
"NextPayDate": "2021-04-16T00:00:00",
"IsActive": false,
"RecurringInvoices": [
{
"InvoiceId": 614309,
"CustomerReference": null,
"CustomerName": "fname lname",
"CustomerMobile": "+965",
"CreatedDate": "2021-04-14T04:03:31.277",
"InvoiceStatus": "Paid"
},
{
"InvoiceId": 615024,
"CustomerReference": null,
"CustomerName": "fname lname",
"CustomerMobile": "+965",
"CreatedDate": "2021-04-15T04:02:43.077",
"InvoiceStatus": "Paid"
}
]
},
...
]
}
}
Updated 9 months ago