Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
Account Settings

Return Merchant payment methods

Use this endpoint to retrieve merchant payment method configuration, a.k.a which payment methods are enabled or disabled. Merchant account is create with default settings.

get/payment-methods/me

Query parameters

country_codestring

Filter payment methods by country code alph-2. If missing all payments methods are returned

Response

returns merchant settings.

idstring uuid

Unique Identifier of the payment method

namestring

name of the payment method

category'card' | 'mobile_money'

The category of the payment type

phoneNumberRequiredboolean

if set to true, phone number is required to make payment

otpGenerationInstructionstring

otp generation instruction. If empty or null, otp is not required

countriesstring

list of countries where the payment method is enabled

type'wave_money' | 'orange_money' | 'maxit' | 'mtn_money' | 'free_money' | 'moov' | 'mobicash' | 'togocell' | 'bictorys' | 'deposit' | 'card' | 'tokenized_card'

The type parameter allows to select the payout service provider. E.g mtn_money, orange_money, wave_money, move_money

enabledboolean

if true, this payment method is accepted by the merchant

transferEnabledboolean

if true, this payment method can be used by merchant to make transfer

Example response

[
  {
    "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
    "name": "orange_money",
    "otpGenerationInstruction": "Composer *144*4*6*montant# sur votre téléphone pour générer votre code OTP",
    "countries": "SN,CI",
    "enabled": true,
    "transferEnabled": true
  }
]