API Reference
Payouts /Mobile Transfer
Request Mobile Payment Invoice [POST]

Request Payment Invoice

https://sandboxapi.bitnob.co/api/v1/mobile-payments/initiate (opens in a new tab)

Initiating a payment to a Bitnob user via mobile number

Body Params

ParametertypeRequired
countryCode
country code of account number
string
accountNumber
phone number of the recipient
string
senderName
Name of user sending money
string
amount
amount been sent(should be in cents or satoshis)
int32
reference
you can send a unique reference of transaction, if you don't we will generate one and send it back to you
string
description
description or payment narration e.g medical bills
string
callbackUrl
callbackUrl to receive webhook response for this transaction
string
paymentMethodIdentifier
the channel been used to send the payment
string
currency
usd/sat
stringDefaults to usd

Request

payouts-mobile-transfers/Request Payment Invoice [POST]
curl --request POST \
     --url https://sandboxapi.bitnob.co/api/v1/mobile-payments/initiate \
     --header 'Authorization: Bearer API-KEY' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "countryCode": "string",
  "accountNumber": "string",
  "senderName": "string",
  "amount": 0,
  "reference": "string",
  "description": "string",
  "callbackUrl": "string",
  "paymentMethodIdentifier": "string",
  "currency": "usd"
}
'

Response

🟢 200 OK
{
  "status": true,
  "message": "payment invoice generated successfully",
  "data": {
    "id": "94f6d222-88bc-4049-95b3-7d0f252b3a66",
    "amount": 100,
    "reference": "bd4a5621657b",
    "status": "unpaid",
    "satoshis": 497554,
    "beneficiaryName": "John Doe",
    "amountToBeReceived": 50000,
    "paymentRequest": "lntb4975540n1p3nadkppp57c6tgarz0uuvtn05cwmu4pjtk3fvsxd80avaf6vsl3psq0av080sdpcv3jhxcmjd9c8g6t0dcsxgetnvdexjur5d9hkugryv4ekxunfwp6xjmmwcqzpgxqzursp5kej50s2n6u54camm0gmehzlyq24z6z2kqfnqwsnplatdd8j7rt7s9qyyssqq3vh6uerlfhsucptgqnn7jx00868av2ye24tqgntsanhmh6srtqpg7yvm6xl8yd6wxnpcx23ue7nrf5hc9xv4vvygcy7lcf4etz0nncp6c6xz6",
    "expiresAt": "2022-10-06T11:21:40.000Z",
    "currencyPair": "USD_NGN",
    "emailVerified": true,
    "kycLevel": 1,
    "exchangeRate": {
      "rate": 500,
      "source": {
        "amount": 100,
        "currency": "USD"
      },
      "destination": {
        "currency": "NGN",
        "amount": 50000
      }
    },
    "updatedAt": "2022-10-06T11:06:41.837Z",
    "created": "2022-10-06T11:06:41.837Z"
  }
}
Last updated on