Cashflows Gateway API

Retrieving details of supported payments

When your website is integrated with our gateway, shoppers see a section in the checkout page where they can choose how they want to pay, for example by card or an alternative method that they prefer such as Apple Pay, Google Pay or PayPal.

Picture

Our gateway API includes a call that you can use to retrieve all of the payment methods that the gateway supports and present them for selection in your website. With a single API call you can automatically retrieve the full list of payment methods, together with logos and icons, instead of having to hard code each one. By using this call and the response results, you can avoid extra work in the future. When we add new payment methods, they will automatically be added to the list of payment options available on your website.

Important: Before you can display any payment methods on a checkout page, you need to enable them in Cashflows Go.

How to retrieve details of supported payment methods

The API call to retrieve the payment methods is SupportedPaymentMethods. This call retrieves from the gateway all supported payment methods at once, including the logos and icons that represent each method, surcharges and so on.

You must encrypt the message with the API key that you collected from Cashflows Go. For information, see Collect your access credentials.

Example response

{

    "data": [

        {

            "paymentMethod": "Card",

            "logo": "https://gateway-int.cashflows.com/assets/payment-method-card.svg",

            "issuerList": [],

            "supportsTokenisation": true,

            "tokenizedCards": [],

            "currencies": [

                "NoCurrencyCashflows",

                "AUD",

                "CAD",

                "DKK",

                "HKD",

                "JPY",

                "NZD",

                "NOK",

                "SGD",

                "ZAR",

                "SEK",

                "CHF",

                "GBP",

                "USD",

                "EUR",

                "XXX"

            ],

            "description": "Card Simulator"

        },

        {

            "paymentMethod": "CreditCard",

            "logo": "https://gateway-int.cashflows.com/assets/payment-method-card.svg",

            "issuerList": [],

            "supportsTokenisation": true,

            "tokenizedCards": [],

            "currencies": [

                "NoCurrencyCashflows",

                "AUD",

                "CAD",

                "DKK",

                "HKD",

                "JPY",

                "NZD",

                "NOK",

                "SGD",

                "ZAR",

                "SEK",

                "CHF",

                "GBP",

                "USD",

                "EUR",

                "XXX"

            ],

            "description": "Card Simulator"

        }

    ]

}

Back to top