header

Magento 1.x Software Support Notice

For Magento Commerce 1, Magento is providing software support through June 2020. Depending on your Magento Commerce 1 version, software support may include both quality fixes and security patches. Please review our Magento Software Lifecycle Policy to see how your version of Magento Commerce 1 is supported.

For Magento Open Source 1.5 to 1.9, Magento is providing software security patches through June 2020 to ensure those sites remain secure and compliant. Visit our information page for more details about our software maintenance policy and other considerations for your business.

Payment List

Edit this page on GitHub

Mage_Checkout

Module: Shopping Cart API

Resource: cart_payment

Method:

Allows you to retrieve a list of available payment methods for a shopping cart (quote).

Arguments:

Type Name Description
string sessionId Session ID
int quoteId
Shopping cart ID
string store
Store view ID or code (optional)

Return:

Type Name Description
array result Array of shoppingCartPaymentMethodResponseEntity

The shoppingCartPaymentMethodResponseEntity content is as follows:

Type Name Description
string code
Payment method code
string title
Payment method title
associativeArray cc_types
Array of credit card types

Examples

Request Example SOAP V1
$client = new SoapClient('http://magentohost/api/soap/?wsdl');

// If somestuff requires api authentication,
// then get a session token
$session = $client->login('apiUser', 'apiKey');

$result = $client->call($session, 'cart_payment.list', 'quoteId');
var_dump($result);
Response Example SOAP V1
array
  0 =>
    array
      'code' => string 'checkmo' (length=7)
      'title' => string 'Check / Money order' (length=19)
      'ccTypes' => null
  1 =>
    array
      'code' => string 'ccsave' (length=6)
      'title' => string 'Credit Card (saved)' (length=19)
      'ccTypes' =>
        array
          'AE' => string 'American Express' (length=16)
          'VI' => string 'Visa' (length=4)
          'MC' => string 'MasterCard' (length=10)
          'DI' => string 'Discover' (length=8)
Create the Magento file system owner