AtEx v0.20.21 API Reference

Modules

AtEx is an Elixir Wrapper for the Africas Talking Api Use this library to handle interaction with the Africas Talking API end points, It is most useful for

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking API Application Data endpoint, use it to POST and GET requests to the Application endpoint

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking API Application Data endpoint, use it to POST and GET requests to the Application endpoint

Base HTTP Gateway for AtEx.Gateway.Base

This module allows you to make an HTTP POST to publish messages to your remote devices.

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Bank Checkout API

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Bank Transfer API

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Bank Trabsfer Validation API

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Card Checkout API

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Card Validation API

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Mobile B2B API

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Mobile B2C API

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Mobile Checkout API

Fetch transactions of a particular payment product by sending a HTTP GET request to the following endpoint

Fetch your wallet transactions by sending a HTTP GET request to the following endpoint

Find a particular payment transaction by sending a HTTP GET request to the following endpoint

Fetch your wallet balance by sending a HTTP GET request to the following endpoint

This is the Topup stash module that implements APIs to allow you to move money from a Payment Product to an Africa’s Talking application stash. An application stash is the wallet that funds your service usage expences.

This module implements the Wallet transfer Africas Talking API endpoint to allow a user to transfer money from one Payment Product to another Payment Product hosted on Africa’s Talking.

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking API SMS endpoint, use it to POST and GET requests to the SMS endpoint

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking API Premium SMS endpoint, complete a premium sms create subscription request, incrementally fetch your premium sms subscriptions, delete a premium sms subscription

This module has the call transfer functionality of AfricasTalking it allows you to transfer your call to another number by making a HTTP POST request to the Africas Talking voice endpoints.

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Voice API endpoints to make an outbound call

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Voice API endpoint to queueing calls

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Voice API endpoint tfor uploading media file

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking API IoT endpoints

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking API Payment endpoints

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking API SMS endpoints

Overview

USSD interation with the Africas Talking API is rather simple as documented in their documentation. Whenever a user sends a USSD request, it is received by Africastalking which then sends it as a POST request to your application through the callback URL you specified. This callback URL is specified on the Africastalking dashboard, under USSD section. When you receive the request, you consume it as you deem fit then generate a response.

This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking API Voice endpoints