Skip to main content
GET
/
momo-transfers
Retrieves all mobile money transfer payments for the authenticated user or entity.
curl --request GET \
  --url https://api.nuvion.tech/momo-transfers \
  --header 'Authorization: <authorization>'
{
  "message": "MOMO transfer payments retrieved successfully",
  "status": 200,
  "data": [
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "amount": 10000,
      "currency": "GHS",
      "unique_reference": "MOMO-TR-123456789",
      "counterparty_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "status": "successful",
      "status_reason": "payment_completed",
      "narration": "Payment for services",
      "type": "outflow",
      "applicable_fee": 200,
      "meta": {},
      "created": 1631456789000,
      "updated": 1631456999000
    },
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F7",
      "amount": 20000,
      "currency": "GHS",
      "unique_reference": "MOMO-TR-987654321",
      "counterparty_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "status": "pending",
      "status_reason": "awaiting_processing",
      "narration": "Payment for goods",
      "type": "outflow",
      "applicable_fee": 400,
      "meta": {},
      "created": 1631356789000,
      "updated": 1631356789000
    }
  ],
  "meta": {
    "pagination": {
      "order": "desc",
      "has_next": true,
      "limit": 20,
      "has_previous": false,
      "next_cursor": "01HJ5G6R7MXW5ZK2QD6YA8N9F7",
      "previous_cursor": "01HJ5G6R7MXW5ZK2QD6YA8N9F3"
    },
    "filters_applied": {
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "payment_type": "momo-transfer",
      "sort": {
        "field": "created",
        "order": "desc"
      }
    }
  }
}

Headers

​
Authorization
string
required

Authorization header: Bearer {jwt or Secretkey}

Query Parameters

​
limit
number

Maximum number of MOMO transfers to return in a single request

​
cursor
string

Cursor for pagination to get the next set of results

​
prev_cursor
string

Cursor for pagination to get the previous set of results

​
status
string

Filter MOMO transfers by their current status

​
account_id
string

Filter MOMO transfers by the source account ID

​
counterparty_id
string

Filter MOMO transfers by the recipient counterparty ID

​
currency
string

Filter MOMO transfers by currency code

​
unique_reference
string

Filter MOMO transfers by unique reference code

​
amount_min
number

Filter MOMO transfers with amount greater than or equal to this value

​
amount_max
number

Filter MOMO transfers with amount less than or equal to this value

​
date_from
string

Filter MOMO transfers created on or after this date

​
date_to
string

Filter MOMO transfers created on or before this date

​
sort_by
string

Field to sort the MOMO transfers by

​
sort_order
string

Sort order for the MOMO transfers

Response

Successful operation

​
message
string
required

A descriptive message indicating the result of the operation

​
status
string
required

The status of the API operation (successful, error, failed, pending)

​
data
object
required

List of MOMO transfer objects

​
meta
object
required

Metadata related to the response including pagination and filter information