MotapaPay
API Docs

Listing Customers

You can list customers using various query parameters. The response will provide detailed information about the customers.

Headers

  • Authorization: Bearer YOUR_SECRET_KEY
  • Content-Type: application/json

Query Parameters

  • limit: number (optional) - Limit the number of results returned.
  • skip: number (optional) - Skip a number of results for pagination.

Sample Request to List Customers

curl -X GET "https://api.motapa.africa/v1/customer/list?limit=50&skip=0" \
-H "Authorization: Bearer mp_test_26PHem9AhJZvU623DfE1x4sd" \
-H "Content-Type: application/json"

Sample Responses

{
    "result": "success",
    "customers": [
        {
            "customer_id": "mp_customer_1234567890",
            "customer_reference": "CUST-12345",
            "first_name": "John",
            "last_name": "Doe",
            "street": "123 Main St",
            "city": "Harare",
            "state": "Harare",
            "country": "Zimbabwe",
            "postal_code": "00263",
            "emails": [
                {
                    "email_id": "email_6789abcdef",
                    "email_address": "john.doe@example.com",
                    "is_primary": true,
                    "is_verified": true,
                    "date_created": "2023-01-15 14:30:45"
                }
            ],
            "phones": [
                {
                    "phone_id": "phone_abcdef12345",
                    "phone_number": "+263771234567",
                    "is_primary": true,
                    "is_verified": true,
                    "date_created": "2023-01-15 14:32:18"
                }
            ],
            "identifications": [
                {
                    "id_doc_id": "id_doc_passport123",
                    "id_type": "passport",
                    "id_number": "AB123456",
                    "issuing_country": "Zimbabwe",
                    "expiry_date": "2030-01-01",
                    "document_link": "https://example.com/documents/passport.pdf",
                    "is_verified": true,
                    "status": "verified",
                    "date_created": "2023-01-16 10:45:30"
                }
            ],
            "created_at": "2023-01-15T12:30:45Z",
            "updated_at": "2023-01-15T12:35:22Z"
        },
        {
            "customer_id": "mp_customer_0987654321",
            "customer_reference": "CUST-67890",
            "first_name": "Jane",
            "last_name": "Smith",
            "street": "456 Oak Avenue",
            "city": "Cape Town",
            "state": "Western Cape",
            "country": "South Africa",
            "postal_code": "8001",
            "emails": [
                {
                    "email_id": "email_1234567890",
                    "email_address": "jane.smith@example.com",
                    "is_primary": true,
                    "is_verified": true,
                    "date_created": "2023-02-20 09:15:22"
                },
                {
                    "email_id": "email_0987654321",
                    "email_address": "jsmith@company.com",
                    "is_primary": false,
                    "is_verified": false,
                    "date_created": "2023-02-20 09:16:30"
                }
            ],
            "phones": [
                {
                    "phone_id": "phone_9876543210",
                    "phone_number": "+27821234567",
                    "is_primary": true,
                    "is_verified": true,
                    "date_created": "2023-02-20 09:15:30"
                }
            ],
            "identifications": [
                {
                    "id_doc_id": "id_doc_national123",
                    "id_type": "national_id",
                    "id_number": "9001015800086",
                    "issuing_country": "South Africa",
                    "is_verified": true,
                    "status": "verified",
                    "date_created": "2023-02-20 09:20:15"
                }
            ],
            "created_at": "2023-02-20T09:15:30Z",
            "updated_at": "2023-02-20T09:15:30Z"
        }
    ],
    "total_count": 2,
    "message": "Customers listed successfully."
}