24/7 Support: 800.608.6482



This function allows you to load a list of available payment methods for a basket. The shipping address must already be known for this function to return results. This function requires you pass a Session_ID and Checkout_Session_ID and optional Customer Session ID if calling from an external system.

The Checkout_Session_ID should be passed if available. This indiciates that the customer is logged into their account when checking out and any saved payment cards will be available.

Request Body Parameters

Session_Type Type:
Session Type
This will alwsys be "runtime"
Session_ID Type:
Session ID
The Session ID of the basket
Checkout_Session_ID Type:
Checkout Session ID
Checkout Session ID. This is available once OCST (Bill To/Ship To) has been submitted
Customer_Session_ID Type:
Customer Session ID
Customer Session ID. This is available if the customer is currently logged in. Omitting this will cause any customer specific payment methods not to be returned

Response Parameters

success boolean value for if the request was successfull
module Code of the Payment Module
code Payment Method Code
name Payment Method Name
paymentmethod Concatenation for Module Code and Payment Method Code :. This is used in Order_Authorize to create a new payment authorization.
Content-Type for the request must be 'application/json'

Example Request

Example Response

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.


Copyright © 1997 – 2024 Miva®, Miva Merchant®, MivaPay®, MivaCon®, Camp Miva®, Miva Connect®, Miva, Inc. All Rights Reserved.