Payment Methods

This GET endpoint gets the payment methods activated in your application.

The publicKey is passed in the header and currencyType can either be FIAT or CRYPTO which is passed as a query and this returns name, isEnabled, methodReference, paymentType and currencyType. See below for an example;

Gets the available payment methods.

GET https://checkout-api-sandbox.xendbridge.com/api/ThirdPartyUI/PaymentMethods

Query Parameters

Name	Type	Description
currencyType*	string	{FIAT, CRYPTO}

Headers

Name	Type	Description
publicKey*	string	{publicKey}

200: OK Success - FIAT

{
    "data": [
        {
            "name": "Mpesa",
            "isEnabled": true,
            "methodReference": "438C732A4353481DA61963C0F25C0235",
            "method": "Mpesa",
            "paymentType": "MobileMoney",
            "currencyType": "FIAT"
        },
        {
            "name": "Momo",
            "isEnabled": true,
            "methodReference": "96668EDB4617427EB58C0D51F5144AA6",
            "method": "Momo",
            "paymentType": "MobileMoney",
            "currencyType": "FIAT"
        },
        {
            "name": "Chipper Cash",
            "isEnabled": true,
            "methodReference": "AA1AF5E3A3904BE69D12FDEAB11B03C5",
            "method": "ChipperCash",
            "paymentType": "Fintech",
            "currencyType": "FIAT"
        },
        {
            "name": "Bank Transfer",
            "isEnabled": true,
            "methodReference": "DC5305D4EBB34719A503AB4DA689B216",
            "method": "Bank",
            "paymentType": "Bank",
            "currencyType": "FIAT"
        }
    ],
    "status": "OK",
    "message": ""
}

200: OK Success - CRYPTO

{
    "data": [
        {
            "name": "Cryptocurrency",
            "isEnabled": true,
            "methodReference": "D38B6A22292C4DB596FF9615DF432779",
            "method": "Crypto",
            "paymentType": "Crypto",
            "currencyType": "CRYPTO"
        }
    ],
    "status": "OK",
    "message": ""
}

Request Fields

Parameters	Type	Definitions
publicKey	string	Required This is the key generated upon creation of an application.
currencyType	string	Required This is the currency type being either FIAT or CRYPTO

Response Fields

name	string	This is the name of the payment method.
isEnabled	bool	This is status of the payment method.
methodReference	string	This is the reference number of the payment method.
method	enum	This is the method type.
paymentType	enum	This is the payment type.
currencyType	enum	This is the currency type.