Performs installments eligibility and returns a list of eligible offers.

POST {{baseUrl}}/offers

This endpoint allows customers to find eligible installment offers. It takes Primary Account Number (PAN), merchant information, and transaction information as input, performs installment eligibility, and returns a list of matching offers in response. If eligible offers are found, the API returns the details of each offer including tenure, interest rates, fees, terms and conditions, and a detailed loan repayment schedule etc., which can be presented to cardholders. If no eligible offers match the request criteria, the API response won’t include any offers. - This endpoint requires partial request payload encryption to encrypt sensitive data, merchant name and consumer’s primary account number as part of ‘sensitiveData’ field. Please refer to request specification for more details. The encryption needs to be performed using JWE payload encryption. Please refer to the Securing Sensitive Data Using Payload Encryption sections for implementation details.

Request Body

{"transaction"=>{"amount"=>400, "currency"=>"USD", "localDateTime"=>"2023-10-26T00:00:00Z"}, "merchant"=>{"country"=>"USA", "mcc"=>"1711", "url"=>"www.globexdecor.com", "acquirerId"=>"234353", "merchantId"=>"121234"}, "sensitiveData"=>{"merchant"=>{"name"=>"Globex Decor"}, "consumer"=>{"primaryAccountNumber"=>"5110921032063789"}}}

HEADERS

RESPONSES

status: OK

{"total":2,"offerTransactionId":"1763137029152964608","offers":[{"priority":1,"offerId":"21345693","offerType":"CARDED_OFFER","currencySymbol":"$","apr":0,"tenure":6,"frequency":"BIWEEKLY","interestRate":0,"firstInstallmentSchedule":"TRANSACTION_DATE","totalAmount":400,"firstInstallmentAmount":66.67,"otherInstallmentAmount":66.67,"feeType":"NO_FEES","feeValue":0,"feeDistribution":"FRST_INSTL","offerBeginDatetime":"2021-12-31T19:00:00-05:00","offerEndDatetime":"2024-08-30T19:59:59-04:00","provider":{"providerId":"29694e7a-b4a8-11ec-b909-0242ac120002","cid":244426,"providerName":"Mastercard - Operations \u0026 Technology - BizOps","providerLogoUrl":"https://mtf.installments.mastercard.com/mtf/Mast_2d5f306e-78d3-483a-a5c9-8343171e75de.png","disclosure":"Offer only qualify for a payment as low as $50.00 up to $600.00."},"schedulePayments":[{"installmentNumber":1,"installmentAmount":66.67,"dueDate":"2023-10-26"},{"installmentNumber":2,"installmentAmount":66.67,"dueDate":"2023-11-09"},{"installmentNumber":3,"installmentAmount":66.67,"dueDate":"2023-11-23"},{"installmentNumber":4,"installmentAmount":66.67,"dueDate":"2023-12-07"},{"installmentNumber":5,"installmentAmount":66.67,"dueDate":"2023-12-21"},{"installmentNumber":6,"installmentAmount":66.67,"dueDate":"2024-01-04"}]},{"priority":2,"offerId":"21351677","offerType":"CARDED_OFFER","currencySymbol":"$","apr":101.52,"tenure":4,"frequency":"WEEKLY","interestRate":11.2,"firstInstallmentSchedule":"TRANSACTION_DATE","totalAmount":411.38,"firstInstallmentAmount":110.42,"otherInstallmentAmount":100.32,"feeType":"FIXED_AMT","feeValue":10.1,"feeDistribution":"FRST_INSTL","offerBeginDatetime":"2023-01-01T00:00:00-05:00","offerEndDatetime":"2025-12-31T23:59:59-05:00","provider":{"providerId":"29694e7a-b4a8-11ec-b909-0242ac120002","cid":244425,"providerName":"Mastercard - Operations \u0026 Technology - BizOps","providerLogoUrl":"https://mtf.installments.mastercard.com/mtf/Mast_2d5f306e-78d3-483a-a5c9-8343171e75de.png","disclosure":"Offer only qualify for a payment as low as $50.00 up to $600.00."},"schedulePayments":[{"installmentNumber":1,"installmentAmount":110.42,"dueDate":"2023-10-26"},{"installmentNumber":2,"installmentAmount":100.32,"dueDate":"2023-11-02"},{"installmentNumber":3,"installmentAmount":100.32,"dueDate":"2023-11-09"},{"installmentNumber":4,"installmentAmount":100.32,"dueDate":"2023-11-16"}]}]}