Skip to main content

Merchant Promotions

Merchant Promotions Request#

The merchant promotions api returns all active promotions for the related merchant ID. The api can be used for all integration types (ecommerce and instore).

Please contact your Latitude Financial Services representative for information related to promotions and renewals.


Authentication#

Please refer to Authentication.


API Endpoints#

Latitude's endpoints to obtain the Merchant's active promotions (GET)

Content-Type: application/json All requests are via HTTPS GET

No parameters are required in the body.

EnvironmentEndpoint
Test/Sandboxhttps://api.test.latitudefinancial.com/v1/applybuy-checkout-service/promotions?merchantId=(insert merchantID)
Productionhttps://api.latitudefinancial.com/v1/applybuy-checkout-service/promotions?merchantId=(insert merchantID)

Merchant Promotions Response#

Only active promotions are listed

Content-Type: application/json

KeyTypeExample
merchantIDstringT123344
promotions
object, see Promotions Map
object of (active) promotionssee example

Promotions Map (repeat for multiple promotions)#

KeyTypeExample
code
Note: promotion code
string2012
description
Note: promotion description
string12 Months Interest Free - Minimum Payments
minimumPurchase
Note: purchases over the minimum $ will qualify for the promotion
int250 represents $250
maximumPurchase
Note: purchaes under the maximum $ will qualify for the promotion
int20000 represents $20,000
validFrom
Note: the active period for the promotion
timestamp (UTC)2020-08-01T00:00:00Z
validTill
Note: the promotion's expiry. The promotion can only be applied to purchases during the promotion's active period
timestamp (UTC)2040-08-01T11:59:00Z

Sample Merchant Promotions response
{
"merchantID": "T123344",
"promotions": [
{
"code": "2012",
"description": "12 Months Interest Free - Minimum Payments",
"minimumPurchase": 200,
"maximumPurchase": 20000,
"validFrom": "2020-08-01T00:00:00Z",
"validTill": "2040-08-01T11:59:00Z"
},
{
"code": "2018",
"description": "18 Months Interest Free - Minimum Payments",
"minimumPurchase": 300,
"maximumPurchase": 20000,
"validFrom": "2020-08-01T00:00:00Z",
"validTill": "2040-08-01T11:59:00Z"
},
{
"code": "2006",
"description": "6 Months Interest Free - Minimum Payments",
"minimumPurchase": 150,
"maximumPurchase": 20000,
"validFrom": "2020-08-01T00:00:00Z",
"validTill": "2040-08-01T11:59:00Z"
}
]
}