The Settlement Transfer object
A Settlement Transfer is a transfer
that can be used to settle the credit from a repudiation
following a lost dispute
(to impact the balance of the original wallet
and settle the credit in your client credit wallet
.
Parameters
DebitedFunds
Money:
View Sub-parameters
Information about the funds that are being debited
DebitedFunds.Currency
Currency:
AED, AUD, CAD, CHF, CZK, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR
The currency - should be ISO_4217 format
DebitedFunds.Amount
int
An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)
CreditedFunds
Money:
View Sub-parameters
Details about the funds that are being credited (DebitedFunds – Fees = CreditedFunds)
CreditedFunds.Currency
Currency:
AED, AUD, CAD, CHF, CZK, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR
The currency - should be ISO_4217 format
CreditedFunds.Amount
int
An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)
Fees
Money:
View Sub-parameters
Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)
Fees.Currency
Currency:
AED, AUD, CAD, CHF, CZK, DKK, EUR, GBP, HKD, JPY, NOK, PLN, SEK, USD, ZAR
The currency - should be ISO_4217 format
Fees.Amount
int
An amount of money in the smallest sub-division of the currency, e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY would be represented as just 12)
DebitedWalletId
string:
Maximum length is 255 characters
The ID of the wallet that was debited
CreditedWalletId
string:
Maximum length is 255 characters
The ID of the wallet where money will be credited
AuthorId
string:
Maximum length is 255 characters
A user's ID
CreditedUserId
string:
Maximum length is 255 characters
The user ID who is credited (defaults to the owner of the wallet)
Nature
TransactionNature:
REGULAR, REPUDIATION, REFUND, SETTLEMENT
The nature of the transaction
Status
TransactionStatus:
CREATED, SUCCEEDED, FAILED
The status of the transaction
ExecutionDate
timestamp
When the transaction happened
ResultCode
string:
Maximum length is 255 characters
The result code
ResultMessage
string:
Maximum length is 255 characters
A verbal explanation of the ResultCode
Type
TransactionType:
PAYIN, TRANSFER, PAYOUT
The type of the transaction
RepudiationId
string:
Maximum length is 255 characters
The ID of the associated repudiation transaction