Initiate a cross-border remittance

post

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

Initiates a new cross-border remittance from the wallet. Required fields vary by remittance type.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

walletId

int64

required

Body Params

additionalFields

array of objects

additionalFields

amount

number

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

beneficiaryId

int64

Optional. Who the remittance is going to. Either this or destination is required

callbackUrl

string

length between 10 and 2000

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

The URL Eclipse must post the WalletRemittanceResult to when the remittance 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

customFraudChecks

boolean

description

string

length between 0 and 200

(?s)^(?:[\t\r\n]|[^\p{C}<>])*$

destination

object

Optional. Who the remittance is going to. Either this or beneficiaryId is required

destinationAmount

number

This is only applicable when the driving currency is FX currency, as denoted by useFxCurrencyAsBase=True. Consequently, it is an optional field. If both destinationAmount and useFxCurrencyAsBase=True are provided, destinationAmount will retain its value while the amount will be adjusted

destinationCountry

string

destinationCurrency

string

required

length between 3 and 3

The destination currency - e.g. USD, ZAR, NGN, TSH

externalUniqueId

string

required

length between 6 and 100

Provide a GUID for the remittance to prevent replays/duplicates

provider

string

saveDestinationAsBeneficiary

boolean

Save the profile details of the destination as a new beneficiary against the wallet owner

useFxCurrencyAsBase

boolean

Responses

400

Bad Request

200OK

500Internal Server Error