Page Comparison

Repeat payment schedules are those where the user chooses the required setup information, and the payments will be executed automatically on a recurring basis.

There are two types of repeat payment schedules.

Fixed Scheduled Repeat Payment - In this scenario, each payment is taken at a regular frequency for a fixed amount.
Variable Scheduled Repeat Payment - In this scenario, each payment’s date and amount set is completely different.

Both schedules can be created using ECOM or MOTO (see below)

There are two ways to create a repeat payment schedule.

ECOM (which usually requires 3DS) - Customer initiated

ECOM payment uses 3DS and returns an acsform, which is a HTML from used to perform the 3DS authentication.

A HTML page should be send to the user which include the acsform in the body and the following JS in the header:

Code Block
<script> onload = () => document.forms[0].submit(); </script>

The user will complete the 3DS form and submit.

After submission, the user will be redirected to the predefined return URL with an encoded repeat schedule ID.

MOTO (without 3DS) - Merchant initiated

MOTO payment processes the payment without the 3DS check. Once the payment is processed the user will get json response with all the repeat schedule related data.

Each request is authenticated using HTTP Basic Auth by adding a bearer token to the header, e.g. Authentication: Bearer {{access_token}}. You can get the {{access_token}} from the create token request.

A Payment_intent needs to be generated before creating a repeat payment schedule from the create intent request. ccElement is passed as part of the response, which can be implemented to generate payment form and paymentToken ( tokenised card value) from there.

In a PHP implementation, payment page may look like this:

Code Block<head> ... <script src="https://code.jquery.com/jquery-3.6.3.min.js"></script> <script src="https://gateway2.blinkpayment.co.uk/sdk/web/v1/js/hostedfields.min.js"></script> <script src="https://secure.blinkpayment.co.uk/assets/js/api/custom.js"></script> ... </head> <body> <form method="POST" action="update" id="payment"> @csrf

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.

There are two types of repeat payment schedules.

Fixed Scheduled Repeat Payment - In this scenario, each payment is taken at a regular frequency for a fixed amount.
Variable Scheduled Repeat Payment - In this scenario, each payment’s date and amount set is completely different.

Both schedules can be created using the ECOM or MOTO method

There are two methods to create a repeat payment schedule.

ECOM - This means that the card details are being entered on a secure payment page by the Customer

These are designed for you to accept payments via a website, such as a shopping cart payment.
This ECOM method will use advance fraud detection of 3-D Secure.

3-D Secure will return a acsform, which is a HTML form used to perform the 3-D Secure authentication.

A HTML page should be send to the user which include the acsform in the body and the following JS in the header:

Code Block
<script> onload = () => document.forms[0].submit(); </script>

The user will complete the 3-D Secure form and submit.

After submission, the user will be redirected to the predefined return URL with an encoded repeat schedule ID.

MOTO - This means that the card details are being entered on a secure payment page by the Merchant

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.

Once the payment is processed the user will get json response with all the repeat schedule related data.

Each request is authenticated using HTTP Basic Auth by adding a bearer token to the header, e.g. Authentication: Bearer {{access_token}}. You can get the {{access_token}} from the create token request.

Before creating a repeat payment schedule, a Payment_intent needs to be generated from the create intent request.

The ccElement is passed as part of the response, which can be implemented to generate the payment form and paymentToken ( tokenised card value) from there.

In a PHP implementation, the payment page may look like this:

Code Block

<head>
  ...
  <script src="https://code.jquery.com/jquery-3.6.3.min.js"></script>
  <script src="https://gateway2.blinkpayment.co.uk/sdk/web/v1/js/hostedfields.min.js"></script>
  <script src="https://secure.blinkpayment.co.uk/assets/js/api/custom.js"></script>
  ...
</head>

<body>
    <form method="POST" action="update" id="payment">
        @csrf
        {!! $ccElement !!}
        <button type="submit">Submit</button>
    </form>
</body>

Resources

POST /pay/v1/repeat-payments for MOTO
POST /pay/v1/repeat-payments for ECOM
GET /pay/v1/repeat-payments
GET /pay/v1/repeat-payments/{id}
DELETE /pay/v1/repeat-payments/{id}
DELETE /pay/v1/repeat-payments/cancel/{id}
POST /pay/v1/repeat-payments/retry/{id}
POST /pay/v1/repeat-payments/card/{id}

Anchor
moto-repeat-payments
moto-repeat-payments

Create Repeat Payment

Using

using MOTO

POST /pay/v1/repeat-payments

Headers

Create a repeat payment schedule.
A schedule can either be on a Variable or Fixed basis

POST /pay/v1/repeat-payments

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Attributes - (Required for all schedules)

payment_typestring
Repeat payment type. It must be either of the following values.

fixed_schedule
variable_schedule

payment_intentstring
Payment intent generated from create intent request.

paymentTokenstring
Tokenised card value. In create intent response, ccElement will be returned in element array if repeat payment is enabled for that merchant account. User can populate ccElement as a part of the create repeat request form to generate and pass paymentToken value. Please go through the process from payment page, to generate paymentToken.

customer_namestring
Customer name.

customer_emailstring
Customer email.

referencestring
Reference value. Unique textual details of the schedule

customer_addressstring
Customer address.

customer_postcodestring
Customer postcode.

currencystring
Currency that the payments will be processed in

Specific fields for a Fixed schedule - (These cannot be used in conjunction with the below Variable schedule specific fields)

frequencystring
Payment cycle frequency. It is required when creating a Fixed Schedule.
Possible values are

days
weeks
months

frequency_durationinteger
Payment frequency duration. It is required when creating a Fixed Schedule.
(E.g. “2” and “days” will be every 2 days)

start_payment_datedate
Date on which the first payment will be captured.
It is required when creating a Fixed Schedule.
Default value set to today.

first_amountdecimal (optional)
First payment amount.
When creating a Fixed Schedule, the first amount value can be customised.

recurring_amountdecimal
Recurring amount for each instalment. It is required when creating a Fixed Schedule.

is_limited_installments boolean
When creating a Fixed Schedule, it is required to mention if the process has schedule will have unlimited or limited instalments.
Possible values are

true
false

installmentsinteger
Number of instalmentsinstallments.
It is required when creating a Fixed Schedule if the process is_limited_installments field is true (i.e. it has limited instalments.)

If is_limited_installments is true, then these 2 fields can also be added

final_amountdecimal (optional)
Final payment amount.
This can be used when creating a Fixed Schedule if there are limited instalments.
If there are unlimited instalments, this field should not be used.

final_payment_datedate (optional)
Date on which the final payment will be captured.
Final date can be customised along with the final amount when creating a Fixed Schedule.
This can only be used if there are limited instalments. If there are unlimited instalments, this field should not be used.
This date must be after the start payment date and also after the 2nd last recurring date.

paymentTokenstring
Tokenised card value. In create intent response, ccElement will be returned in element array if repeat payment is enabled for that merchant account. User can populate ccElement as a part of the create repeat request form to generate and pass paymentToken value. Please go through the process from payment page, to generate paymentToken. If, repeat payment request is created form a existing transaction, then this value is not required.Specific fields for a Variable schedule - (This cannot be used in conjunction with any of the above Fixed schedule specific fields)

schedule_setarray
Schedule set is a array set of date and amount where the date will be the key and the amount will be its value.
It is required for Variable Schedule payment. This array needs to have minimum 2 set of values.

Request for fixed schedule

Code Block

POST https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
    "payment_type": "fixed_schedule",
    "payment_intent": "pi_rj..........",
    "customer_name": "Test developer",
    "customer_email": "test@gmail.com",
    "reference": "schedule payment with limited installments",
    "customer_address": "Uk....",
    "customer_postcode": "119083",
    "frequency": "days",
    "frequency_duration": 1,
    "currency": "GBP",
    "first_amount": 20.03,
    "recurring_amount": 15.01,
    "final_amount": 10.08,
    "is_limited_installments": true,
    "installments": 3,
    "start_payment_date": "23-02-2023",
    "final_payment_date": "25-02-2023",
    "paymentToken": "ey............"
}

Response

Code Block

HTTP/1.1 201 Created
Content-Type: application/json
{
    "id": 123,
    "payment_type": "fixed_schedule",
    "status": "active",
    "customer_name": "Test developer",
    "customer_email": "test@gmail.com,
    "reference": "schedule payment with limited installments",
    "address": "Uk....",
    "postcode": "119083",
    "currency": "GBP",
    "start_payment_date": "23-02-2023",
    "final_payment_date": "25-02-2023",
    "recurring_amount": "15.01",
    "is_limited_installments": true,
    "installments": 3,
    "frequency": "days",
    "frequency_duration": 1,
    "is_active": "true",
    "recurring_data": 
      {
        "recurring_id": 1,
        "payment_date": "23-02-2023",
        "reference": "Payment 1"
        "processed_amount": 20.03,
        "is_processed": true,
        "status": "captured",
        "xref": "AKY........."
      },
      {
        "recurring_id": 2,
        "payment_date": "24-02-2023",
        "reference": "Payment 2"
        "processed_amount": 15.01,
        "is_processed": false,
        "status": "pending",
        "xref": "AKY........."
      },
      {
        "recurring_id": 3,
        "payment_date": "25-02-2023",
        "reference": "Payment 3"
        "processed_amount": 10.08,
        "is_processed": false,
        "status": "pending",
        "xref": "AKY........."
      }
}

Request for variable schedule

Code Block

POST https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
    "payment_type": "variable_schedule",
    "payment_intent": "pi_rj..........",
    "customer_name": "Test developer",
    "customer_email": "test@gmail.com",
    "reference": "variable schedule",
    "customer_address": "Uk....",
    "customer_postcode": "119083",
    "currency": "GBP",
    "paymentToken": "ey............",
    "schedule_set":
    {
		"13-02-2023": 20.02,
		"16-02-2023": 22.02,
		"25-02-2023": 26.02
	}
}

Response

Code Block

HTTP/1.1 201 Created
Content-Type: application/json
{
    "id": 123,
    "payment_type": "variable_schedule",
    "status": "active",
    "customer_name": "Test developer",
    "customer_email": "test@gmail.com,
    "reference": "variable schedule",
    "address": "Uk....",
    "postcode": "119083",
    "currency": "GBP",
    "start_payment_date": "13-02-2023",
    "final_payment_date": "25-02-2023",
    "recurring_amount": null,
    "is_limited_installments": false,
    "installments": null,
    "frequency": "N/A"
    "frequency_duration": "N/A"
    "is_active": true,
    "recurring_data": 
      {
        "recurring_id": 1,
        "payment_date": "13-02-2023",
        "reference": "Payment 1"
        "processed_amount": 20.02,
        "is_processed": true,
        "status": "captured",
        "xref": "AKY........."
      },
      {
        "recurring_id": 2,
        "payment_date": "16-02-2023",
        "reference": "Payment 2"
        "processed_amount": 22.02,
        "is_processed": false,
        "status": "pending",
        "xref": "AKY........."
      },
      {
        "recurring_id": 3,
        "payment_date": "25-02-2023",
        "reference": "Payment 3"
        "processed_amount": 26.02,
        "is_processed": false,
        "status": "pending",
        "xref": "AKY........."
      }
}

Anchor
ecom-repeat-payments
ecom-repeat-payments

Create Repeat Payment Using ECOM

POST /pay/v1/repeatCreate a repeat payment schedule.
A schedule can either be on a Variable or Fixed basis

POST /pay/v1/repeat-payments

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

User-Agentstring
User agent.

Acceptstring
Accept

Accept-Encodingstring
Accept encoding.

Accept-Charsetstring
Accept charset.

Attributes - (required for all schedules)

payment_typestring
Repeat payment type. It must be either of the following values.

fixed_schedule
variable_schedule

payment_intentstring
Payment intent generated from create intent request.

paymentTokenstring
Tokenised card value. In create intent response, ccElement will be returned in element array if repeat payment is enabled for that merchant account. User can populate ccElement as a part of the create repeat request form to generate and pass paymentToken value. Please go through the process from payment page, to generate paymentToken.

customer_namestring
Customer name.

customer_emailstring
Customer email.

referencestring
Reference value. Unique textual details of the schedule

customer_addressstring
Customer address.

customer_postcodestring
Customer postcode.

currencystring
Currency that the payments will be processed in

Specific fields for a Fixed schedule - (These cannot be used in conjunction with the below Variable schedule specific fields)

frequencystring
Payment cycle frequency. It is required when creating a Fixed Schedule.
Possible values are

days
weeks
months

frequency_durationinteger
Payment frequency duration. It is required when creating a Fixed Schedule.
(E.g. “2” and “days” will be every 2 days)

start_payment_datedate
Date on which the first payment will be captured.
It is required when creating a Fixed Schedule.
Default value set to today.

first_amountdecimal (optional)
First payment amount.
When creating a Fixed Schedule, the first amount value can be customised.

recurring_amountdecimal
Recurring amount for each instalment. It is required when creating a Fixed Schedule.

is_limited_installments boolean
When creating a Fixed Schedule, it is required to mention if the process has schedule will have unlimited or limited instalments.
Possible values are

true
false

installmentsinteger
Number of instalmentsinstallments.
It is required when creating a Fixed Schedule if the process is_limited_installments field is true (i.e. it has limited instalments.)

If is_limited_installments is true, then these 2 fields can also be added

final_amountdecimal (optional)
Final payment amount.
This can be used when creating a Fixed Schedule if there are limited instalments.
If there are unlimited instalments, this field should not be used.

final_payment_datedate (optional)
Date on which the final payment will be captured.
Final date can be customised along with the final amount when creating a Fixed Schedule.
This can only be used if there are limited instalments. If there are unlimited instalments, this field should not be used.
This date must be after the start payment date and also after the 2nd last recurring date.

paymentTokenstring
Tokenised card value. In create intent response, ccElement will be returned in element array if repeat payment is enabled for that merchant account. User can populate ccElement as a part of the create repeat request form to generate and pass paymentToken value. Please go through the process from payment page, to generate paymentToken. If, repeat payment request is created form a existing transaction, then this value is not required.Specific fields for a Variable schedule - (This cannot be used in conjunction with any of the above Fixed schedule specific fields)

schedule_setarray
Schedule set is a array set of date and amount where the date will be the key and the amount will be its value.
It is required for Variable Schedule payment. This array needs to have minimum 2 set of values.

Specific fields for ECOM

device_timezoneinteger
Device timezone value which can be fetched using javascript and assigned to the respective hosted input field. This value is required in 3DS.

device_capabilitiesstring
Device capabilities which can be fetched using javascript and assigned to the respective hosted input field. This value is required in 3DS.

device_accept_languagestring
Device accept language which can be fetched using javascript and assigned to the respective hosted input field. This value is required in 3DS.

device_screen_resolutionstring
Device accept language which can be fetched using javascript and assigned to the respective hosted input field. This value is required in 3DS.

remote_addressstring
Remote address which can be fetched using javascript and assigned to the respective hosted input field. This value is required in 3DS.

Request for fixed schedule

Code Block

POST https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...
User-Agent: "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36",
Accept: "*/*"
Accept-Encoding: "gzip, deflate, br"
Accept-Charset: ""

{   
    "payment_type": "fixed_schedule",
    "payment_intent": "pi_rj..........",
    "customer_name": "Test developer",
    "customer_email": "test@gmail.com",
    "reference": "fixed schedule payment with unlimited installments",
    "customer_address": "Uk....",
    "customer_postcode": "119083",
    "frequency": "days",
    "frequency_duration": 1,
    "currency": "GBP",
    "recurring_amount": 15.01,
    "is_limited_installments": false,
    "start_payment_date": "23-02-2023",
    "paymentToken": "ey............",
    "device_timezone" : "-330",
    "device_capabilities" : "javascript",
    "device_accept_language" : "en-GB",
    "device_screen_resolution" : "1366x768x24",
    "remote_address" : "123.123.123.123"
    
}

Response

Code Block

HTTP/1.1 200 OK
Content-Type: application/json

{
   "acsform": "<form id="form3ds22" method="post" action="https://acs.********"><input type="hidden" name="creq" value="********">
     <input type="hidden" name="threeDSPageSessions[427**************][bfreq]" value="*******">
     <input type="hidden" name="threeDSPageSessions[427**************][threeDSRef]" value="****">
     <input id="btnSubmit" type="submit" class="button expanded btn btn-primary" value="Process Payment">
     </form>"
}

HTML Page

Code Block

<!DOCTYPE html>
<html>
<head>
  <script>
    onload = () => document.forms[0].submit();
  </script>
</head>

<body>
  <form id="form3ds22" method="post" action="https://acs.********"><input type="hidden" name="creq" value="********">
    <input type="hidden" name="threeDSPageSessions[427**************][bfreq]" value="*******">
    <input type="hidden" name="threeDSPageSessions[427**************][threeDSRef]" value="****">
    <input id="btnSubmit" type="submit" class="button expanded btn btn-primary" value="Process Payment">
  </form>
</body>
</html>

Request for variable schedule

Code Block

POST https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...
User-Agent: "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36",
Accept: "*/*"
Accept-Encoding: "gzip, deflate, br"
Accept-Charset: ""

{
    "payment_type": "variable_schedule",
    "payment_intent": "pi_rj..........",
    "customer_name": "Test developer",
    "customer_email": "test@gmail.com",
    "reference": "variable schedule payment with 3ds",
    "customer_address": "Uk....",
    "customer_postcode": "119083",
    "currency": "GBP",
    "paymentToken": "ey............",
	"device_timezone" : "-330",
    "device_capabilities" : "javascript",
    "device_accept_language" : "en-GB",
    "device_screen_resolution" : "1366x768x24",
    "remote_address" : "123.123.123.123",
    "schedule_set":
    {
		"13-02-2023": 20.02,
		"16-02-2023": 22.02,
		"25-02-2023": 26.02
	}
}

Response

Code Block

HTTP/1.1 201 Created
Content-Type: application/json
{
    "id": 123,
    "payment_type": "variable_schedule",
    "status": "active",
    "customer_name": "Test developer",
    "customer_email": "test@gmail.com,
    "reference": "variable schedule payment with 3ds",
    "address": "Uk....",
    "Postcode": "119083",
    "currency": "GBP",
    "start_payment_date": "13-02-2023",
    "final_payment_date": "25-03-2023",
    "recurring_amount": 20.02,
    "is_limited_installments": true,
    "installments": 12,
    "frequency": "N/A"
    "frequency_duration": "N/A"
    "is_active": true,
    "recurring_data": 
      {
        "recurring_id": 1,
        "payment_date": "13-02-2023",
        "reference": "Payment 1"
        "processed_amount": 20.02,
        "is_processed": true,
        "status": "accepted",
        "xref": "AKY........."
      },
      {
        "recurring_id": 2,
        "payment_date": "16-03-2023",
        "reference": "Payment 2"
        "processed_amount": 22.02,
        "is_processed": true,
        "status": "declined",
        "xref": "AKY........."
      },
      {
        "recurring_id": 3,
        "payment_date": "25-03-2023",
        "reference": "Payment 3"
        "processed_amount": 26.02,
        "is_processed": false,
        "status": "pending",
        "xref": "AKY........."
      }
}

Anchor
get-all-repeat-payments
get-all-repeat-payments

Get all repeat payments

Get the details of all the repeat payments payment schedules created from the same merchant account.
Results
The results can be filtered by using the below query parameters. payment_type need to be passed as query param without which result the results can't be fetched.

GET /pay/v1/pay/repeat-payments

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Query parameters

payment_typestring
Repeat payment type.

fixed_schedule
variable_schedule

pageinteger (optional)
Page Number.

statusstring (optional)
Repeat payment status.

Active - This means the payments have started
Pending - This means the first payment has not yet been processed
Cancelled - This means the schedule has been cancelled. No further payments will be processed
Completed - This means all the payments have been processed. No further payments will be processed

Request

Code Block

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
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

Response

Code BlockHTTP/1.1 200 OK Content-Type: application/json { "pageNumber": 1, "pageSize": 50, "totalResults": 7, "data": [ { "id": 8, "payment_type": "variable_schedule", "status": "Active", "customer_name": "customername here", "customer_email": "email@gmail.co.uk", "reference": "Variable schedule test", "address": "2", "postcode": "3", "currency": "GBP", "start_payment_date": "19-02-2024", "final_payment_date": "21-02-2024", "recurring_amount": null,

Request

Code Block

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
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

Response

Code Block

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pageNumber": 1,
    "pageSize": 50,
    "totalResults": 7,
    "data": [
       {
            "is_limited_installmentsid": false8,
            "installmentspayment_type": null"variable_schedule",
            "frequencystatus": "N/AActive",
            "frequencycustomer_durationname": "N/Acustomername here",
            "iscustomer_activeemail": true"email@gmail.co.uk",
            "recurring_datareference": ["Variable schedule test",
            "address": "2",
{            "postcode": "3",
       "recurring_id": 190,        "currency": "GBP",
            "start_payment_date": "202419-02-192024",
  
                 "reference"final_payment_date": "Payment 1",
    21-02-2024",
               "processedrecurring_amount": "21.02"null,
            "is_limited_installments": false,
      "is_processed": true,     "installments": null,
              "statusfrequency": "CapturedN/A",
            "frequency_duration": "N/A",
      "xref      "is_active": "AKY........."true,
            "recurring_data": [
  },                 {
                    "recurring_id": 191190,
                    "payment_date": "2024-02-2019",
                    "reference": "Payment 21",
                    "processed_amount": "121.02",
                    "is_processed": falsetrue,
                    "status": "PendingCaptured",
                    "xref": "AKY........."
                },
                {
                    "recurring_id": 192191,
                    "payment_date": "2024-02-2120",
                    "reference": "Payment 32",
                    "processed_amount": "231.02",
                    "is_processed": false,
                    "status": "Pending",
                    "xref": "AKY........."
                }
   ...."
         ]          }
      ]

Anchorget-repeat-paymentget-repeat-paymentGet repeat payment

Get details of a specific repeat payment using id.

GET /pay/v1/pay/repeat-payments/{id}

Headers

Content-Typestring
Content type.Authorizationstring
Access token generated from create token request.

Query parameters

payment_typestring
Repeat payment type.

fixed_schedule
variable_schedule

Request

Code Block
GET https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments/123?payment_type=fixed_schedule HTTP/1.1 Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

Response

Code Block

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 123,
    "payment_type": "fixed_schedule",
    "status": "active",,
                {
                    "recurring_id": 192,
                    "customerpayment_namedate": "Test developer2024-02-21",
    "customer_email": "test@gmail.com,        "reference": "test payment ......",     "addressreference": "Uk....Payment 3",
       "Postcode": "119083",       "Currency": "GBP",     "startprocessed_payment_dateamount": "23-.02-2023",
       "final_payment_date": "25-03-2023",       "recurring_amount": 20.02,     "is_limited_installmentsprocessed": truefalse,
     "installments": 3,         "frequency": "days",     "frequency_durationstatus": 1"Pending",
     "is_active": true,     "recurring_data":        { "xref": "AKY........."
      "recurring_id": 1,         "payment_date": "23-02-2023",}
         "reference": "Payment 1"  ]
      "processed_amount": 20.02,  }
      "is_processed": true,
        "status": "captured"
        "xref": "eygh...."
      },
      {
        "recurring_id": 2,
        "payment_date": "24-02-2023]

Anchor
get-repeat-payment
get-repeat-payment

Get repeat payment

Get details of a specific repeat payment schedule using id.

GET /pay/v1/pay/repeat-payments/{id}

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Query parameters

payment_typestring
Repeat payment type.

fixed_schedule
variable_schedule

Request

Code Block
GET https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments/123?payment_type=fixed_schedule HTTP/1.1 Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

Response

Code Block

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 123,
    "payment_type": "fixed_schedule",
        "referencestatus": "Payment 2"
        "processed_amount": 20.02,
   active",
    "iscustomer_processedname": false"Test developer",
    "customer_email": "test@gmail.com,
    "statusreference": "pending"test payment ......",
      "xrefaddress": "eyghUk....",
      }"Postcode": "119083",
    "Currency": "GBP",
{         "recurring_id"start_payment_date": 3"23-02-2023",
        "final_payment_date": "25-0203-2023",
    "recurring_amount": 20.02,
    "referenceis_limited_installments": "Payment 3"true,
    "installments": 3,
    "processed_amountfrequency": 20.02,"days",
    "frequency_duration": 1,
    "is_processedactive": falsetrue,
    "recurring_data": 
     "status": "removed" {
        "xrefrecurring_id": "eygh...."
1,
     }
}

AnchorDelete-a-scheduled-payment/Cancel-all-remaining-paymentsDelete-a-scheduled-payment/Cancel-all-remaining-payments

Delete a specific future recurring payment of a Repeat schedule using recurring id (fetched from get repeat payment request.)

This will delete the future payment from both fixed and variable schedules.
The recurring_id needs to be passed along with the main id (repeat schedule id) in request url to delete any specific recurring payment.
If the recurring_id is not passed then it will delete all the future recurring payments of that schedule.

DELETE /pay/v1/repeat-payments/{id}

Headers

Content-Typestring
Content type.Authorizationstring
Access token generated from create token request.

Attributes

payment_typestring
Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat payment.

fixed_schedule
variable_schedule

recurring_idinteger (optional)
Recurring id is need to be passed to delete a specific recurring event of Fixed and Variable schedule payment.

Request

Code Block

DELETE https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments/{id} HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{   "payment_date": "2024-02-23",
        "reference": "Payment 1"
        "processed_amount": 20.02,
        "is_processed": true,
        "status": "captured"
        "xref": "eygh...."
      },
      {
        "recurring_id": 2,
        "payment_date": "2024-02-24",
        "reference": "Payment 2"
        "processed_amount": 20.02,
        "is_processed": false,
        "status": "pending"
        "xref": "eygh...."
      },
      {
        "recurring_id": 3,
        "payment_typedate": "fixed_schedule2024-02-25",
        "recurring_idreference": 123
}

Response

Code Block
HTTP/1.1 200 OK Content-Type: application/json {"Payment 3" "processed_amount": 20.02, "successis_processed": truefalse, "messagestatus": "Deleted successfully" }

Anchorcancel-repeat-paymentcancel-repeat-paymentRefund a processed payment

Refund any processed repeat payment using repeat schedule id and recurring id.
In this scenario, id (repeat schedule id) need to be passed in request url along with recurring_id and payment_type in request body.

This request can be used to refund a processed payment that has a captured or completed status

removed"
        "xref": "eygh...."
      }
}

Anchor
Delete-a-scheduled-payment/Cancel-all-remaining-payments
Delete-a-scheduled-payment/Cancel-all-remaining-payments

Delete a scheduled payment/Cancel all remaining payments

This can be used:

To delete a schedule and all its remaining payments that havent been processed yet, using just the main schedule id
To delete a specific future payment from a schedule, using the id and the recurring_id

The schedule id and recurring_id can be fetched from get repeat payment request.

This will delete the future payment from both fixed and variable schedules.

DELETE /pay/v1/repeat-payments/cancel/{id}

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Attributes

payment_typestring
Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat payment.

fixed_schedule
variable_schedule

recurring_idinteger (optional)
Recurring id needs is need to be passed to refund delete a specific payment from a Fixed or recurring event of Fixed and Variable schedule payment.

Request

Code Block

DELETE https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments/cancel/{id} HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
    "payment_type": "fixed_schedule",
    "recurring_id": 123
}

Response

Code Block
HTTP/1.1 200 OK Content-Type: application/json { "success": true, "message": "CancelledDeleted successfully" }

Anchor

retry

cancel-repeat-payment

retry

cancel-repeat-payment

Retry

Refund a processed payment

that failed

Retry Refund 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.
This will run the payment for both fixed and variable schedulesprocessed repeat payment using repeat schedule id and recurring id.

In this scenario, the `recurring_id` (fetched from get repeat payment requestrepeat schedule id) needs to be passed along in the request url, with the `id` (repeat schedule id) in request url.
POST `recurring_id` and `payment_type` in the request body.
This request can be used to refund a processed payment that has a `captured` or `completed` status
DELETE /pay/v1/repeat-payments/retrycancel/{id}
Headers
Content-Typestring
Content type.
Authorizationstring
Access token generated from create token request.
Attributes
payment_typestring
Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat payment.
fixed_schedule
variable_schedule
recurring_idinteger
Recurring id needs to be passed to retry refund a specific payment from a Fixed or Variable schedule.

Request

Code Block

POSTDELETE https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments/retrycancel/{id} HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
    "payment_type": "fixed_schedule",
    "recurring_id": 123
}

Response

Code Block
HTTP/1.1 200 OK Content-Type: application/json { "success": true, "message": "Payment retriedCancelled successfully" }

Anchor

card

retry-repeat-payment

card

retry-repeat-payment

Add a new cardUpdate the card being used for any specific repeat schedule.
The new card details will be used to action all the future payments of that schedule

Retry a processed payment that failed

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.

This will run the payment for both fixed and variable schedules.
In this scenario, the paymentToken need recurring_id (fetched from get repeat payment request) needs to be passed in the body, along with the id (repeat schedule id) in the request url. (Payment token should be fetched in same way by populating a hosted payment page using ccElement from Create intent request)

POST/pay/v1/repeat-payments/cardretry/{id}

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Attributes

payment_typestring
Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat payment.

fixed_schedule
variable_schedule

paymentTokenstring
Payment token is need recurring_idinteger
Recurring id needs to be passed to add any new card for Fixed and retry a specific payment from a Fixed or Variable schedule.

Request

Code Block

POST https://secure.blinkpayment.co.uk/api/pay/v1/repeat-payments/cardretry/{id} HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
    "payment_type": "fixed_schedule",
    "paymentTokenrecurring_id": "ey............."123
}

Response

Code Block
HTTP/1.1 200 OK Content-Type: application/json { "success": true, "message": "CardPayment retried updatedsuccessfully" }

Versions Compared

Old Version 13

New Version Current

Key

Anchor
moto-repeat-payments
moto-repeat-payments

Create Repeat Payment

using MOTO

Anchor
ecom-repeat-payments
ecom-repeat-payments

Create Repeat Payment Using ECOM

Anchor
get-all-repeat-payments
get-all-repeat-payments

Get all repeat payments

Anchor
get-repeat-payment
get-repeat-payment

Get repeat payment

Anchor
Delete-a-scheduled-payment/Cancel-all-remaining-payments
Delete-a-scheduled-payment/Cancel-all-remaining-payments

Delete a scheduled payment/Cancel all remaining payments

Anchor

cancel-repeat-payment

cancel-repeat-payment

Refund a processed payment

Anchor

retry-repeat-payment

retry-repeat-payment

Retry a processed payment that failed

Page Comparison

Versions Compared

Old Version 13

New Version Current

Key

Anchormoto-repeat-paymentsmoto-repeat-paymentsCreate Repeat Payment

using MOTO

Anchorecom-repeat-paymentsecom-repeat-paymentsCreate Repeat Payment Using ECOM

Anchorget-all-repeat-paymentsget-all-repeat-paymentsGet all repeat payments

Anchorget-repeat-paymentget-repeat-paymentGet repeat payment

AnchorDelete-a-scheduled-payment/Cancel-all-remaining-paymentsDelete-a-scheduled-payment/Cancel-all-remaining-paymentsDelete a scheduled payment/Cancel all remaining payments

Anchor

cancel-repeat-payment

cancel-repeat-payment

Refund a processed payment

Anchor

retry-repeat-payment

retry-repeat-payment

Retry a processed payment that failed

Anchor
moto-repeat-payments
moto-repeat-payments

Create Repeat Payment

Anchor
ecom-repeat-payments
ecom-repeat-payments

Create Repeat Payment Using ECOM

Anchor
get-all-repeat-payments
get-all-repeat-payments

Get all repeat payments

Anchor
get-repeat-payment
get-repeat-payment

Get repeat payment

Anchor
Delete-a-scheduled-payment/Cancel-all-remaining-payments
Delete-a-scheduled-payment/Cancel-all-remaining-payments

Delete a scheduled payment/Cancel all remaining payments