The PayOut object
A PayOut
Bank wire is a request to withdraw money from a wallet to a bank account. You need to setup Bank Account before processing a PayOut Bank wire.
There is a KYC limit on Pay-Outs in order to fight fraud, money laundering and financing of terrorism. You have to send some documents through the API. Please check the rules to go over the limits
Note that successful payouts can be rejected by the recipient bank (eg the bank account is now closed, or a savings account and can't receive funds) - in this case, we will create a "payout refund" and the funds will be returned to the wallet - so it is important to check events/hook notifications for a "PAYOUT_REFUND_SUCCEEDED". You should also note that for some reasons, we'll automatically disable the bank account so you can't use it again.
Parameters
Id
string:
Maximum length is 255 characters
The item's ID
CreationDate
timestamp
When the item was created
Tag
string:
Maximum length is 255 characters
Custom data that you can add to this item
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
BankAccountId
string:
Maximum length is 255 characters
An ID of a Bank Account
BankWireRef
string:
Maximum length is 255 characters
A custom reference you wish to appear on the user’s bank statement (your Client Name is already shown). We advise you not to add more than 12 characters.
PaymentType
PayOutPaymentType:
BANK_WIRE
The payment type of the payout
The type of Pay out