Initiate a new wallet top-up

post

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/topups

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

walletId

int64

required

Body Params

Initiate a topup on a wallet so that a customer can top up the balance in their wallet. The type determines the topup process/flow

additionalFields

array of objects

Additional fields captured by the customer be submitted for processing. These fields relate to additionalFields requested when the topup was initiated

additionalFields

amount

number

required

≥ 1e-9

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

callbackUrl

string

length between 10 and 2000

^http(s)?:\/\/.*\..*$

cardOnFileId

string

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

expires

date-time

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

externalUniqueId

string

required

length between 6 and 100

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

landingUrl

string

length between 10 and 2000

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.

phone

string

^[0-9]{8,16}$

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

topupCardData

object

If the topup mechanism uses a card and its not a card on file (i.e. cardOnFileId not provided) then this field provides the card data to use for the topup

topupData

string

Loosely typed data about the topup Depends on the topup type

type

string

enum

required

The type of topup. Types are added/deprecated based on market demand

Responses

400

Bad Request

200OK

500Internal Server Error