Responses
Common Responses for the object.
Get
Get Response Parameters
Response Parameters
| Property | Description |
|---|---|
| amount | Amount |
| auddis | Auddis reference |
| card_id | For a “cardpayment” schedule - Card ID to be used for taking payments |
| collection_day | Can be either “1” - “28” or “last day” |
| collection_period | Can be set to either monthly or weekly |
| collection_stretch | Stretch of collection period |
| created_at | Datetime formatted as ISO8601 |
| custom_reference | Custom reference text |
| description | Reference description – will be included in outgoing email if enabled |
| end_date | 10 digit date in the format of “YYYY-MM-DD” |
| firstCollectionInSameMonthAsNextCollection | Will be “false”. This can be used in the PUT to override default behaviour. |
| first_collection_amount | Amount that will be taken for the first collection |
| first_collection_date | When the first collection will be attempted |
| id | Unique identifier |
| installments | For a “DDPaymentPlan” schedule - Total number of installments for the schedule. |
| mandate | Id of the parent Mandate |
| metadata | Returns optional, custom, metadata, if set |
| next_collection_date | Next collection date |
| payment_type | Type of payment for the Schedule. Can be either “cardpayment” or “directdebit” |
| start_date | 10 digit date in the format of “YYYY-MM-DD” |
| status | Returns “active” or “inactive” |
| type | Type of Schedule. Can be either “DDOngoingPayment” or “DDPaymentPlan” |
| upcoming_payments | JSON formatted collections |
Get Response Sample - Single
Response Sample
{
"recurrence_schedule": {
"amount": "2532",
"auddis": "FBMAN02814872",
"card_id": "",
"collection_day": "19",
"collection_period": "monthly",
"collection_stretch": "1",
"created_at": "2022-05-17T12:09:19Z",
"custom_reference": "",
"description": "",
"end_date": "",
"firstCollectionInSameMonthAsNextCollection": false,
"first_collection_amount": "2532",
"first_collection_date": "2022-05-19",
"id": "FTBRS00112373",
"installments": "",
"mandate": "M01741EJ519Y51P3XGL",
"next_collection_date": "2022-06-20",
"payment_type": "DirectDebit",
"start_date": "2022-05-19",
"status": "active",
"metadata":"",
"type": "DDOngoingPayment",
"upcoming_payments": "[{\"collection_date\":\"2022-06-20\",\"amount\":\"2532\"},{\"collection_date\":\"2022-07-19\",\"amount\":\"2532\"},{\"collection_date\":\"2022-08-19\",\"amount\":\"2532\"},{\"collection_date\":\"2022-09-19\",\"amount\":\"2532\"},{\"collection_date\":\"2022-10-19\",\"amount\":\"2532\"},{\"collection_date\":\"2022-11-21\",\"amount\":\"2532\"},{\"collection_date\":\"2022-12-19\",\"amount\":\"2532\"}]"
}
}
Get Response Sample - Multiple
Response Sample
{
"recurrence_schedules": [
{
"amount": "2000",
"auddis": "FBMAN02704807",
"card_id": "",
"collection_day": "02",
"collection_period": "Weekly",
"collection_stretch": "1",
"created_at": "2022-05-12T11:21:37Z",
"custom_reference": "API Postmant Test",
"description": "Payment Schedule",
"end_date": "",
"firstCollectionInSameMonthAsNextCollection": false,
"first_collection_amount": "1999",
"first_collection_date": "2022-05-18",
"id": "FTBRS00102372",
"installments": "",
"mandate": "M01NZWLJR15OWQJGQ91",
"next_collection_date": "2022-06-01",
"payment_type": "directDebit",
"start_date": "2022-05-17",
"status": "active",
"metadata":"",
"type": "DDOngoingPayment",
"upcoming_payments": "[{\"collection_date\":\"2022-06-01\",\"amount\":\"2000\"},{\"collection_date\":\"2022-06-08\",\"amount\":\"2000\"},{\"collection_date\":\"2022-06-15\",\"amount\":\"2000\"},{\"collection_date\":\"2022-06-22\",\"amount\":\"2000\"},{\"collection_date\":\"2022-06-29\",\"amount\":\"2000\"},{\"collection_date\":\"2022-07-06\",\"amount\":\"2000\"}]"
},
{
"amount": "2000",
"auddis": "FBMAN02704808",
"card_id": "",
"collection_day": "02",
"collection_period": "Weekly",
"collection_stretch": "1",
"created_at": "2022-05-12T11:21:38Z",
"custom_reference": "API Postmant Test",
"description": "Payment Schedule",
"end_date": "",
"firstCollectionInSameMonthAsNextCollection": false,
"first_collection_amount": "1999",
"first_collection_date": "2022-05-18",
"id": "FTBRS00102373",
"installments": "",
"mandate": "M016DZMJNE2QREJK325",
"next_collection_date": "2022-06-01",
"payment_type": "directDebit",
"start_date": "2022-05-17",
"status": "active",
"metadata":"",
"type": "DDOngoingPayment",
"upcoming_payments": "[{\"collection_date\":\"2022-06-01\",\"amount\":\"2000\"},{\"collection_date\":\"2022-06-08\",\"amount\":\"2000\"},{\"collection_date\":\"2022-06-15\",\"amount\":\"2000\"},{\"collection_date\":\"2022-06-22\",\"amount\":\"2000\"},{\"collection_date\":\"2022-06-29\",\"amount\":\"2000\"},{\"collection_date\":\"2022-07-06\",\"amount\":\"2000\"}]"
}
]
}