From 806e599377949cbd797e540ce548e0229f8e0097 Mon Sep 17 00:00:00 2001 From: Robin Jeremiah Date: Wed, 3 Mar 2021 18:57:53 +0300 Subject: [PATCH] Update CR API edited the document --- source/includes/collecting_funds/_collection_requests.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/collecting_funds/_collection_requests.md b/source/includes/collecting_funds/_collection_requests.md index 28fd941298f..161811155f4 100644 --- a/source/includes/collecting_funds/_collection_requests.md +++ b/source/includes/collecting_funds/_collection_requests.md @@ -84,7 +84,7 @@ error_message | string | This will contain an error description in case an error expiry_date | string or null | Defaults to "24 hours". Specifies the date and time when this collection request will be marked as expired. Examples of valid values for this field include strings such as "tomorrow", "24 hours", "2 minutes", or %d/%m/%Y format e.g 24/05/2019 or %d/%m/%Y %H:%M:%S format e.g 24/05/2019 13:24:12 start_date | string or null | Use this to schedule collection requests for a future date.Examples of valid values for this field include strings such as “tomorrow”, or %d/%m/%Y format e.g 09/06/2019 or %d/%m/%Y %H:%M:%S format e.g 09/06/2019 13:24:12.Please note that the start_date should be greater than the time of creating the request. max_attempts | interger or null | Controls the number of retry attempts. It defaults to 3, and cannot be more than 3. Setting it to 0 disables retries. -retry_interval_minutes | integer or null | Used to retry a collection request after certain interval in minutes if a collection request isn’t yet handled or failed or expired.**Note:**: The retry is upto a maximum of five times and value for retry_interval_minutes cannot be less than 30. One would assume that omitting retry_interval_minutes disables retries, but this isn't true. retry_interval_minutes defaults to 10, and cannot be less than 10. To disable retries, set max_attempts = 0 +retry_interval_minutes | integer or null | Used to retry a collection request after certain interval in minutes if a collection request isn’t yet handled or failed or expired.**Note:**: The retry is upto a maximum of five times and value for retry_interval_minutes cannot be less than 30. One would assume that omitting retry_interval_minutes disables retries, but this isn't true. It defaults to 10, and cannot be less than 10. To disable retries, set max_attempts = 0 subscription_settings | JSON String or null | The subscriptions_settings option allows you to create recurring collection requests.A good example is when you want to bill someone monthly via mobile money. ## Creating a new Collection Request