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
POST
/accounts/create Used to create an account.
Parameters
| Name | Type | Description |
|---|---|---|
| accountid required | long | Form |
| ownerid required | string | Form |
| total_amount required | double | Form |
| sold required | double | Form |
| debit required | double | Form |
| currency required | string | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | account | |
| 409 | unit |
PUT
/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 |
| sold required | double | Form |
| debit required | double | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | account | |
| 409 | unit |
DELETE
/accounts/delete/:accountid Delete some account.
Parameters
| Name | Type | Description |
|---|---|---|
| accountid required | long | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 204 | unit | |
| 401 | unit | |
| 404 | unit |
GET
/accounts/:accountid Find account by its id
Parameters
| Name | Type | Description |
|---|---|---|
| accountid required | long | Path |
| ownerid required | string | Query |
| total_amount required | double | Query |
| sold required | double | Query |
| debit required | double | Query |
| currency required | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | account | |
| 404 | unit |
GET
/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 |
| sold required | double | Query |
| debit required | double | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [account] | |
| 404 | unit |
deposit
Path: /deposits
DELETE
/deposits/delete/:depid Delete some deposit.
Parameters
| Name | Type | Description |
|---|---|---|
| depid required | long | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 204 | unit | |
| 401 | unit | |
| 404 | unit |
GET
/deposits/:depid Find deposit by its id.
Parameters
| Name | Type | Description |
|---|---|---|
| depid 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 |
| currency required | string | Query |
| payment_context required | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | payment | |
| 404 | unit |
GET
/deposits/list List all the deposits
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 |
| currency required | string | Query |
| payment_context required | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [payment] | |
| 404 | unit |
payment
Path: /payments
POST
/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 |
| currency required | string | Form |
| phone required | long | Form |
| pin required | integer | Form |
| payment_context required | string | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | payment | |
| 409 | unit |
PUT
/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 |
| currency required | string | Form |
| payment_context required | string | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | payment | |
| 409 | unit |
DELETE
/payments/delete/:payid Delete some payment.
Parameters
| Name | Type | Description |
|---|---|---|
| payid required | long | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 204 | unit | |
| 401 | unit | |
| 404 | unit |
GET
/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 |
| currency required | string | Query |
| payment_context required | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | payment | |
| 404 | unit |
GET
/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 |
| currency required | string | Query |
| payment_context required | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | payment | |
| 404 | unit |
GET
/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 |
| currency required | string | Query |
| payment_context required | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [payment] | |
| 404 | unit |
transfer
Path: /transfers
POST
/transfers/create Used to create a transfer resource.
Parameters
| Name | Type | Description |
|---|---|---|
| transferid required | long | Form |
| senderid required | string | Form |
| amount required | double | Form |
| currency required | string | Form |
| ref_accountid_receiver required | long | Form |
| ref_accountid_sender required | long | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | transfer | |
| 409 | unit |
PUT
/transfers/update/:transferid Used to update a transfer resource.
Parameters
| Name | Type | Description |
|---|---|---|
| transferid required | long | Path |
| senderid required | string | Form |
| amount required | double | Form |
| currency required | string | Form |
| ref_accountid_receiver required | long | Form |
| ref_accountid_sender required | long | Form |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | transfer | |
| 409 | unit |
DELETE
/transfers/delete/:transferid Delete some transfer.
Parameters
| Name | Type | Description |
|---|---|---|
| transferid required | long | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 204 | unit | |
| 401 | unit | |
| 404 | unit |
GET
/transfers/:transferid Find transfer by its id
Parameters
| Name | Type | Description |
|---|---|---|
| transferid required | long | Path |
| senderid required | string | Query |
| amount required | double | Query |
| currency required | string | Query |
| ref_accountid_receiver required | long | Query |
| ref_accountid_sender required | long | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | account | |
| 404 | unit |
GET
/transfers/list Find all the transfers.
Parameters
| Name | Type | Description |
|---|---|---|
| transferid required | long | Query |
| senderid required | string | Query |
| amount required | double | Query |
| currency required | string | Query |
| ref_accountid_receiver required | long | Query |
| ref_accountid_sender required | long | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [account] | |
| 404 | unit |
validation
Public resource that can accept JSON input and returns a validation object describing any validation errors.
Path: /validations
withdraw
Path: /withdraws
DELETE
/withdraws/delete/:wdwid Delete some withdraw.
Parameters
| Name | Type | Description |
|---|---|---|
| wdwid required | long | Path |
Responses
| Code | Type | Description |
|---|---|---|
| 204 | unit | |
| 401 | unit | |
| 404 | unit |
GET
/withdraws/:wdwid Find withdraw by its id.
Parameters
| Name | Type | Description |
|---|---|---|
| wdwid required | long | Path |
| depid 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 |
| currency required | string | Query |
| payment_context required | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | payment | |
| 404 | unit |
GET
/withdraws/list List all the withdraws
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 |
| currency required | string | Query |
| payment_context required | string | Query |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | [payment] | |
| 404 | unit |