Logo GenukaGenuka Pay
Guides

Payment Methods

Save the mobile money numbers your payouts can be sent to.

A payment method is a mobile money number saved by your company. It acts as a payout recipient: instead of describing the recipient in every request, you pass its payment_method_id to POST /api/v1/payouts.

Managed from the dashboard only

Methods are created, edited and deleted from the Payment methods page of the dashboard. The /api/v1/payment-methods endpoints it uses only accept the dashboard session: they cannot be called with your API keys.

What You Can Do

  • add a mobile money number
  • edit the account holder, enable or disable a method
  • mark a method as primary
  • delete a method

Fields

FieldDescription
identifierMobile money number in international format, e.g. +237677001122
account_holder_nameAccount holder's name (150 characters max)
is_primaryThe company's primary method
is_activeWhether the method can be used
metadataFree-form data

You do not pick the operator: it is derived from the number, in your company's country, and the number is verified when saved. The method then reports the operator selected (operator_provider) and its verification status (verification_status).

Using It in a Payout

{
  "amount": 25000,
  "currency": "XAF",
  "payment_method_id": "01k7c4t9m2y8x5b3n6q0r1s2t3"
}

The payment_method_id must belong to your company; otherwise the request is rejected with a 422. No method is used by default: without payment_method_id, send recipient_phone and operator_code. See Payouts API.

Best Practices

  • Testing - Test each method with a small amount before heavy use
  • Monitoring - Disable a method whose number is no longer valid instead of letting it fail
  • Security - Restrict dashboard access to the people allowed to change recipients

How is this guide?

Last updated on