Payment Options Inquiry
You can retrieve information about the various payment options configured for your merchant account using the PAYMENT OPTIONS INQUIRY operation. For more information about the use cases, you can implement with the operation, see Payment Options Inquiries.
Ensure to determine carefully, what to define in your request and how to interpret the response, paying attention to the following consequences.
- If you do not supply any request parameters for the PAYMENT OPTIONS INQUIRY request, the response contains all possible payment option fields.
This means that the response can inadvertently include some invalid payment option combinations. - If you want to restrict returned options, you must define the restrictions in the request body fields. The following section provides details on the request fields you can use to customize your inquiry in different ways.
- If you supply one or more request parameters, the response contains all combinations of payment option field values restricted by the request parameter values.
- If the value passed in the request is invalid due to incorrect spelling or format, an invalid request error is returned.
For example, if the card type is spelled as AMX instead of AMEX, an invalid request error is returned for card.type. - If a payment option is enabled on the ANZ eGate payment gateway but not on your merchant configuration, the result combination can be invalid.
For example, if you want to offer custom payment plans to your payers, and both USD and MXN are your supported currencies, the result shows both payment plans and USD as the currency.
However, you need to realize that it is not a valid combination to offer a USD payment plan, as custom payment plans only support MXN as the currency.
To send a PAYMENT OPTIONS INQUIRY request without any request fields, use the following details.
| URL | https://anzworldline.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/paymentOptionsInquiry |
| HTTP Method | POST |
For examples of the possible requests, download the Postman collection.
Customizing the inquiry
When retrieving general payment options, include the one or more of the following fields in your request, depending on the type of information you want to receive.
order.currency- If you want the returned options to apply to specific currencies only, define the relevant currency, for example USD or AUD, in the request.
If you want the response to cover all currencies available to you, omit this field.paymentType- If you want the returned options to apply to specific payment methods only, define the relevant method, for example, CREDIT or PAYPAL, in the request.
If you want the response to cover all methods available to you, omit this field.sourceOfFunds.provided.card.prefix- If you want the returned options to apply to specific card types only or to check the details that apply to the payer’s card, for example, to make surcharging decisions, define the card number prefix in the request.
If you want the response to cover all card types available to you, omit this field.transactionSource- If you want the returned options to apply to specific transaction sources only, define the relevant source, for example INTERNET or CALL_CENTRE, in the request.
If you want the response to cover all transaction sources available to you, omit this field.
If you are enabled for Dynamic Currency Conversion (DCC), you can receive a rate quote from the gateway as a response to the PAYMENT OPTIONS INQUIRY operation. The response includes the exchange rate, and payer currency and amount.
For a DCC rate quote, include the following fields in the request.
order.currency- Currency the payer wants to use.order.amount- Amount of the order in your own currency.sourceOfFunds.provided.card.prefix- Prefix of the payer’s card number.
For more details on using DCC, see Dynamic Currency Conversion.