Payment Plan Offers Inquiry

Request to retrieve available payment plan offers for an order, based on the credit or debit card details, order amount, order currency and items included in the order. You can request all available offers or only offers for a specified payment plan product. If the payer has selected an offer you have presented to them, submit an Authorize or Pay request that identifies this offer.

POST https://anzegate.gateway.mastercard.com/api/rest/version/65 / merchant / {merchantId} / paymentPlanOffersInquiry

Authentication

This operation requires authentication via one of the following methods:


  • Certificate authentication.
  • Basic HTTP authentication as described at w3.org. Provide 'merchant.<your gateway merchant ID>' in the userid portion and your API password in the password portion.

Request

URL Parameters

{merchantId} Alphanumeric + additional characters REQUIRED

The unique identifier issued to you by your payment provider.


This identifier can be up to 12 characters in length.


Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 40

Fields

apiOperation String = PAYMENT_PLAN_OFFERS_INQUIRY FIXED

Any sequence of zero or more unicode characters.

correlationId String OPTIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100
session.id ASCII Text OPTIONAL

Identifier of the payment session containing values for any of the request fields to be used in this operation.

Values provided in the request will override values contained in the session.

Data consists of ASCII characters

Min length: 31 Max length: 35
session.version ASCII Text OPTIONAL

Use this field to implement optimistic locking of the session content.

Do this if you make business decisions based on data from the session and wish to ensure that the same data is being used for the request operation.

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.

Data consists of ASCII characters

Min length: 10 Max length: 10

Response

Fields

paymentPlanOffer CONDITIONAL

Details about the payment plan offers available for this order.

paymentPlanOffer.{id} Alphanumeric + additional characters CONDITIONAL

The unique identifier for the payment plan offer.

Data may consist of the characters 0-9, a-z, A-Z, '-'

Min length: 1 Max length: 60
paymentPlanOffer.{id}.feeAmount Decimal CONDITIONAL

The interest rate applicable for this payment plan offer.

Data is a decimal number.

Max value: 1000000000000 Min value: 0 Max post-decimal digits: 3
paymentPlanOffer.{id}.firstPaymentAmount Decimal CONDITIONAL

The amount of the first payment for this payment plan offer.

The amount for all subsequent payments is provided in paymentPlanOffer{id}.subsequentPaymentAmount.

Data is a decimal number.

Max value: 1000000000000 Min value: 0 Max post-decimal digits: 3
paymentPlanOffer.{id}.interestDiscountAmount Decimal CONDITIONAL

The discount that will be applied to the interest amount the payer is charged for this payment plan offer.

Data is a decimal number.

Max value: 1000000000000 Min value: 0 Max post-decimal digits: 3
paymentPlanOffer.{id}.interestRate Decimal CONDITIONAL

The interest rate applicable for this payment plan offer.

Data is a decimal number.

Max value: 1000000000000 Min value: 0 Max post-decimal digits: 3
paymentPlanOffer.{id}.name String CONDITIONAL

The name of the payment plan offer.

You can use this name to display the offer to the payer and distinguish this offer from other offers for the same payment plan product.

Data can consist of any characters

Min length: 1 Max length: 40
paymentPlanOffer.{id}.numberOfPayments Integer CONDITIONAL

The number of monthly payments payable by the cardholder.

JSON number data type, restricted to being positive or zero. In addition, the represented number may have no fractional part.

Min value: 1 Max value: 99
paymentPlanOffer.{id}.paymentPlanProductName String CONDITIONAL

The name of the payment plan product for which the offer is provided.

Data can consist of any characters

Min length: 1 Max length: 40
paymentPlanOffer.{id}.reclaim.amount Decimal CONDITIONAL

Reclaim amount

Data is a decimal number.

Max value: 1000000000000 Min value: 0 Max post-decimal digits: 3
paymentPlanOffer.{id}.reclaim.payerInstructionText String CONDITIONAL

Reclaim Payer Instruction Text

Data can consist of any characters

Min length: 1 Max length: 1000
paymentPlanOffer.{id}.subsequentPaymentAmount Decimal CONDITIONAL

The amount of each payment for this payment plan offer.

If the amount for the first payment differs, then the amount for the first payment is provided in paymentPlanOffer{id}.firstPaymentAmount. The amount is expressed as a decimal number in the units of the currency. For example 12.34 in USD is the amount 12 dollars and 34 cents

Data is a decimal number.

Max value: 1000000000000 Min value: 0 Max post-decimal digits: 3
paymentPlanOffer.{id}.termsAndConditions.acceptanceText String CONDITIONAL

Terms And Conditions Text

Data can consist of any characters

Min length: 1 Max length: 1000
paymentPlanOffer.{id}.termsAndConditions.text String CONDITIONAL

Terms And Conditions Text

Data can consist of any characters

Min length: 1 Max length: 1000
paymentPlanOffer.{id}.totalAmount Decimal CONDITIONAL

The total amount payable by the payer, including interest and any fees for this payment plan offer.

This amount does not include the reclaim amount. The amount is expressed as a decimal number in the units of the currency. For example 12.34 in USD is the amount 12 dollars and 34 cents

Data is a decimal number.

Max value: 1000000000000 Min value: 0 Max post-decimal digits: 3
rejectReasonText String CONDITIONAL

Only provided if the payment plan service provider has previously provided an SKU offer (via the Shopping Options Inquiry) and the current order contains this SKU and the offer is no longer available.

This may happen if the payer has since made use of this SKU offer for another purchase. If the field is provided, you must display this text to the payer. If this field is present the response will not contain any payment plan offers.

Data can consist of any characters

Min length: 1 Max length: 1000
result Enumeration ALWAYS PROVIDED

A system-generated high level overall result of the operation.

Value must be a member of the following list. The values are case sensitive.

FAILURE

The operation was declined or rejected by the gateway, acquirer or issuer

PENDING

The operation is currently in progress or pending processing

SUCCESS

The operation was successfully processed

UNKNOWN

The result of the operation is unknown

Errors

error

Information on possible error conditions that may occur while processing an operation using the API.

error.cause Enumeration

Broadly categorizes the cause of the error.

For example, errors may occur due to invalid requests or internal system failures.

Value must be a member of the following list. The values are case sensitive.

INVALID_REQUEST

The request was rejected because it did not conform to the API protocol.

REQUEST_REJECTED

The request was rejected due to security reasons such as firewall rules, expired certificate, etc.

SERVER_BUSY

The server did not have enough resources to process the request at the moment.

SERVER_FAILED

There was an internal system failure.

error.explanation String

Textual description of the error based on the cause.

This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.

Data can consist of any characters

Min length: 1 Max length: 1000
error.field String

Indicates the name of the field that failed validation.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Data can consist of any characters

Min length: 1 Max length: 100
error.supportCode String

Indicates the code that helps the support team to quickly identify the exact cause of the error.

This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.

Data can consist of any characters

Min length: 1 Max length: 100
error.validationType Enumeration

Indicates the type of field validation error.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Value must be a member of the following list. The values are case sensitive.

INVALID

The request contained a field with a value that did not pass validation.

MISSING

The request was missing a mandatory field.

UNSUPPORTED

The request contained a field that is unsupported.

result Enumeration

A system-generated high level overall result of the operation.

Value must be a member of the following list. The values are case sensitive.

ERROR

The operation resulted in an error and hence cannot be processed.