Initiate a new withdrawal

post

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

Submits a withdrawal request for the wallet. The required fields depend on the withdrawal type.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

walletId

int64

required

Body Params

Initiate a withdrawal on a wallet so that a customer can cash out or have value moved to an external store of value (e.g. EFT)

accountCurrency

string

length between 3 and 3

Optional. Currency of the transaction in the destination bank account for cross currency withdrawals

accountName

string

length between 3 and 50

Account name to EFT to if applicable. For MFT this must be

accountNumber

string

length between 7 and 80

Account number to EFT or external walletid for ZM_MNO_WALLET if applicable, or crypto address

amount

number

required

≥ 1e-9

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

bank

string

length between 3 and 50

Bank to EFT to if applicable

bankCountry

string

length between 2 and 2

ISO 2 letter country code of the bank. E.g. UG

branchCode

string

length between 2 and 20

Branch code to EFT to if applicable

callbackUrl

string

length between 10 and 2000

The URL Eclipse must post the EclipseWalletWithdrawal to when the withdrawal is finalised (either successful or error). Optional as one can always do a GET to get the result instead of using callbacks. This will be a system-system call

deliverToPhone

string

Phone number to SMS withdrawal details to. If not provided then the withdrawal token details will be returned in the API and count towards the limits of the customer owning the wallet

description

string

length between 0 and 200

Optional description to appear on the wallets withdrawal

expires

date-time

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

externalUniqueId

string

required

length between 6 and 100

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

location

string

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

payshapId

string

proxy payshap id.

reference

string

length between 3 and 50

The reference the beneficiary will see on their statement

type

string

required

The type of the withdrawal

Responses

400

Bad Request

200OK

500Internal Server Error