• By admin
  • January 25, 2024

ENHANCEMENT IN API & DASHBOARD

ENHANCEMENT IN API & DASHBOARD

150 150 admin

The following adjustments in the API are pertinent if you initiate subsequent transactions on Apple Pay transactions from your system using the remote API or the Telr merchant dashboard.

 

ENDPOINT ORDER.JSON

The existing API details can be accessed at https://docs.telr.com/reference/repeat-billing

New parameters are highlighted as below:

“repeat”: {

“auto”: false,

“type”: “recurring”,

“amount”: “100.00”,

“interval”: 1,

“period”: “M”,

“start”: “10082023”

}

 

New parameter:

Data field for json Data field for form Description Remarks
auto repeat_auto

Indicates whether the subsequent transaction is initiated by merchant or auto charged by system.

 

Datatype: Boolean, default value is true if auto is not passed in repeat object.

 

Value: “true” denotes that Telr system will charge the customer automatically in the given interval.

Value: “false” denotes that merchant will initiate the subsequent transaction.

 

This field is required to indicate that this transaction may be used for subsequent authorization.

 

 

type repeat_type

Indicate the type of subsequent authorisation.

Values:

·         “unscheduled”

·         “recurring”

If auto is passed as “false” then “type” must be passed.

This field is required to indicate that this transaction may be used for subsequent authorization
amount repeat_amount Refer: https://docs.telr.com/reference/repeat-billing
interval repeat_interval Refer: https://docs.telr.com/reference/repeat-billing
period repeat_period Refer: https://docs.telr.com/reference/repeat-billing
start repeat_start Refer: https://docs.telr.com/reference/repeat-billing

 

 

USE CASES

Merchants utilizing Apple Pay transactions for subsequent payment authorizations, whether initiated from the merchant’s system or manually through the Telr dashboard.

  1. Scheduled interval:

“repeat”: {

“auto”: false,

“type”: “recurring”,

“amount”: “100.00”,

“interval”: 1,

“period”: “M”,

“start”: “10022024”

},

If the “type” is “recurring” then remaining parameters like amount, interval, period, start should be passed.

2. Unscheduled interval:

“repeat”: {

“auto”: false,

“type”: “unscheduled”

},

If the “type” is “unscheduled” then remaining parameters like amount, interval, period, start are ignored.

 

ENDPOINT MOBILE.XML

The existing API details can be accessed at https://docs.telr.com/reference/xml-request-layout

New parameters are highlighted as below:

<repeat>

<auto>false</auto>

<type>recurring</type>

<amount></amount>

<interval></interval>

<period></period>

<start></start>

</repeat>

Maintain order of repeat object as per the existing api documentation link.

The explanation of the parameter & USE CASE remains consistent with the order.json API

Note: “Applepay will display this billing information to customer depending upon the values passed in the repeat block”

 

ENDPOINT API QUICKLINK.JSON

The existing API details can be accessed at https://docs.telr.com/reference/create-quicklink

New parameters are highlighted as below:

“RepeatBilling”: {

“auto”: false,

“type”: “recurring”,

“amount”: “100.00”,

“interval”: 1,

“period”: “M”,

“start”: “03”

}

The explanation of the parameter & USE CASE remains consistent with the order.json API

 

ENDPOINT API QUICKLINK LIST.JSON

New parameter will be added in the existing quiclinklist api response:

{

“QuickLinkListResponse”: {

“Code”: 200,

“Status”: “Success”,

“QlList”: [

{

“store”: <storeid>,

“id”: 801734,

“ref”: “TelrDev_801734”,

“desc”: “test desc”,

“cart”: “123456”,

“currency”: “AED”,

“amount”: 100,

“status”: -2,

“added_by”: 35030,

“added_on”: “2024-01-29”,

“updated_by”: 35030,

“updated_on”: “2024-01-29”,

“image1”: “None”,

“layout”: 0,

“use_stock”: 0,

“stock_count”: 0,

“use_repeat”: 0,

“repeat_type”: “”,

“repeat_period”: “M”,

“repeat_interval”: 0,

“repeat_day”: 0,

“repeat_count”: 0,

“repeat_amount”: 0,

“repeat_final”: 0,

“repeat_method”: 0,

“donation_mode”: 0,

“min_qty”: 1,

“max_qty”: 1,

“fullname”: “Test User”,

“addr1”: “DSO”,

“city”: “DSO”,

“country”: “AE”,

“email”: “[email protected]”,

“phone”: “0528585858”,

“url”: “https://secure.telr.com/gateway/ql/xxxxx”

}

]

}

}

 

ENDPOINT INVOICE_CREATE.XML

The existing API details can be accessed at https://docs.telr.com/reference/remote-creation-of-invoices

New parameters are highlighted as below:

<currency> </currency>

<amount> </amount>

<repeat>

<type>unscheduled</type>

</repeat>

..

Only “type” is newly added in invoice_create.xml.

Supported value is “unscheduled”.

QUICLINK IN MERCHANT DASHBOARD:

 

 

INVOICING IN MERCHANT DASHBOARD:

 

MOBILE SDK:

SDK will be updated in below repositories as per the date mentioned in mail.

https://github.com/Telr-PG/telr-sdk-flutter-webview

https://github.com/Telr-PG/telr-sdk-react-native

https://github.com/Telr-PG/telr-sdk-ios

 

PLUGINS:

Plugins will be updated in below repositories as per the date mentioned in mail.

https://github.com/Telr-PG/telr-plugin-woocommerce

Leave a Reply