Plan Offers Inquiry
Request to retrieve a set of payment plan offers for a payment plan so that they can be presented to the cardholder. After the cardholder has selected one of the payment plan offers, the merchant requests a Pay or Authorize transaction that includes the number of payments selected by the cardholder. The Plan Offers Inquiry operation is applicable to AMEX_PlanAmex plan type only, where the merchant is paid in full less applicable discount rate; and the cardholder is billed in installments plus the applicable interest rate. It is used for Plan Amex transactions in Brazil to satisfy statutory requirements where the merchant must provide the cardholder with information about the amount of interest charged
URL | https://egenius.unicredit.ro/api/rest/version/66/merchant/{merchantId}/paymentPlan/{planId} |
HTTP Method | PUT |
Authentication |
This operation requires authentication via one of the following methods:
|
Request Parameters
apiOperation String =PLAN_OFFERS_INQUIRY FIXED
order = COMPULSORY
order.amount Decimal = COMPULSORY
The value of this field in the response is zero if payer funds are not transferred.
order.currency Upper case alphabetic text = COMPULSORY
paymentPlan.numberOfPayments Digits = COMPULSORY
apiOperation String =PLAN_OFFERS_INQUIRY FIXED
correlationId String = OPTIONAL
externalTokenProvider = OPTIONAL
externalTokenProvider.customData String = OPTIONAL
order = COMPULSORY
order.amount Decimal = COMPULSORY
The value of this field in the response is zero if payer funds are not transferred.
order.currency Upper case alphabetic text = COMPULSORY
paymentPlan.numberOfPayments Digits = COMPULSORY
responseControls = OPTIONAL
responseControls.sensitiveData String = OPTIONAL
session.id ASCII Text = OPTIONAL
session.version ASCII Text = OPTIONAL
To use optimistic locking, record session.version when you make your decisions, and then pass that value in session.version when you submit your request operation to the gateway.
If session.version provided by you does not match that stored against the session, the gateway will reject the operation with error.cause=INVALID_REQUEST.
See Making Business Decisions Based on Session Content.
sourceOfFunds = COMPULSORY
sourceOfFunds.provided = OPTIONAL
sourceOfFunds.provided.card = OPTIONAL
sourceOfFunds.provided.card.expiry = OPTIONAL
sourceOfFunds.provided.card.expiry.month Digits = COMPULSORY
sourceOfFunds.provided.card.expiry.year Digits = COMPULSORY
sourceOfFunds.provided.card.number Digits = OPTIONAL
sourceOfFunds.provided.card.securityCode Digits = OPTIONAL
sourceOfFunds.token Alphanumeric = OPTIONAL
{merchantId} Alphanumeric + additional characters COMPULSORY
{planId} String COMPULSORY
Response Parameters
order = Always Provided
order.amount Decimal = Always Provided
The value of this field in the response is zero if payer funds are not transferred.
order.currency Upper case alphabetic text = Always Provided
paymentPlan = Always Provided
paymentPlan.planId String = Always Provided
paymentPlan.planOffer[n] = Always Provided
paymentPlan.planOffer[n].finalAmount Decimal = Always Provided
paymentPlan.planOffer[n].numberOfPayments Integer = Always Provided
paymentPlan.planOffer[n].paymentAmount Decimal = Always Provided
response.gatewayCode Enumeration = Always Provided
result Enumeration = Always Provided
sourceOfFunds = Always Provided
sourceOfFunds.provided = Always Provided
sourceOfFunds.provided.card = Always Provided
sourceOfFunds.provided.card.number Masked digits = Always Provided
correlationId String = CONDITIONAL
order = Always Provided
order.amount Decimal = Always Provided
The value of this field in the response is zero if payer funds are not transferred.