API docs by Redocly

API Documentation (0.0.1)

Download OpenAPI specification:

Description of documentation

accounts

accounts_business_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
user_id
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

accounts_business_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
name
required
string <= 255 characters
contact_phone
string or null <= 255 characters ^(\+)?(?P<country_code>251)?(?P<phone_number>...
contact_email
required
string <email> <= 254 characters
logo
string or null <uuid>
license
string or null <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "contact_phone": "string",
  • "contact_email": "user@example.com",
  • "logo": "3c06f846-1ab1-40a9-8645-a19a9fdeae85",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_active": true,
  • "is_verified": true,
  • "name": "string",
  • "contact_phone": "string",
  • "contact_email": "user@example.com",
  • "logo": "3c06f846-1ab1-40a9-8645-a19a9fdeae85",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d"
}

accounts_business_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
integer

A unique integer value identifying this business.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_active": true,
  • "is_verified": true,
  • "name": "string",
  • "contact_phone": "string",
  • "contact_email": "user@example.com",
  • "logo": "3c06f846-1ab1-40a9-8645-a19a9fdeae85",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d"
}

accounts_login_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
phone_number
required
string
password
required
string

Responses

Request samples

Content type
{
  • "phone_number": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "refresh": "string",
  • "access": "string",
  • "user": {
    }
}

accounts_password_reset_confirm_create

Confirm password reset using the code sent to the user's phone

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
code
required
string
phone_number
required
string
new_password
required
string

Responses

Request samples

Content type
{
  • "code": "string",
  • "phone_number": "string",
  • "new_password": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

accounts_password_reset_request_create

Request a password reset code to be sent to the user's phone number

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
phone_number
required
string

Responses

Request samples

Content type
{
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

accounts_register_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
first_name
string <= 150 characters
last_name
string or null <= 150 characters
password
required
string
phone_number
required
string <= 255 characters ^(\+)?(?P<country_code>251)?(?P<phone_number>...

Responses

Request samples

Content type
{
  • "first_name": "string",
  • "last_name": "string",
  • "password": "string",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "phone_number": "string",
  • "date_joined": "2019-08-24T14:15:22Z"
}

accounts_services_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
business_id
string <uuid>
categories
string
is_active
string
name
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

accounts_services_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
name
required
string <= 255 characters
service_type
required
string (ServiceTypeEnum)
Enum: "basic" "premium"
  • basic - Basic
  • premium - Premium
is_active
boolean
business
required
integer
image
string or null <uuid>
categories
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "service_type": "basic",
  • "is_active": true,
  • "business": 0,
  • "image": "89f204d4-24d2-439a-b6e8-e97405cb1f8e",
  • "categories": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "service_type": "basic",
  • "is_active": true,
  • "business": 0,
  • "image": "89f204d4-24d2-439a-b6e8-e97405cb1f8e",
  • "categories": [
    ]
}

accounts_services_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this service.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "service_type": "basic",
  • "is_active": true,
  • "business": 0,
  • "image": "89f204d4-24d2-439a-b6e8-e97405cb1f8e",
  • "categories": [
    ]
}

accounts_services_categories_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

accounts_users_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
phone_number
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

accounts_users_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "phone_number": "string",
  • "is_phone_verified": true,
  • "is_email_verified": true,
  • "date_joined": "2019-08-24T14:15:22Z"
}

accounts_users_devices_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

accounts_users_devices_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
id
required
string <= 255 characters
label
string or null <= 255 characters

Responses

Request samples

Content type
{
  • "id": "string",
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "label": "string"
}

accounts_users_devices_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string

A unique value identifying this user device.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "label": "string"
}

accounts_users_devices_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string

A unique value identifying this user device.

Responses

accounts_users_profile_retrieve

Retrieve or update the authenticated user's profile

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "last_login": "2019-08-24T14:15:22Z",
  • "first_name": "string",
  • "email": "user@example.com",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "profile_pic_id": "e7e57f3b-fcab-4884-8f3c-e54dae3fd23f",
  • "phone_number": "string",
  • "is_phone_verified": true,
  • "is_email_verified": true,
  • "last_name": "string",
  • "user_type": "user"
}

accounts_users_profile_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this user.

Request Body schema:
required
last_login
string or null <date-time>
first_name
string <= 150 characters
email
string <email> (Email address) <= 254 characters
is_active
boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

date_joined
string <date-time>
profile_pic_id
string or null <uuid>
phone_number
required
string <= 255 characters ^(\+)?(?P<country_code>251)?(?P<phone_number>...
is_phone_verified
boolean
is_email_verified
boolean
last_name
string or null <= 150 characters
user_type
required
string (UserTypeEnum)
Enum: "user" "busines"
  • user - user
  • busines - bussines

Responses

Request samples

Content type
{
  • "last_login": "2019-08-24T14:15:22Z",
  • "first_name": "string",
  • "email": "user@example.com",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "profile_pic_id": "e7e57f3b-fcab-4884-8f3c-e54dae3fd23f",
  • "phone_number": "string",
  • "is_phone_verified": true,
  • "is_email_verified": true,
  • "last_name": "string",
  • "user_type": "user"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "last_login": "2019-08-24T14:15:22Z",
  • "first_name": "string",
  • "email": "user@example.com",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "profile_pic_id": "e7e57f3b-fcab-4884-8f3c-e54dae3fd23f",
  • "phone_number": "string",
  • "is_phone_verified": true,
  • "is_email_verified": true,
  • "last_name": "string",
  • "user_type": "user"
}

accounts_users_profile_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this user.

Request Body schema:
last_login
string or null <date-time>
first_name
string <= 150 characters
email
string <email> (Email address) <= 254 characters
is_active
boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

date_joined
string <date-time>
profile_pic_id
string or null <uuid>
phone_number
string <= 255 characters ^(\+)?(?P<country_code>251)?(?P<phone_number>...
is_phone_verified
boolean
is_email_verified
boolean
last_name
string or null <= 150 characters
user_type
string (UserTypeEnum)
Enum: "user" "busines"
  • user - user
  • busines - bussines

Responses

Request samples

Content type
{
  • "last_login": "2019-08-24T14:15:22Z",
  • "first_name": "string",
  • "email": "user@example.com",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "profile_pic_id": "e7e57f3b-fcab-4884-8f3c-e54dae3fd23f",
  • "phone_number": "string",
  • "is_phone_verified": true,
  • "is_email_verified": true,
  • "last_name": "string",
  • "user_type": "user"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "last_login": "2019-08-24T14:15:22Z",
  • "first_name": "string",
  • "email": "user@example.com",
  • "is_active": true,
  • "date_joined": "2019-08-24T14:15:22Z",
  • "profile_pic_id": "e7e57f3b-fcab-4884-8f3c-e54dae3fd23f",
  • "phone_number": "string",
  • "is_phone_verified": true,
  • "is_email_verified": true,
  • "last_name": "string",
  • "user_type": "user"
}

accounts_verifications_confirm_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
code
required
string
user_id
required
string <uuid>
code_type
required
integer
Enum: 1 2
  • 1 - PHONE
  • 2 - EMAIL

Responses

Request samples

Content type
{
  • "code": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "code_type": 1
}

Response samples

Content type
application/json
{
  • "detail": "string",
  • "user": {
    }
}

accounts_verifications_resend_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
user_id
required
string <uuid>
code_type
required
integer (CodeTypeEnum)
Enum: 1 2
  • 1 - PHONE
  • 2 - EMAIL

Responses

Request samples

Content type
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "code_type": 1
}

Response samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "code_type": 1,
  • "detail": "string"
}

apis

apis_enterprises_access_grants_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
is_active
boolean

Responses

Request samples

Content type
{
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "access_id": "string",
  • "access_secret": "string",
  • "is_active": true
}

apis_enterprises_enterprises_grants_list

API endpoint that allows user grants to be viewed or edited.

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
expires_at_gte
string

Filter by expiration date greater than or equal to

status
string

Filter by grant status

user_id
integer

Filter by user ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

apis_enterprises_enterprises_grants_create

API endpoint that allows user grants to be viewed or edited.

Authorizations:
basicAuthcookieAuthjwtAuth
header Parameters
X-Access-Id
required
string
X-Access-Secret
required
string
Request Body schema:
required
phone_number
required
string
expires_at
string or null <date-time>
max_amount
required
string <decimal> ^-?\d{0,8}(?:\.\d{0,2})?$
meta_data
any or null
enterprise
required
string <uuid>

Responses

Request samples

Content type
{
  • "phone_number": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "max_amount": "string",
  • "meta_data": null,
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "max_amount": "string",
  • "meta_data": null,
  • "grant_status": "pending",
  • "is_active": true,
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}

apis_enterprises_enterprises_grants_retrieve

API endpoint that allows user grants to be viewed or edited.

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this user grant.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "max_amount": "string",
  • "meta_data": null,
  • "grant_status": "pending",
  • "is_active": true,
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}

apis_enterprises_initiate_payment_create

API endpoint that allows enterprises to pull money from user wallets.

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
amount
required
integer >= 1
remarks
string
user_grant
required
string <uuid>

Responses

Request samples

Content type
{
  • "amount": 1,
  • "remarks": "string",
  • "user_grant": "1aacc5e3-ab68-4d88-b575-608466d7adb1"
}

Response samples

Content type
application/json
{
  • "amount": 1,
  • "remarks": "string",
  • "user_grant": "1aacc5e3-ab68-4d88-b575-608466d7adb1"
}

apis_enterprises_users_grants_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
expires_at_gte
string <date-time>
status
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

apis_enterprises_users_grants_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this user grant.

Request Body schema:
required
expires_at
string or null <date-time>
max_amount
required
string <decimal> ^-?\d{0,8}(?:\.\d{0,2})?$
meta_data
any or null
grant_status
string (GrantStatusEnum)
Enum: "pending" "approved" "rejected" "suspended"
  • pending - Pending
  • approved - Approved
  • rejected - Rejected
  • suspended - Suspended
is_active
boolean

Responses

Request samples

Content type
{
  • "expires_at": "2019-08-24T14:15:22Z",
  • "max_amount": "string",
  • "meta_data": null,
  • "grant_status": "pending",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "max_amount": "string",
  • "meta_data": null,
  • "grant_status": "pending",
  • "is_active": true
}

apis_enterprises_users_grants_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this user grant.

Request Body schema:
expires_at
string or null <date-time>
max_amount
string <decimal> ^-?\d{0,8}(?:\.\d{0,2})?$
meta_data
any or null
grant_status
string (GrantStatusEnum)
Enum: "pending" "approved" "rejected" "suspended"
  • pending - Pending
  • approved - Approved
  • rejected - Rejected
  • suspended - Suspended
is_active
boolean

Responses

Request samples

Content type
{
  • "expires_at": "2019-08-24T14:15:22Z",
  • "max_amount": "string",
  • "meta_data": null,
  • "grant_status": "pending",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "max_amount": "string",
  • "meta_data": null,
  • "grant_status": "pending",
  • "is_active": true
}

bills

bills_pay_bills_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
number
required
string
amount
required
integer

Responses

Request samples

Content type
{
  • "number": "string",
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

bills_unpaid_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
user__number
required
string

Responses

bills_utilities_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

files

files_file_metas_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

files_file_metas_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
key
required
string <= 255 characters

Responses

Request samples

Content type
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "content_length": 0,
  • "content_type": "string",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "meta_data": null,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "public_url": "http://example.com"
}

files_file_metas_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this file meta.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "content_length": 0,
  • "content_type": "string",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "meta_data": null,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "public_url": "http://example.com"
}

files_upload_signed_url_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
hash
required
string <= 255 characters
size
required
integer [ 10 .. 6000 ]
ext
required
string
Enum: "png" "jpg" "heic" "jpeg" "gif" "pdf" "mp4" "mkv" "avi"
  • png - png
  • jpg - jpg
  • heic - heic
  • jpeg - jpeg
  • gif - gif
  • pdf - pdf
  • mp4 - mp4
  • mkv - mkv
  • avi - avi

Responses

Request samples

Content type
{
  • "hash": "string",
  • "size": 10,
  • "ext": "png"
}

Response samples

Content type
application/json
{
  • "size": 10,
  • "id": "string",
  • "signed_url": "string",
  • "key": "string"
}

notifications

notifications_notifications_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

platform_admin

platform_admin_admin_platform_login_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
phone_number
required
string
password
required
string

Responses

Request samples

Content type
{
  • "phone_number": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "refresh": "string",
  • "access": "string",
  • "user": {
    }
}

platform_admin_all_users_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • { }
]

platform_admin_business_records_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

platform_admin_dispute_records_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

platform_admin_dispute_records_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
transaction
required
string <uuid>

ID of the disputed transaction

phone_number
required
string <= 20 characters ^(\+)?(?P<country_code>251)?(?P<phone_number>...

Phone number of the reporter

amount
integer <int64> [ 0 .. 9223372036854776000 ]

Disputed amount in ETB

notes
string or null

Additional notes about the dispute

status
string
Enum: "needs_response" "in_review" "reviewed" "resolved"

Current status of the dispute

  • needs_response - Needs Response
  • in_review - In Review
  • reviewed - Reviewed
  • resolved - Resolved

Responses

Request samples

Content type
{
  • "transaction": "6b91fbed-a61e-4512-a48d-a6c1ac2f90cb",
  • "phone_number": "string",
  • "amount": 9223372036854776000,
  • "notes": "string",
  • "status": "needs_response"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "transaction": "6b91fbed-a61e-4512-a48d-a6c1ac2f90cb",
  • "phone_number": "string",
  • "amount": 9223372036854776000,
  • "notes": "string",
  • "status": "needs_response",
  • "created_at": "2019-08-24T14:15:22Z"
}

platform_admin_dispute_records_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this Dispute.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "transaction": "6b91fbed-a61e-4512-a48d-a6c1ac2f90cb",
  • "phone_number": "string",
  • "amount": 9223372036854776000,
  • "notes": "string",
  • "status": "needs_response",
  • "created_at": "2019-08-24T14:15:22Z"
}

platform_admin_dispute_records_mark_as_reviewed_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this Dispute.

Request Body schema:
status
string
Enum: "needs_response" "in_review" "reviewed" "resolved"

Current status of the dispute

  • needs_response - Needs Response
  • in_review - In Review
  • reviewed - Reviewed
  • resolved - Resolved
notes
string or null

Additional notes about the dispute

Responses

Request samples

Content type
{
  • "status": "needs_response",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "needs_response",
  • "notes": "string"
}

platform_admin_dispute_records_move_to_review_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this Dispute.

Request Body schema:
status
string
Enum: "needs_response" "in_review" "reviewed" "resolved"

Current status of the dispute

  • needs_response - Needs Response
  • in_review - In Review
  • reviewed - Reviewed
  • resolved - Resolved

Responses

Request samples

Content type
{
  • "status": "needs_response"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "needs_response"
}

platform_admin_dispute_records_process_refund_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this Dispute.

Request Body schema:
status
string
Enum: "needs_response" "in_review" "reviewed" "resolved"

Current status of the dispute

  • needs_response - Needs Response
  • in_review - In Review
  • reviewed - Reviewed
  • resolved - Resolved
notes
string or null

Additional notes about the dispute

Responses

Request samples

Content type
{
  • "status": "needs_response",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "needs_response",
  • "notes": "string"
}

platform_admin_transaction_records_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

platform_admin_transaction_records_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this transaction.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "from_user": "string",
  • "to_user": "string",
  • "amount": 1,
  • "status": "pending",
  • "remarks": "string",
  • "date": "2019-08-24T14:15:22Z"
}

schema

schema_retrieve

OpenApi3 schema for this API. Format can be selected via content negotiation.

  • YAML: application/vnd.oai.openapi
  • JSON: application/vnd.oai.openapi+json
Authorizations:
basicAuthcookieAuthjwtAuthNone
query Parameters
format
string
Enum: "json" "yaml"
lang
string
Enum: "af" "ar" "ar-dz" "ast" "az" "be" "bg" "bn" "br" "bs" "ca" "ckb" "cs" "cy" "da" "de" "dsb" "el" "en" "en-au" "en-gb" "eo" "es" "es-ar" "es-co" "es-mx" "es-ni" "es-ve" "et" "eu" "fa" "fi" "fr" "fy" "ga" "gd" "gl" "he" "hi" "hr" "hsb" "hu" "hy" "ia" "id" "ig" "io" "is" "it" "ja" "ka" "kab" "kk" "km" "kn" "ko" "ky" "lb" "lt" "lv" "mk" "ml" "mn" "mr" "ms" "my" "nb" "ne" "nl" "nn" "os" "pa" "pl" "pt" "pt-br" "ro" "ru" "sk" "sl" "sq" "sr" "sr-latn" "sv" "sw" "ta" "te" "tg" "th" "tk" "tr" "tt" "udm" "ug" "uk" "ur" "uz" "vi" "zh-hans" "zh-hant"

Responses

Response samples

Content type
No sample

subscriptions

subscriptions_subscribe_service_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
next_billing_date_gt
string <date-time>

next billing date greater than

next_billing_date_lt
string <date-time>

next billing date less than

subscription_id
integer

Subscription ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

subscriptions_subscribe_service_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
subscription
required
string <uuid>

Responses

Request samples

Content type
{
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8"
}

Response samples

Content type
application/json
{
  • "is_active": true,
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8"
}

subscriptions_subscriptions_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
business_id
string <uuid>
service_id
string <uuid>
service_type
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

subscriptions_subscriptions_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
required
Array of objects (Features)
name
required
string <= 255 characters
frequency
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
fixed_price
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
is_active
boolean
has_fixed_price
boolean
payment_type
string (PaymentTypeEnum)
Enum: "pre" "post"
  • pre - Prepaid
  • post - Postpaid
service
required
string <uuid>

Responses

Request samples

Content type
{
  • "features": [
    ],
  • "name": "string",
  • "frequency": -9223372036854776000,
  • "fixed_price": -9223372036854776000,
  • "is_active": true,
  • "has_fixed_price": true,
  • "payment_type": "pre",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "frequency": -9223372036854776000,
  • "fixed_price": -9223372036854776000,
  • "is_active": true,
  • "has_fixed_price": true,
  • "payment_type": "pre",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

subscriptions_subscriptions_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this subscription.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "frequency": -9223372036854776000,
  • "fixed_price": -9223372036854776000,
  • "is_active": true,
  • "has_fixed_price": true,
  • "payment_type": "pre",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

subscriptions_subscriptions_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this subscription.

Request Body schema:
required
required
Array of objects (Features)
name
required
string <= 255 characters
frequency
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
fixed_price
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
is_active
boolean
has_fixed_price
boolean
payment_type
string (PaymentTypeEnum)
Enum: "pre" "post"
  • pre - Prepaid
  • post - Postpaid
service
required
string <uuid>

Responses

Request samples

Content type
{
  • "features": [
    ],
  • "name": "string",
  • "frequency": -9223372036854776000,
  • "fixed_price": -9223372036854776000,
  • "is_active": true,
  • "has_fixed_price": true,
  • "payment_type": "pre",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "frequency": -9223372036854776000,
  • "fixed_price": -9223372036854776000,
  • "is_active": true,
  • "has_fixed_price": true,
  • "payment_type": "pre",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

subscriptions_subscriptions_partial_update

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this subscription.

Request Body schema:
Array of objects (Features)
name
string <= 255 characters
frequency
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
fixed_price
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
is_active
boolean
has_fixed_price
boolean
payment_type
string (PaymentTypeEnum)
Enum: "pre" "post"
  • pre - Prepaid
  • post - Postpaid
service
string <uuid>

Responses

Request samples

Content type
{
  • "features": [
    ],
  • "name": "string",
  • "frequency": -9223372036854776000,
  • "fixed_price": -9223372036854776000,
  • "is_active": true,
  • "has_fixed_price": true,
  • "payment_type": "pre",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "frequency": -9223372036854776000,
  • "fixed_price": -9223372036854776000,
  • "is_active": true,
  • "has_fixed_price": true,
  • "payment_type": "pre",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

subscriptions_subscriptions_destroy

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this subscription.

Responses

subscriptions_unsubscribe_service_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

subscriptions_unsubscribe_service_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
subscription
required
string <uuid>

Responses

Request samples

Content type
{
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8"
}

Response samples

Content type
application/json
{
  • "is_active": true,
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8"
}

subscriptions_user_subscriptions_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
business_id
string <uuid>

Business ID

is_active
boolean
next_billing_date_gt
string <date-time>

next billing date greater than

next_billing_date_lt
string <date-time>

next billing date less than

service_id
string <uuid>

Service ID

service_type
string

Service Type

subscription_id
integer

Subscription ID

user_id
string <uuid>

User ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

wallets

wallets_business_wallets_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

wallets_business_wallets_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
business__id
required
integer

A unique integer value identifying this wallet.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "balance": 9223372036854776000,
  • "frozen_amount": 9223372036854776000,
  • "is_restricted": true,
  • "wallet_type": "user",
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "business": 0,
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}

wallets_receive_external_create

Authorizations:
basicAuthcookieAuthjwtAuth
header Parameters
X-Access-Id
required
string
X-Access-Secret
required
string
Request Body schema:
required
phone_number
required
string
amount
required
integer >= 10
remarks
required
string

Responses

Request samples

Content type
{
  • "phone_number": "string",
  • "amount": 10,
  • "remarks": "string"
}

Response samples

Content type
application/json
{
  • "amount": 10,
  • "remarks": "string",
  • "details": "string"
}

wallets_send_external_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
from_wallet
required
string <uuid>
bank
required
string
account_number
required
string
amount
required
integer >= 10
remarks
required
string

Responses

Request samples

Content type
{
  • "from_wallet": "0485afdc-029e-4962-83fc-2b07d65eb32e",
  • "bank": "string",
  • "account_number": "string",
  • "amount": 10,
  • "remarks": "string"
}

Response samples

Content type
application/json
{
  • "from_wallet": "0485afdc-029e-4962-83fc-2b07d65eb32e",
  • "amount": 10,
  • "remarks": "string"
}

wallets_send_p2p_create

Authorizations:
basicAuthcookieAuthjwtAuth
Request Body schema:
required
from_wallet
required
string <uuid>
to_wallet
required
string <uuid>
amount
required
integer >= 10
remarks
required
string

Responses

Request samples

Content type
{
  • "from_wallet": "0485afdc-029e-4962-83fc-2b07d65eb32e",
  • "to_wallet": "4b150cc3-a60e-4e52-b092-e0b2c036b3cd",
  • "amount": 10,
  • "remarks": "string"
}

Response samples

Content type
application/json
{
  • "from_wallet": "0485afdc-029e-4962-83fc-2b07d65eb32e",
  • "to_wallet": "4b150cc3-a60e-4e52-b092-e0b2c036b3cd",
  • "amount": 10,
  • "remarks": "string"
}

wallets_snapshots_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
created_at_gte
string <date>
wallet_id
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

wallets_stats_transactions_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
tr_id
required
string

Responses

wallets_transactions_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
wallet
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

wallets_transactions_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this transaction.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "to_user": "string",
  • "to_business": "string",
  • "to_enterprise": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "amount": 1,
  • "remarks": "string",
  • "status": "pending",
  • "from_wallet": "0485afdc-029e-4962-83fc-2b07d65eb32e",
  • "to_wallet": "4b150cc3-a60e-4e52-b092-e0b2c036b3cd"
}

wallets_wallets_list

Authorizations:
basicAuthcookieAuthjwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

wallets_wallets_retrieve

Authorizations:
basicAuthcookieAuthjwtAuth
path Parameters
user__id
required
string <uuid>

A UUID string identifying this wallet.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "balance": 9223372036854776000,
  • "frozen_amount": 9223372036854776000,
  • "is_restricted": true,
  • "wallet_type": "user",
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "business": 0,
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}

wallets_wallets_public_list

Authorizations:
basicAuthcookieAuthjwtAuth
query Parameters
phone_number
string
user_id
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]