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].
| Method and Path | Description | ||
|---|---|---|---|
| POST | /accounts/create | Used to create an account. |
|
| PUT | /accounts/update/:accountid | Used to update an account. |
|
| DELETE | /accounts/delete/:accountid | Delete some account. |
|
| GET | /accounts/:accountid | Find account by its id |
|
| GET | /accounts/list | Find all the accounts. |
|
| Method and Path | Description | ||
|---|---|---|---|
| DELETE | /deposits/delete/:depid | Delete some deposit. |
|
| GET | /deposits/:depid | Find deposit by its id. |
|
| GET | /deposits/list | List all the deposits |
|
| Method and Path | Description | ||
|---|---|---|---|
| POST | /payments/create | Used to create a payment. |
|
| PUT | /payments/update/:payid | Used to update a payment. |
|
| DELETE | /payments/delete/:payid | Delete some payment. |
|
| GET | /payments/:payid | Find payment by its id. |
|
| GET | /payments/:ref_accountid | Find payment by id accountid |
|
| GET | /payments/list | List all the payments |
|
| Method and Path | Description | ||
|---|---|---|---|
| POST | /transfers/create | Used to create a transfer resource. |
|
| PUT | /transfers/update/:transferid | Used to update a transfer resource. |
|
| DELETE | /transfers/delete/:transferid | Delete some transfer. |
|
| GET | /transfers/:transferid | Find transfer by its id |
|
| GET | /transfers/list | Find all the transfers. |
|
Public resource that can accept JSON input and returns a validation object describing any validation errors.
| Method and Path | Description | ||
|---|---|---|---|
| POST | /validations | ||
| Method and Path | Description | ||
|---|---|---|---|
| DELETE | /withdraws/delete/:wdwid | Delete some withdraw. |
|
| GET | /withdraws/:wdwid | Find withdraw by its id. |
|
| GET | /withdraws/list | List all the withdraws |
|
| Name | Value | Description |
|---|---|---|
| created | created | |
| edited | edited |
| Name | Value | Description |
|---|---|---|
| api_json | api_json | The original is in the api.json format |
A publication represents something that a user can subscribe to. An example would be subscribing to an email alert whenever a new version of an application is created.
| Name | Value | Description |
|---|---|---|
| membership_requests.create | membership_requests.create | For organizations for which I am an administrator, email me whenever a user applies to join the org. |
| memberships.create | memberships.create | For organizations for which I am a member, email me whenever a user joins the org. |
| applications.create | applications.create | For organizations for which I am a member, email me whenever an application is created. |
| versions.create | versions.create | For applications that I watch, email me whenever a version is created. |
| Name | Value | Description |
|---|---|---|
| asc | asc | |
| desc | desc |
Controls who is able to view this version
| Name | Value | Description |
|---|---|---|
| public | public | Anybody, including non logged in users, can view this application |
Interfaces: None
Account is defined by the app specifically to manage users transactions.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| accountid | long | Yes | - | Internal unique identifier for this account.
|
| ownerid | string | Yes | - | The username registered in the application
|
| total_amount | double | Yes | - | The amount specific to the debit and sold account. This field allows the process transactions.
|
| currency | string | Yes | - | The currency specific to location.
|
| sold | double | Yes | - | The amount specific to the balance account. This field allows the process transactions.
|
| debit | double | Yes | - | The amount specific to the money merchant have to collect and pay. This field allows the process transactions.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| accountid | long | Yes | - | Internal unique identifier for this account.
|
| ownerid | string | Yes | - | The username registered in the application.
|
| total_amount | double | No | - | The amount specific to the debit and sold account. This field allows the process transactions.
|
| sold | double | Yes | - | The amount specific to the balance account. This field allows the process transactions.
|
| debit | double | No | - | The amount specific to the money merchant have to collect and pay. This field allows the process transactions.
|
| currency | string | Yes | - | The currency specific to location.
|
Interfaces: None
Deposit describes a way a payment is handled. It depends of Payment Resource
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| depid | long | Yes | - | Internal unique identifier for this account.
|
| paymentid | long | Yes | - | The added paymentid used to proceed the deposit transaction.
|
Interfaces: None
Payment is defined by the app specifically to emit users transactions.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| payid | long | Yes | - | Internal unique identifier for this payment.
|
| actorid | string | Yes | - | The username registered in the application
|
| amount | double | Yes | - | The amount to send. This field allowed the processing transactions.
|
| ref_accountid | long | Yes | - | The accountid to use to send money to the specific account.
|
| payment_method | string | Yes | - | The type of payment to use [Mobile Money or Credit Card].
|
| operatorid | string | Yes | - | The operator specified the type of payment if Mobile Money.
|
| phone | long | Yes | - | The phone identifying specific account of consumer.
|
| pin | integer | Yes | - | The code used to validate the transaction.
|
| currency | string | Yes | - | The phone identifying specific account of consumer.
|
| payment_context | string | Yes | - | This field specify the type of transaction [Buying, Deposit, Withdraw].
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| payid | long | Yes | - | Internal unique identifier for this payment.
|
| actorid | string | Yes | - | The username registered in the application
|
| amount | double | Yes | - | The amount to send. This field allowed the processing transactions.
|
| ref_accountid | long | Yes | - | The accountid to use to send money to the specific account.
|
| payment_method | string | Yes | - | The type of payment to use [Mobile Money or Credit Card].
|
| operatorid | string | Yes | - | The operator specified the type of payment if Mobile Money.
|
| phone | long | Yes | - | The phone identifying specific account of consumer.
|
| pin | integer | Yes | - | The code used to validate the transaction.
|
| currency | string | Yes | - | The phone identifying specific account of consumer.
|
| payment_context | string | Yes | - | This field specify the type of transaction [Buying, Deposit, Withdraw].
|
Interfaces: None
Transfer is defined by the app specifically to manage users transactions (sending and receiving).
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| transferid | long | Yes | - | Internal unique identifier for this account.
|
| senderid | string | Yes | - | The username registered in the application
|
| amount | double | Yes | - | The amount to be send. This field allows the process transactions.
|
| ref_accountid_receiver | long | Yes | - | The accountid to use to send money and referencing the receiver.
|
| ref_accountid_sender | long | Yes | - | The accountid to use to send money and referencing the sender.
|
| currency | string | Yes | - | The currency specific to a country.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| transferid | long | Yes | - | Internal unique identifier for this account.
|
| senderid | string | Yes | - | The username registered in the application.
|
| amount | double | Yes | - | The amount to be send. This field allows the process transactions.
|
| ref_accountid_receiver | long | Yes | - | The accountid to use to send money and referencing the receiver.
|
| ref_accountid_sender | long | Yes | - | The accountid to use to send money and referencing the sender.
|
| currency | string | Yes | - | The currency specific to a country.
|
Interfaces: None
Used only to validate json files - used as a resource where http status code defines success
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| valid | boolean | Yes | - | If true, the json schema is valid. If false, there is at least one validation error.
|
| errors | [string] | Yes | [] | Contains any validation errors that result from parsing the json document. If empty, the document is valid.
|
Interfaces: None
Withdraw describes a way a payment is handled. It depends of Payment Resource
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| wdwid | long | Yes | - | Internal unique identifier for this account.
|
| paymentid | long | Yes | - | The added paymentid used to proceed the deposit transaction.
|
