Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
k) Wallet Topups

Initiate a new wallet top-up

Starts the top-up process. The response includes a completionUrl if the top-up requires a redirect (e.g. card payment via a gateway). Poll or listen for the callback to confirm the final status.

post/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/topups

Path parameters

tenantIdinteger required
walletIdinteger required

Request body

amountnumber required

The amount in the currency of the wallet. Amounts are in major currency unit

callbackUrlstring
cardOnFileIdstring

Card on file id to use for the topup - topup type dependent

expiresstring date-time

When the payment must complete by. If not in final state before this time, Eclipse will timeout the payment

externalUniqueIdstring required

Unique identifier for the topup. Duplicates are rejected to ensure double transactions are impossible

landingUrlstring

Where the customers iFrame/Browser should be navigated to after the topup - may not apply for all topup types. If the URL contains <topupId> then it will be replaced with the topupId before the redirect.

phonestring

Users primary mobile phone number. Optional/Required depending on the payment type

topupDatastring

Loosely typed data about the topup Depends on the topup type

type'GH_CBG_MOMO' | 'GH_CBG_TELLER_CASHIN' | 'KE_DTB_AIRTEL_PROMPT' | 'KE_DTB_MPESA_PROMPT' | 'KE_DTB_STK_PUSH' | 'ZA_MASTERPASS_CARD' | 'ZA_OZOW' | 'ZA_PEACH_CARD' | 'ZA_PEACH_EFT' | 'ZA_PNP_CASH' | 'ZA_SB_REQUEST_TO_PAY' required

Currently supported wallet topup types. ZA_PEACH_CARD:Card topup with Peach payments, ZA_PEACH_EFT:Instant EFT topup with Peach payments, ZA_PNP_CASH:Deposit cash at Pick n Pay teller, ZA_MASTERPASS_CARD:Card topup using masterpass, KE_DTB_STK_PUSH:Topup via a push request with STK

Example request

{
  "expires": "2022-03-10T12:15:50-04:00",
  "topupCardData": {
    "deleteAt": "2022-03-10T12:15:50-04:00"
  }
}

Response

OK

completionTokenstring

Some topup type dependent data required to complete the topup if required (.e.g. a reference to use when handing over cash at PnP. If both a completionUrl and completionToken are present then the Url should be used

completionUrlstring

URL to open in an iFrame or browser where customer can securely complete 3DS details if required

status'BUILDING' | 'CANCELLED' | 'ERROR_PERM' | 'ERROR_TEMP' | 'PENDING' | 'REVERSED' | 'SUCCESSFUL' | 'TIMEOUT'

Status of a topup. PENDING:Still being processed, SUCCESSFUL: Successfully completed, ERROR_PERM:Failed and wont ever succeed, ERROR_TEMP:Currently having an error but its being retried and may succeed or permanently fail, TIMEOUT:Failed as the process was not finalised in time, CANCELLED:Cancelled prior to SUCCESS or FAILURE, REVERSED:Reversed after success

topupIdinteger