Skip to content

Commit

Permalink
Remove payment service from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aksalj committed Apr 25, 2023
1 parent b6a5652 commit 611774a
Showing 1 changed file with 0 additions and 135 deletions.
135 changes: 0 additions & 135 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,6 @@ Initialize the SDK as a requirement by doing `require('africastalking')(options)

- [SMS Service](#smsservice) : `AfricasTalking.SMS`

- [Payments Service](#paymentservice) : `AfricasTalking.PAYMENTS`

- [Voice Service](#voiceservice) : `AfricasTalking.VOICE`

- [Token Service](#tokenservice) : `AfricasTalking.TOKEN`
Expand Down Expand Up @@ -198,139 +196,6 @@ For more information on:
- How to listen for subscription notifications: [https://developers.africastalking.com/docs/sms/notifications](https://developers.africastalking.com/docs/sms/notifications)



### `PaymentService`

- `cardCheckoutCharge({ productName, paymentCard/checkoutToken, currencyCode, amount, narration, metadata })` Initiate a card checkout.

- `productName`: Your payment product. `REQUIRED`
- `paymentCard`: Card to charge.
- `checkoutToken`: Token from a previous successful transaction. Replaces `paymentCard`.
- `currencyCode`: 3-digit ISO format currency code. `REQUIRED`
- `amount`: Amount to charge. `REQUIRED`
- `narration`: Checkout description. `REQUIRED`
- `metadata`: Additional info to go with the checkout


- `cardCheckoutValidate({ transactionId, otp })` Validate a card checkout.

- `transactionId`: Transaction ID returned on charge request. `REQUIRED`
- `otp`: A user-provided OTP. `REQUIRED`


- `bankCheckoutCharge({ productName, bankAccount, currencyCode, amount, narration, metadata })` Initiate a bank checkout.

- `productName`: Your payment product. `REQUIRED`
- `bankAccount`: Bank account to charge. `REQUIRED`
- `currencyCode`: 3-digit ISO format currency code. `REQUIRED`
- `amount`: Amount to charge. `REQUIRED`
- `narration`: Checkout description. `REQUIRED`
- `metadata`: Additional info to go with the checkout


- `bankCheckoutValidate({ transactionId, otp })` Validate a bank checkout.

- `transactionId`: Transaction ID returned on charge request. `REQUIRED`
- `otp`: A user-provided OTP. `REQUIRED`


- `bankTransfer({ productName, recipients })` Initiate a bank transfer.

- `productName`: Your payment product. `REQUIRED`
- `recipients`: A list of banks to transfer to. `REQUIRED`


- `mobileCheckout({ productName, providerChannel, phoneNumber, currencyCode, amount, metadata })`: Initiate mobile checkout.

- `productName`: Your payment product. `REQUIRED`
- `providerChannel`: Provider channel to consider when charging.
- `phoneNumber`: Mobile wallet to charge. `REQUIRED`
- `currencyCode`: 3-digit ISO format currency code. `REQUIRED`
- `amount`: Amount to charge. `REQUIRED`
- `metadata`: Additional info to go with the checkout


- `mobileB2C({ productName, recipients })`: Send mobile money to consumer.

- `productName`: Your payment product. `REQUIRED`
- `recipients`: A list of consumers that will receive the money. `REQUIRED`


- `mobileB2B({ productName, provider, transferType, currencyCode, destinationChannel, destinationAccount, amount, requester, metadata })`: Send mobile money to busness.

- `productName`: Your payment product. `REQUIRED`
- `provider`: Provider used to process request. Checkout `payments.PROVIDER.*`. `REQUIRED`
- `transferType`: Checkout `payments.TRANSFER_TYPE.*`. `REQUIRED`
- `currencyCode`: 3-digit ISO format currency code. `REQUIRED`
- `destinationChannel`: Name or number of channel to receive payment. `REQUIRED`
- `destinationAccount`: Account name used to receive money. `REQUIRED`
- `amount`: Amount to transfer. `REQUIRED`
- `requester`: PhoneNumber through which KPLC will send tokens when using B2B to buy electricity tokens.
- `metadata`: Additional info to go with the transfer

- `mobileData(productName, recipients)`: Send mobile data to customers.

- `productName`: Payment product on Africa's Talking. `REQUIRED`
- `recipients`: A list of recipients. Each recipient has:
- `phoneNumber`: Customer phone number (in international format). `REQUIRED`
- `quantity`: Mobile data amount. `REQUIRED`
- `unit`: Mobile data unit. Can either be `MB` or `GB`. `REQUIRED`
- `validity`: How long the mobile data is valid for. Must be one of `Day`, `Week` and `Month`. `REQUIRED`
- `metadata`: Additional data to associate with the transaction. `REQUIRED`
- `walletTransfer({ productName, targetProductCode, currencyCode, amount, metadata })` Move money form one payment product to another.
- `productName`: Your payment product. `REQUIRED`
- `targetProductCode`: ID of recipient payment product on Africa's Talking. `REQUIRED`
- `currencyCode`: 3-digit ISO format currency code. `REQUIRED`
- `amount`: Amount to transfer. `REQUIRED`
- `metadata`: Additional info to go with the transfer. `REQUIRED`


- `topupStash({ productName, currencyCode, amount, metadata })` Move money from a Payment Product to an app's stash.
- `productName`: Your payment product. `REQUIRED`
- `currencyCode`: 3-digit ISO format currency code. `REQUIRED`
- `amount`: Amount to transfer. `REQUIRED`
- `metadata`: Additional info to go with the transfer. `REQUIRED`
- `fetchProductTransactions({ productName, filters })`: Fetch payment product transactions.
- `productName`: Your payment product. `REQUIRED`
- `filters`: Query filters. Includes:
- `pageNumber`: Page number to fetch results from. Starts from `1`. `REQUIRED`
- `count`: Number of results to fetch. `REQUIRED`
- `startDate`: Start Date to consider when fetching.
- `endDate`: End Date to consider when fetching.
- `category`: Category to consider when fetching.
- `prodiver`: Provider to consider when fetching.
- `status`: Status to consider when fetching.
- `source`: Source to consider when fetching.
- `destination`: Destination to consider when fetching.
- `providerChannel`: Provider channel to consider when fetching.
- `findTransaction({ transactionId })`: Find a particular transaction.
- `transactionId`: Transaction ID returned on charge request. `REQUIRED`
- `fetchWalletTransactions({ filters })`: Fetch wallet transactions.
- `filters`: Query filters. Includes:
- `pageNumber`: Page number to fetch results from. Starts from `1`. `REQUIRED`
- `count`: Number of results to fetch. `REQUIRED`
- `startDate`: Start Date to consider when fetching.
- `endDate`: End Date to consider when fetching.
- `categories`: Comma delimited list of categories to consider when fetching.
- `fetchWalletBalance()`: Fetch your wallet's balance


### `VoiceService`

- `voice.call({ callFrom, callTo })`: Initiate a phone call
Expand Down

0 comments on commit 611774a

Please sign in to comment.