Africa's Talking Payments (Preview)

Charge and send payments to more than 300 million mobile, bank and card account holders across Africa.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet

Contact
Name	Advice and answers from the Africa's Talking Team
URL	https://help.africastalking.com/en/
Email	payments@africastalking.com

Connector Metadata
Publisher	Africa's Talking
Website	https://africastalking.com/payments
Privacy policy	https://africastalking.com/privacy_policy
Categories	Finance

Africa's Talking Payments provides a powerful API that allows you to charge and send payments to more than 300 million mobile account holders across Africa. This connectors exposes a couple of operations that allow you to seamlessly receive payments from payment providers, as well as initiate payments going out to your customers.

Prerequisites

In order to use this connector, you will need the following:

• An account with Africa's Talking; you can sign up here.
• An application (sandbox or production). By default, a sandbox app is created for you when you sign up, but you can create a production application afterwards if you need one.
• A payments product. If using a sandbox application, you can go ahead and create one under Payments > Products. For a production ready application, you'll have to request for a payment product first.

How to get credentials?

This connector uses API Key authentication. Once you've signed up and you have an application (either sandbox or production ready), click on this application to switch to its dashboard. Navigate to Settings > API Key to generate a new API Key.

You'll also be required to select an environment to use with this connector, either sandbox or production. Choose an appropriate option depending on the type of application you are using. Note that when using the sandbox environment, the username field to be used in all operations should be sandbox; otherwise, the username will be your production application username.

Creating a connection

To connect your account, you will need the following information:

Name	Type	Description
API Key	securestring	The API Key for this api
Environment	string	The API environment to use; either production or sandbox

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Fetch Product Transactions	Fetch transactions of a particular payment product.
Fetch Wallet Balance	Fetch your wallet balance.
Fetch Wallet Transactions	Fetch your wallet transactions.
Mobile B2B (Business to Business)	Send payments to businesses e.g banks from your Payment Wallet.
Mobile B2C (Business to Consumer)	Send payments to mobile subscribers from your Payment Wallet.
Mobile Checkout	Initiate a Customer to Business (C2B) payments on a mobile subscriber's device.
Top Up Stash	Move money from a Payment Product to an Africa's Talking application stash.
Wallet transfer	Transfer money from one Payment Product to another Payment Product hosted on Africa's Talking.

Fetch Product Transactions

Operation ID:

FetchProductTransactions

Fetch transactions of a particular payment product.

Parameters

Name	Key	Required	Type	Description
Username	username	True	string	Your application username.
Product Name	productName	True	string	The name of the payment product whose transactions you'd like to fetch.
Page Number	pageNumber	True	integer	The number of the page you'd like to read results from.
Count	count	True	integer	The number of transaction results you would like for this query.
Start Date	startDate		string	Transaction start date you would like to consider in the format YYYY-MM-DD
End Date	endDate		string	Transaction end date you would like to consider in the format YYYY-MM-DD.
Category	category		string	Transaction category you would like to consider.
Provider	provider		string	Transaction provider you would like to consider.
Status	status		string	Transaction status you would like to consider.
Source	source		string	Transaction source you would like to consider.
Destination	destination		string	Transaction destination you would like to consider.
Provider Channel	providerChannel		string	Transaction provider channel you would like to consider.

Returns

Name	Path	Type	Description
description	description	string	description
status	status	string	status
responses	responses	array of object	responses
reason	responses.requestMetadata.reason	string	reason
sourceType	responses.sourceType	string	sourceType
source	responses.source	string	source
provider	responses.provider	string	provider
destinationType	responses.destinationType	string	destinationType
description	responses.description	string	description
providerChannel	responses.providerChannel	string	providerChannel
transactionFee	responses.transactionFee	string	transactionFee
providerRefId	responses.providerRefId	string	providerRefId
recipientIsRegistered	responses.providerMetadata.recipientIsRegistered	string	recipientIsRegistered
recipientName	responses.providerMetadata.recipientName	string	recipientName
status	responses.status	string	status
productName	responses.productName	string	productName
category	responses.category	string	category
transactionDate	responses.transactionDate	string	transactionDate
destination	responses.destination	string	destination
value	responses.value	string	value
transactionId	responses.transactionId	string	transactionId
creationTime	responses.creationTime	string	creationTime

Fetch Wallet Balance

Operation ID:

FetchWalletBalance

Fetch your wallet balance.

Parameters

Name	Key	Required	Type	Description
Username	username	True	string	Your application username.

Returns

Name	Path	Type	Description
balance	balance	string	balance
status	status	string	status

Fetch Wallet Transactions

Operation ID:

FetchWalletTransactions

Fetch your wallet transactions.

Parameters

Name	Key	Required	Type	Description
Username	username	True	string	Your application username
Page Number	pageNumber	True	integer	The number of the page you'd like to read results from
Count	count	True	integer	The number of transaction results you would like for this query.
Start Date	startDate			Transaction start date you would like to consider in the format YYYY-MM-DD.
End Date	endDate		string	Transaction end date you would like to consider in the format YYYY-MM-DD

Returns

Name	Path	Type	Description
status	status	string	status
responses	responses	array of object	responses
description	responses.description	string	description
balance	responses.balance	string	balance
date	responses.date	string	date
category	responses.category	string	category
reason	responses.transactionData.requestMetadata.reason	string	reason
sourceType	responses.transactionData.sourceType	string	sourceType
source	responses.transactionData.source	string	source
provider	responses.transactionData.provider	string	provider
destinationType	responses.transactionData.destinationType	string	destinationType
description	responses.transactionData.description	string	description
providerChannel	responses.transactionData.providerChannel	string	providerChannel
transactionFee	responses.transactionData.transactionFee	string	transactionFee
providerRefId	responses.transactionData.providerRefId	string	providerRefId
recipientIsRegistered	responses.transactionData.providerMetadata.recipientIsRegistered	string	recipientIsRegistered
recipientName	responses.transactionData.providerMetadata.recipientName	string	recipientName
status	responses.transactionData.status	string	status
productName	responses.transactionData.productName	string	productName
category	responses.transactionData.category	string	category
transactionDate	responses.transactionData.transactionDate	string	transactionDate
destination	responses.transactionData.destination	string	destination
value	responses.transactionData.value	string	value
transactionId	responses.transactionData.transactionId	string	transactionId
creationTime	responses.transactionData.creationTime	string	creationTime
value	responses.value	string	value
transactionId	responses.transactionId	string	transactionId

Mobile B2B (Business to Business)

Operation ID:

MobileB2B

Send payments to businesses e.g banks from your Payment Wallet.

Parameters

Name	Key	Required	Type	Description
Username	username	True	string	Your application username.
Product Name	productName	True	string	Your Africa's Talking Payment Product to initiate this transaction.
Provider	provider	True	string	Provider that will be used to process the B2B request.
Transfer type	transferType	True	string	Transfer type of the payment.
Currency Code	currencyCode	True	string	Currency code for the value of this transaction
Amount	amount	True	float	Amount - in the provided currency - that the client is expected to confirm.
Destination Channel	destinationChannel	True	string	The name/number of the channel that will receive payment.
Destination Account	destinationAccount	True	string	The account name used by the business to receive money.

Returns

Name	Path	Type	Description
providerChannel	providerChannel	string	providerChannel
status	status	string	status
transactionFee	transactionFee	string	transactionFee
transactionId	transactionId	string	transactionId

Mobile B2C (Business to Consumer)

Operation ID:

MobileB2C

Send payments to mobile subscribers from your Payment Wallet.

Parameters

Name	Key	Required	Type	Description
Username	username	True	string	Your application username.
Product Name	productName	True	string	Africa's Talking Payment Product to initiate this transaction.
Phone Number	phoneNumber	True	string	Phone number of the B2C transaction recipient.
Currency Code	currencyCode	True	string	Currency code for the value of this transaction.
Amount	amount	True	float	Amount - in the provided currency - that the client is expected to confirm.
Provider channel	providerChannel		string	The channel the payment will be made from e.g a paybill number.
Reason	reason		string	Purpose of the payment.
Name	name		string	Name of the B2C transaction recipient.

Returns

Name	Path	Type	Description
entries	entries	array of object	entries
phoneNumber	entries.phoneNumber	string	phoneNumber
provider	entries.provider	string	provider
providerChannel	entries.providerChannel	string	providerChannel
status	entries.status	string	status
transactionId	entries.transactionId	string	transactionId
value	entries.value	string	value
transactionFee	entries.transactionFee	string	transactionFee
numQueued	numQueued	integer	numQueued
totalTransactionFee	totalTransactionFee	string	totalTransactionFee
totalValue	totalValue	string	totalValue

Mobile Checkout

Operation ID:

MobileCheckout

Initiate a Customer to Business (C2B) payments on a mobile subscriber's device.

Parameters

Name	Key	Required	Type	Description
Username	username	True	string	Your application username.
Product Name	productName	True	string	Your Africa's Talking Payment product to initiate this transaction.
Provider Channel	providerChannel		string	The provider channel the payment will be initiated from e.g a paybill number.
Phone Number	phoneNumber	True	string	Phone number - in international format - of the client that will complete this transaction.
Currency Code	currencyCode	True	string	Currency code for the value of this transaction.
Amount	amount	True	float	Amount - in the provided currency - that the client is expected to confirm.

Returns

Name	Path	Type	Description
description	description	string	description
providerChannel	providerChannel	string	providerChannel
status	status	string	status
transactionId	transactionId	string	transactionId

Top Up Stash

Operation ID:

TopUpStash

Move money from a Payment Product to an Africa's Talking application stash.

Parameters

Name	Key	Required	Type	Description
Username	username	True	string	Your application username.
Product Name	productName	True	string	Africa's Talking Payment product to initiate this transaction.
Currency Code	currencyCode	True	string	Currency code for the value of this transaction
Amount	amount	True	float	Amount - in the provided currency - that the application will be topped up with.

Returns

Name	Path	Type	Description
description	description	string	description
status	status	string	status
transactionId	transactionId	string	transactionId

Wallet transfer

Operation ID:

WalletTransfer

Transfer money from one Payment Product to another Payment Product hosted on Africa's Talking.

Parameters

Name	Key	Required	Type	Description
Username	username	True	string	Your application's username.
Product Name	productName	True	string	Your Africa's Talking Payment product to initiate this transaction.
Target Product Code	targetProductCode	True	integer	Unique product code of the Africa's Talking Payment Product to transfer the funds to.
Currency Code	currencyCode	True	string	Currency code for the value of this transaction.
Amount	amount	True	float	Amount - in the provided currency - that the application will be topped up with.

Returns

Name	Path	Type	Description
description	description	string	description
status	status	string	status
transactionId	transactionId	string	transactionId