This is a payment pending using Mobile Money API and Credit Card. This API allows merchant to get payment information of the consumer which have its own account and money manage by the solution. The merchant can receive its money if only the consumer agreed [1st case].
account
Path: /accounts
/accounts/create Used to create an account.
Parameters
| Name | Type | Description |
|---|---|---|
| accountid required | long | Form |
| ownerid required | string | Form |
| total_amount required | double | Form |
| currency required | string | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | account | |
| 409 | unit |
/accounts/update/:accountid Used to update an account.
Parameters
| Name | Type | Description |
|---|---|---|
| accountid required | long | Path |
| ownerid required | string | Form |
| total_amount required | double | Form |
| currency required | string | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | account | |
| 409 | unit |
/accounts/delete/:accountid Delete some account.
Parameters
| Name | Type | Description |
|---|---|---|
| accountid required | long | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 204 | unit | |
| 401 | unit | |
| 404 | unit |
/accounts/:accountid Find account by its id
Parameters
| Name | Type | Description |
|---|---|---|
| accountid required | long | Path |
| ownerid required | string | Query |
| total_amount required | double | Query |
| currency required | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | account | |
| 404 | unit |
/accounts/list Find all the accounts.
Parameters
| Name | Type | Description |
|---|---|---|
| accountid required | long | Query |
| ownerid required | string | Query |
| total_amount required | double | Query |
| currency required | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [account] | |
| 404 | unit |
payment
Path: /payments
/payments/create Used to create a payment.
Parameters
| Name | Type | Description |
|---|---|---|
| payid required | long | Form |
| payment_method required | string | Form |
| actorid required | string | Form |
| ref_accountid required | long | Form |
| operatorid required | string | Form |
| amount required | double | Form |
| phone required | long | Form |
| pin required | integer | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | payment | |
| 409 | unit |
/payments/update/:payid Used to update a payment.
Parameters
| Name | Type | Description |
|---|---|---|
| payid required | long | Path |
| payment_method required | string | Form |
| actorid required | string | Form |
| ref_accountid required | long | Form |
| operatorid required | string | Form |
| amount required | double | Form |
| phone required | long | Form |
| pin required | integer | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | payment | |
| 409 | unit |
/payments/delete/:payid Delete some payment.
Parameters
| Name | Type | Description |
|---|---|---|
| payid required | long | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 204 | unit | |
| 401 | unit | |
| 404 | unit |
/payments/:payid Find payment by its id.
Parameters
| Name | Type | Description |
|---|---|---|
| payid required | long | Path |
| payment_method required | string | Query |
| actorid required | string | Query |
| ref_accountid required | long | Query |
| operatorid required | string | Query |
| amount required | double | Query |
| phone required | long | Query |
| pin required | long | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | payment | |
| 404 | unit |
/payments/:ref_accountid Find payment by id accountid
Parameters
| Name | Type | Description |
|---|---|---|
| ref_accountid required | long | Path |
| payid required | long | Query |
| payment_method required | string | Query |
| actorid required | string | Query |
| operatorid required | string | Query |
| amount required | double | Query |
| phone required | long | Query |
| pin required | integer | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | payment | |
| 404 | unit |
/payments/list List all the payments
Parameters
| Name | Type | Description |
|---|---|---|
| payid required | long | Query |
| payment_method required | string | Query |
| actorid required | string | Query |
| ref_accountid required | long | Query |
| operatorid required | string | Query |
| amount required | double | Query |
| phone required | long | Query |
| pin required | long | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [payment] | |
| 404 | unit |
user
Path: /users
/users Search for a specific user.
Parameters
| Name | Type | Description |
|---|---|---|
| username required | string | Query Find user with this username. Exact match |
| email required | string | Query Find user with this email address. Case in-sensitive. Exact match |
| signed_up required | string | Query Find users with the specified date. |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [user] |
/users/:username Returns information about the user with this username.
Parameters
| Name | Type | Description |
|---|---|---|
| username required | string | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | unit | |
| 404 | unit |
/users/login Used to authenticate a user with an email address and password. Successful authentication returns an instance of the user model. Failed authorizations of any kind are returned as a generic error with code user_authorization_failed.
Parameters
| Name | Type | Description |
|---|---|---|
| email required | string | Form |
| password required | string | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | user | |
| 409 | unit |
/users/register Used to register an user.
Parameters
| Name | Type | Description |
|---|---|---|
| username required | string | Form |
| email required | string | Form |
| password required | string | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | user | |
| 409 | unit |
validation
Public resource that can accept JSON input and returns a validation object describing any validation errors.
Path: /validations