{"type":"doc","content":[{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"paragraph","content":[{"text":"Repeat payment schedules are those where the user supplies the required setup information (including a card for payment), and the payments are executed automatically on a recurring basis. ","type":"text"}]},{"type":"paragraph","content":[{"text":"There are two types of repeat payment schedules. ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Fixed Scheduled Repeat Payment - ","type":"text","marks":[{"type":"strong"}]},{"text":"In this scenario, each payment is taken at a regular frequency for a fixed amount. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Variable Scheduled Repeat Payment - ","type":"text","marks":[{"type":"strong"}]},{"text":"In this scenario, each payment’s date and amount set is completely different. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Both schedules can be created using the ","type":"text"},{"text":"ECOM ","type":"text","marks":[{"type":"strong"}]},{"text":"or ","type":"text"},{"text":"MOTO ","type":"text","marks":[{"type":"strong"}]},{"text":"method ","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"There are two methods to create a repeat payment schedule.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ECOM - ","type":"text","marks":[{"type":"strong"}]},{"text":"This means that the card details are being entered on a secure payment page by the","type":"text"},{"text":" Customer ","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"These are designed for you to accept payments via a website, such as a shopping cart payment. ","type":"text"},{"type":"hardBreak"},{"text":"This ECOM method will use advance fraud detection of 3-D Secure.","type":"text"}]},{"type":"paragraph","content":[{"text":"3-D Secure will return a ","type":"text"},{"text":"acsform","type":"text","marks":[{"type":"code"}]},{"text":", which is a HTML form used to perform the 3-D Secure authentication.","type":"text"}]},{"type":"paragraph","content":[{"text":"A HTML page should be send to the user which include the ","type":"text"},{"text":"acsform","type":"text","marks":[{"type":"code"}]},{"text":" in the body and the following JS in the header:","type":"text"}]},{"type":"codeBlock","content":[{"text":"","type":"text"}]},{"type":"paragraph","content":[{"text":"The user will complete the 3-D Secure form and submit.","type":"text"}]},{"type":"paragraph","content":[{"text":"After submission, the user will be redirected to the predefined return URL with an encoded repeat schedule ID.","type":"text"}]},{"type":"paragraph"},{"type":"orderedList","attrs":{"order":2},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MOTO - ","type":"text","marks":[{"type":"strong"}]},{"text":"This means that the card details are being entered on a secure payment page by the","type":"text"},{"text":" Merchant","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"These are designed for you to build your own virtual terminal system to enter remote order details. This MOTO method doesnt use a 3-D Secure authentication as the cardholder is not able to perform the challenge.","type":"text"}]},{"type":"paragraph","content":[{"text":"Once the payment is processed the user will get json response with all the repeat schedule related data.","type":"text"}]},{"type":"paragraph"},{"type":"rule"},{"type":"paragraph","content":[{"text":"Each request is authenticated using HTTP Basic Auth by adding a bearer token to the header, e.g. ","type":"text"},{"text":"Authentication: Bearer {{access_token}}","type":"text","marks":[{"type":"code"}]},{"text":". You can get the ","type":"text"},{"text":"{{access_token}}","type":"text","marks":[{"type":"code"}]},{"text":" from the ","type":"text"},{"text":"create token request","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/BW/pages/173375567/Token#create-token"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Before creating a repeat payment schedule, a ","type":"text"},{"text":"Payment_intent","type":"text","marks":[{"type":"code"}]},{"text":" needs to be generated from the ","type":"text"},{"text":"create intent","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375502"}}]},{"text":" request.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"ccElement","type":"text","marks":[{"type":"code"}]},{"text":" is passed as part of the response, which can be implemented to generate the payment form and paymentToken ( tokenised card value) from there.","type":"text"}]},{"type":"paragraph","content":[{"text":"In a PHP implementation, the payment page may look like this:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n ...\n \n \n \n ...\n\n\n\n \n","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"Resources","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375502/Intents#create-intent"}}]},{"text":" /pay/v1/repeat-payments","type":"text","marks":[{"type":"link","attrs":{"href":"#moto-repeat-payments"}}]},{"text":" for MOTO","type":"text"},{"type":"hardBreak"},{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375502/Intents#create-intent"}}]},{"text":" /pay/v1/repeat-payments","type":"text","marks":[{"type":"link","attrs":{"href":"#ecom-repeat-payments"}}]},{"text":" for ECOM","type":"text"},{"type":"hardBreak"},{"text":"GET","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375502/Intents#get-intent"}}]},{"text":" /pay/v1/repeat-payments","type":"text","marks":[{"type":"link","attrs":{"href":"#get-all-repeat-payments"}}]},{"type":"hardBreak"},{"text":"GET","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375502/Intents#get-intent"}}]},{"text":" /pay/v1/repeat-payments/{id}","type":"text","marks":[{"type":"link","attrs":{"href":"#get-repeat-payment"}}]},{"type":"hardBreak"},{"text":"DELETE /pay/v1/repeat-payments/{id}","type":"text","marks":[{"type":"link","attrs":{"href":"#delete/cancel-a-payment"}}]},{"type":"hardBreak"},{"text":"DELETE /pay/v1/repeat-payments/cancel/{id}","type":"text","marks":[{"type":"link","attrs":{"href":"#refund-payment"}}]},{"type":"hardBreak"},{"text":"POST /pay/v1/repeat-payments/retry/{id}","type":"text","marks":[{"type":"link","attrs":{"href":"#retry-payment"}}]}]},{"type":"paragraph"}]}]},{"type":"rule"},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"moto-repeat-payments"},"legacyAnchorId":{"value":"RepeatPayment-moto-repeat-payments"}},"macroMetadata":{"macroId":{"value":"28713e6ea7e64dea24f2e4adeb5d3c85"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"b165e868-9a0b-4cbc-9ab4-2af98b86cb02"}},{"type":"hardBreak"},{"text":"Create Repeat Payment using MOTO","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"Create a repeat payment schedule.","type":"text"},{"type":"hardBreak"},{"text":"A schedule can either be on a Variable or Fixed basis","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}}]},{"text":" /pay/v1/repeat-payments","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Headers","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Content-Type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Content type.","type":"text"}]},{"type":"paragraph","content":[{"text":"Authorization","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Access token generated from ","type":"text"},{"text":"create token","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]},{"text":" request.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Attributes - (Required for all schedules)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"payment_type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Repeat payment type. It must be either of the following values.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fixed_schedule","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"variable_schedule","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"payment_intent","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Payment intent generated from ","type":"text"},{"text":"create intent","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375502"}}]},{"text":" request.","type":"text"}]},{"type":"paragraph","content":[{"text":"paymentToken","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Tokenised card value. In ","type":"text"},{"text":"create intent","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375502"}}]},{"text":" response, ","type":"text"},{"text":"ccElement","type":"text","marks":[{"type":"code"}]},{"text":" will be returned in element array if repeat payment is enabled for that merchant account. User can populate ","type":"text"},{"text":"ccElement","type":"text","marks":[{"type":"code"}]},{"text":" as a part of the create repeat request form to generate and pass paymentToken value. Please go through the process from ","type":"text"},{"text":"payment page","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/179568673"}}]},{"text":", to generate paymentToken. ","type":"text"}]},{"type":"paragraph","content":[{"text":"customer_name","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Customer name.","type":"text"}]},{"type":"paragraph","content":[{"text":"customer_email","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Customer email.","type":"text"}]},{"type":"paragraph","content":[{"text":"reference","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Reference value. Unique textual details of the schedule","type":"text"}]},{"type":"paragraph","content":[{"text":"customer_address","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Customer address.","type":"text"}]},{"type":"paragraph","content":[{"text":"customer_postcode","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Customer postcode.","type":"text"}]},{"type":"paragraph","content":[{"text":"currency","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Currency that the payments will be processed in","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Specific fields for a Fixed schedule - (These cannot be used in conjunction with the below Variable schedule specific fields)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"frequency","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Payment cycle frequency. It is required when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":"Possible values are ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"days","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"weeks","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"months","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"frequency_duration","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"integer","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Payment frequency duration. It is required when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"(E.g. “2” and “days” will be every 2 days)","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"start_payment_date","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"date","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Date on which the first payment will be captured. ","type":"text"},{"type":"hardBreak"},{"text":"It is required when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"Default value set to today. ","type":"text"}]},{"type":"paragraph","content":[{"text":"first_amount","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"decimal (optional)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"First payment amount. ","type":"text"},{"type":"hardBreak"},{"text":"When creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":", the first amount value can be customised.","type":"text"}]},{"type":"paragraph","content":[{"text":"recurring_amount","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"decimal","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Recurring amount for each instalment. It is required when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"is_limited_installments","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text"},{"text":"boolean ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"When creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":", it is required to mention if the schedule will have unlimited or limited instalments. ","type":"text"},{"type":"hardBreak"},{"text":"Possible values are ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"installments","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"integer","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Number of installments. ","type":"text"},{"type":"hardBreak"},{"text":"It is required when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":" if the","type":"text"},{"text":" is_limited_installments","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0747a6"}}]},{"text":" field is ","type":"text"},{"text":"true","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0747a6"}}]},{"text":" (i.e. it has limited instalments)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b3df4e6c-04c4-46ff-800a-07b7bf126600"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"is_limited_installments","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0747a6"}}]},{"text":" is ","type":"text"},{"text":"true","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0747a6"}}]},{"text":", then these 2 fields can also be added","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"final_amount","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"decimal (optional)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Final payment amount. ","type":"text"},{"type":"hardBreak"},{"text":"This can be used when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":" if there are ","type":"text"},{"text":"limited instalments","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":"If there are unlimited instalments, this field should not be used. ","type":"text"}]},{"type":"paragraph","content":[{"text":"final_payment_date","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"date (optional)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Date on which the final payment will be captured. ","type":"text"},{"type":"hardBreak"},{"text":"Final date can be customised along with the final amount when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":"This can only be used if there are ","type":"text"},{"text":"limited instalments","type":"text","marks":[{"type":"strong"}]},{"text":". If there are unlimited instalments, this field should not be used. ","type":"text"},{"type":"hardBreak"},{"text":"This date must be after the start payment date and also after the 2nd last recurring date.","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Specific fields for a Variable schedule - (This cannot be used in conjunction with any of the above Fixed schedule specific fields)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"schedule_set","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"array ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Schedule set is a array set of date and amount where the date will be the key and the amount will be its value. ","type":"text"},{"type":"hardBreak"},{"text":"It is required for","type":"text"},{"text":" Variable Schedule","type":"text","marks":[{"type":"strong"}]},{"text":" payment. This array needs to have minimum 2 set of values.","type":"text"}]},{"type":"paragraph"}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"Request for fixed schedule","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"POST https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...\n\n{\n \"payment_type\": \"fixed_schedule\",\n \"payment_intent\": \"pi_rj..........\",\n \"customer_name\": \"Test developer\",\n \"customer_email\": \"test@gmail.com\",\n \"reference\": \"schedule payment with limited installments\",\n \"customer_address\": \"Uk....\",\n \"customer_postcode\": \"119083\",\n \"frequency\": \"days\",\n \"frequency_duration\": 1,\n \"currency\": \"GBP\",\n \"first_amount\": 20.03,\n \"recurring_amount\": 15.01,\n \"final_amount\": 10.08,\n \"is_limited_installments\": true,\n \"installments\": 3,\n \"start_payment_date\": \"23-02-2023\",\n \"final_payment_date\": \"25-02-2023\",\n \"paymentToken\": \"ey............\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 201 Created\nContent-Type: application/json\n{\n \"id\": 123,\n \"payment_type\": \"fixed_schedule\",\n \"status\": \"active\",\n \"customer_name\": \"Test developer\",\n \"customer_email\": \"test@gmail.com,\n \"reference\": \"schedule payment with limited installments\",\n \"address\": \"Uk....\",\n \"postcode\": \"119083\",\n \"currency\": \"GBP\",\n \"start_payment_date\": \"23-02-2023\",\n \"final_payment_date\": \"25-02-2023\",\n \"recurring_amount\": \"15.01\",\n \"is_limited_installments\": true,\n \"installments\": 3,\n \"frequency\": \"days\",\n \"frequency_duration\": 1,\n \"is_active\": \"true\",\n \"recurring_data\": \n {\n \"recurring_id\": 1,\n \"payment_date\": \"23-02-2023\",\n \"reference\": \"Payment 1\"\n \"processed_amount\": 20.03,\n \"is_processed\": true,\n \"status\": \"captured\",\n \"xref\": \"AKY.........\"\n },\n {\n \"recurring_id\": 2,\n \"payment_date\": \"24-02-2023\",\n \"reference\": \"Payment 2\"\n \"processed_amount\": 15.01,\n \"is_processed\": false,\n \"status\": \"pending\",\n \"xref\": \"AKY.........\"\n },\n {\n \"recurring_id\": 3,\n \"payment_date\": \"25-02-2023\",\n \"reference\": \"Payment 3\"\n \"processed_amount\": 10.08,\n \"is_processed\": false,\n \"status\": \"pending\",\n \"xref\": \"AKY.........\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Request for variable schedule","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"POST https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...\n\n{\n \"payment_type\": \"variable_schedule\",\n \"payment_intent\": \"pi_rj..........\",\n \"customer_name\": \"Test developer\",\n \"customer_email\": \"test@gmail.com\",\n \"reference\": \"variable schedule\",\n \"customer_address\": \"Uk....\",\n \"customer_postcode\": \"119083\",\n \"currency\": \"GBP\",\n \"paymentToken\": \"ey............\",\n \"schedule_set\":\n {\n\t\t\"13-02-2023\": 20.02,\n\t\t\"16-02-2023\": 22.02,\n\t\t\"25-02-2023\": 26.02\n\t}\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 201 Created\nContent-Type: application/json\n{\n \"id\": 123,\n \"payment_type\": \"variable_schedule\",\n \"status\": \"active\",\n \"customer_name\": \"Test developer\",\n \"customer_email\": \"test@gmail.com,\n \"reference\": \"variable schedule\",\n \"address\": \"Uk....\",\n \"postcode\": \"119083\",\n \"currency\": \"GBP\",\n \"start_payment_date\": \"13-02-2023\",\n \"final_payment_date\": \"25-02-2023\",\n \"recurring_amount\": null,\n \"is_limited_installments\": false,\n \"installments\": null,\n \"frequency\": \"N/A\"\n \"frequency_duration\": \"N/A\"\n \"is_active\": true,\n \"recurring_data\": \n {\n \"recurring_id\": 1,\n \"payment_date\": \"13-02-2023\",\n \"reference\": \"Payment 1\"\n \"processed_amount\": 20.02,\n \"is_processed\": true,\n \"status\": \"captured\",\n \"xref\": \"AKY.........\"\n },\n {\n \"recurring_id\": 2,\n \"payment_date\": \"16-02-2023\",\n \"reference\": \"Payment 2\"\n \"processed_amount\": 22.02,\n \"is_processed\": false,\n \"status\": \"pending\",\n \"xref\": \"AKY.........\"\n },\n {\n \"recurring_id\": 3,\n \"payment_date\": \"25-02-2023\",\n \"reference\": \"Payment 3\"\n \"processed_amount\": 26.02,\n \"is_processed\": false,\n \"status\": \"pending\",\n \"xref\": \"AKY.........\"\n }\n}\n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph"}]}]},{"type":"rule"},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"ecom-repeat-payments"},"legacyAnchorId":{"value":"RepeatPayment-ecom-repeat-payments"}},"macroMetadata":{"macroId":{"value":"c8660ea3cc1d369978b4f41f5e3e8a45"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"e708b9e3-9c54-4951-85ca-f1f687419227"}},{"type":"hardBreak"},{"text":"Create Repeat Payment Using ECOM","type":"text"}]},{"type":"paragraph","content":[{"text":"Create a repeat payment schedule.","type":"text"},{"type":"hardBreak"},{"text":"A schedule can either be on a Variable or Fixed basis","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}}]},{"text":" /pay/v1/repeat-payments","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Headers","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Content-Type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Content type.","type":"text"}]},{"type":"paragraph","content":[{"text":"Authorization","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Access token generated from ","type":"text"},{"text":"create token","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375567"}}]},{"text":" request.","type":"text"}]},{"type":"paragraph","content":[{"text":"User-Agent","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"User agent.","type":"text"}]},{"type":"paragraph","content":[{"text":"Accept","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Accept","type":"text"}]},{"type":"paragraph","content":[{"text":"Accept-Encoding","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Accept encoding.","type":"text"}]},{"type":"paragraph","content":[{"text":"Accept-Charset","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Accept charset.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Attributes - (required for all schedules)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"payment_type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Repeat payment type. It must be either of the following values.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fixed_schedule","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"variable_schedule","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"payment_intent","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Payment intent generated from ","type":"text"},{"text":"create intent","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375502"}}]},{"text":" request.","type":"text"}]},{"type":"paragraph","content":[{"text":"paymentToken","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Tokenised card value. In ","type":"text"},{"text":"create intent","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375502"}}]},{"text":" response, ","type":"text"},{"text":"ccElement","type":"text","marks":[{"type":"code"}]},{"text":" will be returned in element array if repeat payment is enabled for that merchant account. User can populate ","type":"text"},{"text":"ccElement","type":"text","marks":[{"type":"code"}]},{"text":" as a part of the create repeat request form to generate and pass paymentToken value. Please go through the process from ","type":"text"},{"text":"payment page","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/179568673"}}]},{"text":", to generate paymentToken. ","type":"text"}]},{"type":"paragraph","content":[{"text":"customer_name","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Customer name.","type":"text"}]},{"type":"paragraph","content":[{"text":"customer_email","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Customer email.","type":"text"}]},{"type":"paragraph","content":[{"text":"reference","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Reference value. Unique textual details of the schedule","type":"text"}]},{"type":"paragraph","content":[{"text":"customer_address","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Customer address.","type":"text"}]},{"type":"paragraph","content":[{"text":"customer_postcode","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Customer postcode.","type":"text"}]},{"type":"paragraph","content":[{"text":"currency","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Currency that the payments will be processed in","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Specific fields for a Fixed schedule - (These cannot be used in conjunction with the below Variable schedule specific fields)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"frequency","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Payment cycle frequency. It is required when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":"Possible values are ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"days","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"weeks","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"months","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"frequency_duration","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"integer","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Payment frequency duration. It is required when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"(E.g. “2” and “days” will be every 2 days)","type":"text"}]},{"type":"paragraph","content":[{"text":"start_payment_date","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"date","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Date on which the first payment will be captured. ","type":"text"},{"type":"hardBreak"},{"text":"It is required when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"Default value set to today. ","type":"text"}]},{"type":"paragraph","content":[{"text":"first_amount","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"decimal (optional)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"First payment amount. ","type":"text"},{"type":"hardBreak"},{"text":"When creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":", the first amount value can be customised.","type":"text"}]},{"type":"paragraph","content":[{"text":"recurring_amount","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"decimal","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Recurring amount for each instalment. It is required when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"is_limited_installments","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text"},{"text":"boolean ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"When creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":", it is required to mention if the schedule will have unlimited or limited instalments. ","type":"text"},{"type":"hardBreak"},{"text":"Possible values are ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"installments","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"integer","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Number of installments. ","type":"text"},{"type":"hardBreak"},{"text":"It is required when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":" if the","type":"text"},{"text":" is_limited_installments","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0747a6"}}]},{"text":" field is ","type":"text"},{"text":"true","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0747a6"}}]},{"text":" (i.e. it has limited instalments)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"0c7c8b06-272c-4874-9d0a-e60b00cc716f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"is_limited_installments","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0747a6"}}]},{"text":" is ","type":"text"},{"text":"true","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0747a6"}}]},{"text":", then these 2 fields can also be added","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"final_amount","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"decimal (optional)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Final payment amount. ","type":"text"},{"type":"hardBreak"},{"text":"This can be used when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":" if there are ","type":"text"},{"text":"limited instalments","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":"If there are unlimited instalments, this field should not be used. ","type":"text"}]},{"type":"paragraph","content":[{"text":"final_payment_date","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"date (optional)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Date on which the final payment will be captured. ","type":"text"},{"type":"hardBreak"},{"text":"Final date can be customised along with the final amount when creating a ","type":"text"},{"text":"Fixed Schedule","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":"This can only be used if there are ","type":"text"},{"text":"limited instalments","type":"text","marks":[{"type":"strong"}]},{"text":". If there are unlimited instalments, this field should not be used. ","type":"text"},{"type":"hardBreak"},{"text":"This date must be after the start payment date and also after the 2nd last recurring date.","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Specific fields for a Variable schedule - (This cannot be used in conjunction with any of the above Fixed schedule specific fields)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"schedule_set","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"array ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Schedule set is a array set of date and amount where the date will be the key and the amount will be its value. ","type":"text"},{"type":"hardBreak"},{"text":"It is required for","type":"text"},{"text":" Variable Schedule","type":"text","marks":[{"type":"strong"}]},{"text":" payment. This array needs to have minimum 2 set of values.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Specific fields for ECOM","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"device_timezone","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"integer","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Device timezone value which can be fetched using javascript and assigned to the respective hosted input field. This value is required in 3DS.","type":"text"}]},{"type":"paragraph","content":[{"text":"device_capabilities","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Device capabilities which can be fetched using javascript and assigned to the respective hosted input field. This value is required in 3DS.","type":"text"}]},{"type":"paragraph","content":[{"text":"device_accept_language","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Device accept language which can be fetched using javascript and assigned to the respective hosted input field. This value is required in 3DS.","type":"text"}]},{"type":"paragraph","content":[{"text":"device_screen_resolution","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Device accept language which can be fetched using javascript and assigned to the respective hosted input field. This value is required in 3DS.","type":"text"}]},{"type":"paragraph","content":[{"text":"remote_address","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Remote address which can be fetched using javascript and assigned to the respective hosted input field. This value is required in 3DS.","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"Request for fixed schedule","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"POST https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...\nUser-Agent: \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36\",\nAccept: \"*/*\"\nAccept-Encoding: \"gzip, deflate, br\"\nAccept-Charset: \"\"\n\n{ \n \"payment_type\": \"fixed_schedule\",\n \"payment_intent\": \"pi_rj..........\",\n \"customer_name\": \"Test developer\",\n \"customer_email\": \"test@gmail.com\",\n \"reference\": \"fixed schedule payment with unlimited installments\",\n \"customer_address\": \"Uk....\",\n \"customer_postcode\": \"119083\",\n \"frequency\": \"days\",\n \"frequency_duration\": 1,\n \"currency\": \"GBP\",\n \"recurring_amount\": 15.01,\n \"is_limited_installments\": false,\n \"start_payment_date\": \"23-02-2023\",\n \"paymentToken\": \"ey............\",\n \"device_timezone\" : \"-330\",\n \"device_capabilities\" : \"javascript\",\n \"device_accept_language\" : \"en-GB\",\n \"device_screen_resolution\" : \"1366x768x24\",\n \"remote_address\" : \"123.123.123.123\"\n \n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n \"acsform\": \"\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"HTML Page","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"\n\n\n \n\n\n\n \n\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Request for variable schedule","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"POST https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...\nUser-Agent: \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36\",\nAccept: \"*/*\"\nAccept-Encoding: \"gzip, deflate, br\"\nAccept-Charset: \"\"\n\n{\n \"payment_type\": \"variable_schedule\",\n \"payment_intent\": \"pi_rj..........\",\n \"customer_name\": \"Test developer\",\n \"customer_email\": \"test@gmail.com\",\n \"reference\": \"variable schedule payment with 3ds\",\n \"customer_address\": \"Uk....\",\n \"customer_postcode\": \"119083\",\n \"currency\": \"GBP\",\n \"paymentToken\": \"ey............\",\n\t\"device_timezone\" : \"-330\",\n \"device_capabilities\" : \"javascript\",\n \"device_accept_language\" : \"en-GB\",\n \"device_screen_resolution\" : \"1366x768x24\",\n \"remote_address\" : \"123.123.123.123\",\n \"schedule_set\":\n {\n\t\t\"13-02-2023\": 20.02,\n\t\t\"16-02-2023\": 22.02,\n\t\t\"25-02-2023\": 26.02\n\t}\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 201 Created\nContent-Type: application/json\n{\n \"id\": 123,\n \"payment_type\": \"variable_schedule\",\n \"status\": \"active\",\n \"customer_name\": \"Test developer\",\n \"customer_email\": \"test@gmail.com,\n \"reference\": \"variable schedule payment with 3ds\",\n \"address\": \"Uk....\",\n \"Postcode\": \"119083\",\n \"currency\": \"GBP\",\n \"start_payment_date\": \"13-02-2023\",\n \"final_payment_date\": \"25-03-2023\",\n \"recurring_amount\": 20.02,\n \"is_limited_installments\": true,\n \"installments\": 12,\n \"frequency\": \"N/A\"\n \"frequency_duration\": \"N/A\"\n \"is_active\": true,\n \"recurring_data\": \n {\n \"recurring_id\": 1,\n \"payment_date\": \"13-02-2023\",\n \"reference\": \"Payment 1\"\n \"processed_amount\": 20.02,\n \"is_processed\": true,\n \"status\": \"accepted\",\n \"xref\": \"AKY.........\"\n },\n {\n \"recurring_id\": 2,\n \"payment_date\": \"16-03-2023\",\n \"reference\": \"Payment 2\"\n \"processed_amount\": 22.02,\n \"is_processed\": true,\n \"status\": \"declined\",\n \"xref\": \"AKY.........\"\n },\n {\n \"recurring_id\": 3,\n \"payment_date\": \"25-03-2023\",\n \"reference\": \"Payment 3\"\n \"processed_amount\": 26.02,\n \"is_processed\": false,\n \"status\": \"pending\",\n \"xref\": \"AKY.........\"\n }\n}\n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph"}]}]},{"type":"rule"},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"get-all-repeat-payments"},"legacyAnchorId":{"value":"RepeatPayment-get-all-repeat-payments"}},"macroMetadata":{"macroId":{"value":"160e4ee8b457450977551a0378affb1d"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"2866d63c-d2b2-4ec9-9d9f-9f1e45cffd3c"}},{"type":"hardBreak"},{"text":"Get all repeat payments","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"Get the details of all the repeat payment schedules created from the same account. ","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"The results can be filtered by using the below query parameters. ","type":"text"},{"text":"payment_type","type":"text","marks":[{"type":"code"}]},{"text":" need to be passed as query param without which the results can't be fetched.","type":"text"}]},{"type":"paragraph","content":[{"text":"GET","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}}]},{"text":" /pay/v1/pay/repeat-payments","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Headers","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Content-Type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Content type.","type":"text"}]},{"type":"paragraph","content":[{"text":"Authorization","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Access token generated from ","type":"text"},{"text":"create token","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]},{"text":" request.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Query parameters ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"payment_type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Repeat payment type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fixed_schedule","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"variable_schedule","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"page","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"integer (optional)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Page Number.","type":"text"}]},{"type":"paragraph","content":[{"text":"status","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string (optional)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Repeat payment status.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Active - This means the payments have started","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Pending - This means the first payment has not yet been processed","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Cancelled - This means the schedule has been cancelled. No further payments will be processed","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Completed - This means all the payments have been processed. No further payments will be processed","type":"text"}]}]}]},{"type":"paragraph"}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"Request","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"GET https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments?payment_type=variable_schedule&status=active&page=1&payment_type=variable_schedule HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n \"pageNumber\": 1,\n \"pageSize\": 50,\n \"totalResults\": 7,\n \"data\": [\n {\n \"id\": 8,\n \"payment_type\": \"variable_schedule\",\n \"status\": \"Active\",\n \"customer_name\": \"customername here\",\n \"customer_email\": \"email@gmail.co.uk\",\n \"reference\": \"Variable schedule test\",\n \"address\": \"2\",\n \"postcode\": \"3\",\n \"currency\": \"GBP\",\n \"start_payment_date\": \"19-02-2024\",\n \"final_payment_date\": \"21-02-2024\",\n \"recurring_amount\": null,\n \"is_limited_installments\": false,\n \"installments\": null,\n \"frequency\": \"N/A\",\n \"frequency_duration\": \"N/A\",\n \"is_active\": true,\n \"recurring_data\": [\n {\n \"recurring_id\": 190,\n \"payment_date\": \"2024-02-19\",\n \"reference\": \"Payment 1\",\n \"processed_amount\": \"21.02\",\n \"is_processed\": true,\n \"status\": \"Captured\",\n \"xref\": \"AKY.........\"\n },\n {\n \"recurring_id\": 191,\n \"payment_date\": \"2024-02-20\",\n \"reference\": \"Payment 2\",\n \"processed_amount\": \"1.02\",\n \"is_processed\": false,\n \"status\": \"Pending\",\n \"xref\": \"AKY.........\"\n },\n {\n \"recurring_id\": 192,\n \"payment_date\": \"2024-02-21\",\n \"reference\": \"Payment 3\",\n \"processed_amount\": \"23.02\",\n \"is_processed\": false,\n \"status\": \"Pending\",\n \"xref\": \"AKY.........\"\n }\n ]\n }\n ]","type":"text"}]}]}]},{"type":"rule"},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"get-repeat-payment"},"legacyAnchorId":{"value":"RepeatPayment-get-repeat-payment"}},"macroMetadata":{"macroId":{"value":"7388a7e3bd3a547329d0f68277d68284"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"5a76a3ba-c046-4cd6-b7dc-8fcdfdcb3717"}},{"type":"hardBreak"},{"text":"Get repeat payment","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"Get details of a specific repeat payment schedule using id.","type":"text"}]},{"type":"paragraph","content":[{"text":"GET","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}}]},{"text":" /pay/v1/pay/repeat-payments/{id}","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Headers","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Content-Type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Content type.","type":"text"}]},{"type":"paragraph","content":[{"text":"Authorization","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Access token generated from ","type":"text"},{"text":"create token","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375567"}}]},{"text":" request.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Query parameters","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"payment_type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Repeat payment type.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fixed_schedule","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"variable_schedule","type":"text"}]}]}]},{"type":"paragraph"}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"Request","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"GET https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments/123?payment_type=fixed_schedule HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n \"id\": 123,\n \"payment_type\": \"fixed_schedule\",\n \"status\": \"active\",\n \"customer_name\": \"Test developer\",\n \"customer_email\": \"test@gmail.com,\n \"reference\": \"test payment ......\",\n \"address\": \"Uk....\",\n \"Postcode\": \"119083\",\n \"Currency\": \"GBP\",\n \"start_payment_date\": \"23-02-2023\",\n \"final_payment_date\": \"25-03-2023\",\n \"recurring_amount\": 20.02,\n \"is_limited_installments\": true,\n \"installments\": 3,\n \"frequency\": \"days\",\n \"frequency_duration\": 1,\n \"is_active\": true,\n \"recurring_data\": \n {\n \"recurring_id\": 1,\n \"payment_date\": \"2024-02-23\",\n \"reference\": \"Payment 1\"\n \"processed_amount\": 20.02,\n \"is_processed\": true,\n \"status\": \"captured\"\n \"xref\": \"eygh....\"\n },\n {\n \"recurring_id\": 2,\n \"payment_date\": \"2024-02-24\",\n \"reference\": \"Payment 2\"\n \"processed_amount\": 20.02,\n \"is_processed\": false,\n \"status\": \"pending\"\n \"xref\": \"eygh....\"\n },\n {\n \"recurring_id\": 3,\n \"payment_date\": \"2024-02-25\",\n \"reference\": \"Payment 3\"\n \"processed_amount\": 20.02,\n \"is_processed\": false,\n \"status\": \"removed\"\n \"xref\": \"eygh....\"\n }\n}","type":"text"}]},{"type":"paragraph"}]}]},{"type":"rule"},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Delete-a-scheduled-payment/Cancel-all-remaining-payments"},"legacyAnchorId":{"value":"RepeatPayment-Delete-a-scheduled-payment/Cancel-all-remaining-payments"}},"macroMetadata":{"macroId":{"value":"a2ce5266c80a135c23d22894ac38d838"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"a9b4ac14-ebf4-4280-9ee2-e9743470c352"}},{"type":"hardBreak"},{"text":"Delete a scheduled payment/Cancel all remaining payments","type":"text"}]},{"type":"paragraph","content":[{"text":"This can be used:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To delete a schedule and all its remaining payments that havent been processed yet, using just the main schedule ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To delete a specific future payment from a schedule, using the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" and the ","type":"text"},{"text":"recurring_id ","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"The schedule ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"recurring_id","type":"text","marks":[{"type":"code"}]},{"text":" can be fetched from ","type":"text"},{"text":"get repeat payment request.","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"This will delete the future payment from both fixed and variable schedules. ","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"DELETE ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":"/pay/v1/repeat-payments/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Headers","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Content-Type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Content type.","type":"text"}]},{"type":"paragraph","content":[{"text":"Authorization","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Access token generated from ","type":"text"},{"text":"create token","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375567"}}]},{"text":" request.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Attributes","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"payment_type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat payment.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fixed_schedule","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"variable_schedule","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"recurring_id","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"integer (optional)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Recurring id is need to be passed to delete a specific recurring event of Fixed and Variable schedule payment.","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"Request","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"DELETE https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments/{id} HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...\n\n{\n \"payment_type\": \"fixed_schedule\",\n \"recurring_id\": 123\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n \"success\": true,\n \"message\": \"Deleted successfully\"\n}","type":"text"}]}]}]},{"type":"rule"},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"cancel-repeat-payment"},"legacyAnchorId":{"value":"RepeatPayment-cancel-repeat-payment"}},"macroMetadata":{"macroId":{"value":"30da5214afc69b95741fa42a5095b2e0"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"fa8b87a2-6f4b-43a4-9255-4d765f8902e5"}},{"type":"hardBreak"},{"text":"Refund a processed payment","type":"text"}]},{"type":"paragraph","content":[{"text":"Refund any processed repeat payment using repeat schedule id and recurring id. ","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"In this scenario, the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" (repeat schedule id) needs to be passed in the request url, with the ","type":"text"},{"text":"recurring_id","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"payment_type","type":"text","marks":[{"type":"code"}]},{"text":" in the request body.","type":"text"}]},{"type":"paragraph","content":[{"text":"This request can be used to refund a processed payment that has a ","type":"text"},{"text":"captured","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"completed","type":"text","marks":[{"type":"code"}]},{"text":" status ","type":"text"},{"type":"hardBreak"},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"DELETE ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":"/pay/v1/repeat-payments/cancel/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Headers","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Content-Type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Content type.","type":"text"}]},{"type":"paragraph","content":[{"text":"Authorization","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Access token generated from ","type":"text"},{"text":"create token","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375567"}}]},{"text":" request.","type":"text"}]},{"type":"paragraph","content":[{"text":"Attributes","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"payment_type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat payment.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fixed_schedule","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"variable_schedule","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"recurring_id","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"integer","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Recurring id needs to be passed to refund a specific payment from a Fixed or Variable schedule.","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"Request","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"DELETE https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments/cancel/{id} HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...\n\n{\n \"payment_type\": \"fixed_schedule\",\n \"recurring_id\": 123\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n \"success\": true,\n \"message\": \"Cancelled successfully\"\n}","type":"text"}]}]}]},{"type":"rule"},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"retry-repeat-payment"},"legacyAnchorId":{"value":"RepeatPayment-retry-repeat-payment"}},"macroMetadata":{"macroId":{"value":"bda928a03e4f3b7aded4544a072abd53"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"c765fd6f-46c7-4038-b491-e6147b813bd5"}},{"type":"hardBreak"},{"text":"Retry a processed payment that failed","type":"text"}]},{"type":"paragraph","content":[{"text":"Retry any specific payment which was able to run on the scheduled day but returned a declined status due to some issue for that Repeat schedule. ","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"This will run the payment for both fixed and variable schedules. ","type":"text"},{"type":"hardBreak"},{"text":"In this scenario, the ","type":"text"},{"text":"recurring_id","type":"text","marks":[{"type":"code"}]},{"text":" (fetched from ","type":"text"},{"text":"get repeat payment request","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]},{"text":") needs to be passed in the body, along with the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" (repeat schedule id) in the request url.","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#bf2600"}}]},{"text":"/pay/v1/repeat-payments/retry/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Headers","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Content-Type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Content type.","type":"text"}]},{"type":"paragraph","content":[{"text":"Authorization","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Access token generated from ","type":"text"},{"text":"create token","type":"text","marks":[{"type":"link","attrs":{"href":"https://blinkpayment.atlassian.net/wiki/spaces/IN/pages/173375567"}}]},{"text":" request.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Attributes","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"payment_type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat payment.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fixed_schedule","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"variable_schedule","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"recurring_id","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]},{"text":"integer ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#b3d4ff"}}]},{"type":"hardBreak"},{"text":"Recurring id needs to be passed to retry a specific payment from a Fixed or Variable schedule.","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"Request","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"POST https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments/retry/{id} HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...\n\n{\n \"payment_type\": \"fixed_schedule\",\n \"recurring_id\": 123\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}},{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n \"success\": true,\n \"message\": \"Payment retried successfully\"\n}","type":"text"}]}]}]},{"type":"rule"}],"version":1}

Browser not supported