Mobile money

Customers can use their Mobile Money account to make payments in their local currency. The API returns an instruction that guides customers through the payment process.

To create a Mobile Money collection, initiate a collection request with the payment method set to mobile_money:

curl --request POST \
     --url https://api.gravv.xyz/v1/collections \
     --header 'Api-Key: <Api Key>' \
     --header 'Idempotency-Key: order_789_attempt_1' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "amount": "50",
  "currency": "ETB",
  "country": "ET",
  "customer_id": "04dfb2e5-1274-4214-b5fd-3415fde7dc17",
  "client_customer_id": "checkers_user",
  "client_reference": "9d8184a1-4a19-b74d-4797-9896aed01332",
  "source": {
    "source_type": "external",
    "methods": [
      "mobile_money"
    ]
  },
  "destination": {
    "id": "bccb74d8-9715-478d-bcac-9d8184a19530",
    "destination_type": "internal_account"
    },
  "metadata": {
    "transaction_reference": "mobile_001"
  }
}
'

You will receive a response with an instruction field containing HTML-formatted steps for the payment. The field includes the USSD code to dial, menu selections, bill pay number, and reference number:

{
  "instruction": "<p>Dear Sam Katana,</p><p>This is to inform you that you have a pending payment of 5 XOF</p><p>Please complete the payment using steps below:</p><p>Step 1 Dial *133#</p><p>Step 2 Select 1 to \"Transfer\"</p><p>Step 3 Select 1 for \"Mobile Money User\"</p><p>Step 4 Enter the Bill pay number. 85404464</p><p>Step 5 Enter the amount you want to Transfer. 5 XOF</p><p>Step 6 Enter the Reference number 00360171</p><p>Step 7 Enter your PIN</p><p>Step 8 You will receive a confirmation for your payment</p><p>Step 9 You will receive your goods/services separately.</p><p>** Important Note: Please make sure that you include reference above so that we can process your payment correctly and without delay.</p><p>FloCash Customer Service</p>",
  "client_reference": "04dfb2e5-1274-4214-b5fd-3415fde7dc17",
  "transaction_id": "e07aa829-cda4-4c51-bd43-09a2f1e6604d",
  "transaction_status": "pending",
  "onramp_status": "initialized",
  "amount": "50",
  "currency": "ETB",
  "country": "ET"
}