Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
k) Wallet Topups

Update a top-up status

Updates the status of a top-up to SUCCESSFUL or ERROR_PERM. Only available in sandbox environments with the 'topup.allow.simulation' property enabled.

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

Path parameters

tenantIdinteger required
walletIdinteger required
topupIdinteger required

Request body

status'CANCELLED' | 'ERROR_PERM' | 'REVERSED' | 'SUCCESSFUL'

Updated status of a payment to either cancel a PENDING payment from being further processed, or reverse a payment that is currently SUCCESSFUL

Response

OK

amountnumber

Amount in the major currency unit e.g. 50.80 for 50 GBP and 80 pence

authCodestring
bankNamestring
cardBinstring
cardExpiresstring date-time
cardLast4string
cardNamestring
cardPhonestring
cardTypestring
createdstring date-time

When the topup was created

currencystring

Currency of the transaction. E.g. USD, ZAR, NGN etc

customerIdinteger
descriptionstring
errorDescriptionstring

This will only be populated if there was an error

expiresstring date-time

When the token expires if applicable

externalUniqueIdstring
gatewaystring
gatewayTransactionIdstring

The transaction identifier for this topup as provided by the gateway itself

organisationIdinteger
paIdstring
paymentReferencestring
status'BUILDING' | 'CANCELLED' | 'ERROR_PERM' | 'ERROR_TEMP' | 'PENDING' | 'REVERSED' | 'SUCCESSFUL' | 'TIMEOUT'

Status of a payment BUILDING: Not yet submitted as more data needs to be captured, PENDING:Being processed and can no longer be enhanced, 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

subTypestring
topupIdinteger
typestring
walletIdinteger

Example response

{
  "cardExpires": "2022-03-10T12:15:50-04:00",
  "created": "2022-03-10T12:15:50-04:00",
  "expires": "2022-03-10T12:15:50-04:00"
}