View Source AtEx.Gateway.Airtime (AtEx v0.20.23)

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

Summary

Types

call_return()
send_input()

Functions

process_result(arg)

Process results from calling the gateway

send_airtime(attrs)

Sends airtime to one or more numbers, accepts a map of parameters contaitning a list of maps each containing a phone numbers and an amount of airtime to send out to a number this is expected in the recipients key.

Types

Link to this type

call_return()

View Source 
@type call_return() :: {:ok, term()} | {:error, term()}
Link to this type

send_input()

View Source 
@type send_input() :: %{recipients: [map()]}

Functions

Link to this function

process_result(arg)

View Source

Process results from calling the gateway

Link to this function

send_airtime(attrs)

View Source 
@spec send_airtime(send_input()) :: call_return()

Sends airtime to one or more numbers, accepts a map of parameters contaitning a list of maps each containing a phone numbers and an amount of airtime to send out to a number this is expected in the recipients key.

Parameters

  • map: map containing a recipients which is a list of maps each with a phone number and amount

Examples 

AtEx.Gateway.Airtime.send_airtime(%{recipients: [%{phone_number: "+254721978097", amount: "KES 50"}]})