Notify Mastercard when a consumer chooses a previously presented offer, which is henceforth called as an Installment Plan.

POST {{baseUrl}}/plans

When a cardholder chooses one of the installment offers previously shown through the Offer Presentment API, customers need to send the details of the selected offer, including the PAN, transaction information, merchant details, and offer specifics, without any changes. Mastercard then validates this data against the presented offer to ensure its integrity and provides a success or failure response If the API processing is successful, it returns an HTTP status code of 201, a status of CREATED, and a unique Plan Identifier. In this scenario, customers can inform the cardholder that the installment offer has been processed successfully. However, if the API processing fails for some reason, it returns a corresponding HTTP status code and the customer should inform the cardholder about the failure in paying with installments. - 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

{"merchant"=>{"country"=>"USA", "mcc"=>1711, "merchantId"=>1234856, "url"=>"https://www.globexdecor.com", "acquirerId"=>856478}, "offerId"=>"24092019", "planInstallmentInformation"=>{"apr"=>0, "currency"=>"USD", "frequency"=>"BIWEEKLY", "firstInstallmentAmount"=>66.67, "otherInstallmentAmount"=>66.67, "feeValue"=>0, "tenure"=>6, "totalAmount"=>400}, "providerId"=>"218b9962-1355-44e4-8a16-f911363fd849", "schedulePayments"=>[{"installmentAmount"=>66.67, "dueDate"=>"2023-05-30", "installmentNumber"=>1}, {"installmentAmount"=>66.67, "dueDate"=>"2023-06-13", "installmentNumber"=>2}, {"installmentAmount"=>66.67, "dueDate"=>"2023-06-27", "installmentNumber"=>3}, {"installmentAmount"=>66.67, "dueDate"=>"2023-07-11", "installmentNumber"=>4}, {"installmentAmount"=>66.67, "dueDate"=>"2023-07-25", "installmentNumber"=>5}, {"installmentAmount"=>66.67, "dueDate"=>"2023-08-08", "installmentNumber"=>6}], "transaction"=>{"amountType"=>"PURCHASE", "amount"=>400, "currency"=>"USD", "stan"=>123456, "rrn"=>123456123456, "authorizationCode"=>123456, "localDateTime"=>"2023-01-01T00:00:00Z", "transmissionDateTime"=>"2023-01-01T00:00:00Z", "transactionLinkId"=>"1234567890"}, "sensitiveData"=>{"merchant"=>{"name"=>"Globex Decor"}, "consumer"=>{"primaryAccountNumber"=>5110921032063789}}}

HEADERS

RESPONSES

status: Created

{"planId":"3d56f5a7-db48-41f0-875e-30920e8465f3","status":"CREATED"}