Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
l) Wallet Withdrawals

Update a withdrawal

CANCELLED is supported only when the withdrawal is PENDING and the downstream provider supports cancellation (e.g. Paycorp). SUCCESSFUL and ERROR_PERM are for sandbox simulation or production recon fixes with the ForceWithdrawalStatus.UPDATE.Allowed permission. Multi-stage withdrawals (e.g. GLOBAL_CRYPTO) can have fields updated while in BUILDING status; once sufficient information is present the gateway will automatically submit and transition the withdrawal.

put/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/withdrawals/{withdrawalId}

Path parameters

tenantIdinteger required
walletIdinteger required
withdrawalIdinteger required

Request body

gatewayTransactionIdstring
reasonstring
status'BUILDING' | 'CANCELLED' | 'ERROR' | 'PENDING' | 'SUCCESSFUL'

Status for update withdrawal.BUILDING where a withdrawal is still BUILDING, SUCCESSFUL: and ERROR:Only used when the simulation is on(allow only for sandbox). REVERSED:Only supported for paycorp ATM withdrawal, CANCELLED:Cancelled prior to SUCCESS or FAILURE PENDING: Resume a withdrawal that is on HOLD

Response

OK

amountnumber

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

createdstring date-time

When the withdrawal was created

currencystring

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

customerIdinteger
deliverToPhonestring
descriptionstring
errorDescriptionstring

This will only be populated if there was an error

expiresstring date-time

When the token expires if applicable

externalUniqueIdstring
extraInfostring

Extra information about the withdrawal. The structure of the data depends on the withdrawal gateway in use as its often the result in transaction data from the gateway

feenumber
finalAmountnumber
gatewaystring
gatewayTransactionIdstring

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

holdUntilstring date-time
lastModifiedstring date-time

When the withdrawal last modified

locationstring

Any location information about the transaction such as IP address or GPS

organisationIdinteger
reasonstring
referencestring
status'BUILDING' | 'CANCELLED' | 'ERROR' | 'HOLD' | 'PENDING' | 'REVERSED' | 'SUCCESSFUL' | 'TIMEOUT'

Status of a withdrawal. PENDING:Still being processed, SUCCESSFUL: Successfully completed, ERROR:Failed and wont ever succeed, TIMEOUT:Failed as the process was not finalised in time, CANCELLED:Cancelled prior to SUCCESS or FAILURE, REVERSED:Reversed after success

subTypestring
tokenstring

The token in case the withdrawal is via a token/identifier given at time of withdrawing and no delivery phone number was provided

tracingContextstring

Tracing data about the withdrawal

typestring
walletIdinteger
withdrawalIdinteger

Example response

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