Definitions

transaction represents an fx conversion/deal/order between two currencies the base currency and counter currency a base currency amount is sold and counter currency amount is purchased, one of which is provided by the customer and the other is calculated based on the exchange rate parameters status the current state of the transaction read only status label a human readable version of status read only base currency this is the currency that the customer wants to sell counter currency this is the currency that the customer wants to buy, and send to beneficiaries via payments base currency amount the amount of base currency being sold counter currency amount the amount of counter currency being purchased exchange rate the exchange rate including any markup read only value date this is the date the fx conversion will be executed fees this is sum of fees across all payments read only receipt amount this is the total amount payable by the customer including and markup and payment fees read only receipt account this is the account the customer should pay into to settle the transaction read only payments the payments that have been added to the transaction read only created date the date the payment was created read only updated date the date the payment was updated read only states & progression status description created transaction has been created but not confirmed pending payment transaction confirmed – awaiting payment the transaction has been successfully confirmed, and the corresponding counter party transaction has been automatically created next step one or multiple payments must now be added open payments added – ready for settlement all required payments have been successfully added to the transaction next step proceed with settlement to enable the payments to be released partially settled payments added – partial settlement received all payments have been added to the transaction a partial settlement has been received next step await full settlement to release the remaining payments settled payments added – full settlement received all payments have been added to the transaction, and full settlement has been received next step payments can now be released partially released partial payment release the transaction contains multiple payments some payments have been partially released following settlement next step await release of the outstanding payments released all payments released all payments associated with this transaction have been successfully released next step await confirmation that the payments have been successfully completed this confirmation may be received via a status webhook from the external payment provider, or reconciliation of bank statements imported and matched against the relevant payments paritally complete partial payments completed some of the payments associated with this transaction have been successfully paid next step await payment confirmation for the remaining outstanding payments via status webhooks or bank statement reconciliation complete all payments completed all payments associated with this transaction have been successfully paid final state cancellation requested transaction cancellation pending approval the cancellation request for this transaction requires approval before it can be processed next step await for approval cancelled transaction cancelled the transaction has been successfully cancelled final state withdrawal a withdrawal is a type of transaction, where the customer is withdrawing funds they already have on account there is only one beneficiary associated the base currency is the same as the counter currency, which is taken from the beneficiary provided and there is no fx component payment represents an external payment to a beneficiary attributes status the current state of the payment read only amount the payment amount fee the fee that has been assigned to the payment read only beneficiary the beneficiary that has been assigned to the payment payment reference the reference that has been assigned to the payment payment type the type of payment when applicable, e g \['chaps', 'faster', 'mccy'] transaction reason the transaction reason assigned to the payment created date the date the payment was created read only updated date the date the payment was updated read only states & progression status description pending payment pending release the payment is currently pending release hold payment held for compliance review the payment is currently on hold pending compliance review unapproved payment pending signatory approval the payment requires approval from a designated signatory before it can be released released payment released – awaiting confirmation the payment has been released and is awaiting confirmation of receipt failed payment released – payment failure confirmed the payment was released, but confirmation has been received that the payment has failed repaired failed payment repaired – awaiting approval the failed payment has been repaired and is pending approval before it can be re released repair approved repaired payment approved – ready for release the repaired payment has been approved and is now ready for release paid payment successfully completed the payment has been successfully processed and paid final state cancelled payment cancelled the payment has been cancelled successfully final state beneficiary a beneficiary is a recipient of payments, from withdrawals or fx conversions they can be either individuals or organisations, and the bank details required depend on the supplied renumeration type attributes status the current state of the beneficiary read only name the name object containing the first name, middle nameand last name of the beneficiary country the beneficiary's country email the beneficiary email address the address object containing address line 1 , address line 2 , suburb , city , province , postcode , and country code remuneration type the type of beneficiary either local or priority read only reason for payment a specific reason for payment that has been assigned to the beneficiary relation with customer the relationship to the customer bank details the bank detail object containing the bank account details bank name , bank code , branch code , branch name , account name , account number , local code , international code , address line 1 , address line 2 , and country created date the date the beneficiary was created read only updated date the date the beneficiary was updated read only states & progression status description created beneficiary created – awaiting approval the beneficiary has been created and is pending approval approved by client beneficiary approved the beneficiary has been approved and is now eligible to be assigned to a payment edited beneficiary edited – awaiting approval the beneficiary details have been updated and are pending approval archived beneficiary archived the beneficiary has been successfully archived customer this is the customer record representing the end user of the application this can be an individual or an organization attributes status the current state of the customer email the email address of the customer name the name object containing the first name , middle name and last name of the customer account type the account type can be individual or company country the customers country of residence currency the customer's home currency users the users associated with the customer record if this is of company account type they can be multiple users date of birth the customer's date of birth if this is of company account type, this is for the primary contact place of birth the customer's place of birth if this is of company account type, this is for the primary contact mobile the customer's mobile number address the address object containing address line 1 , address line 2 , suburb , city , province , postcode , and country code aml details the aml object containing reason for using service , source of funds , and annual income states & progression status description pending all the required fields have been entered and the account is awaiting approval from the compliance team pending login details partial fields have been entered the login details are required in order for the account to be approved pending account details partial fields have been entered some account details are required in order for the account to be approved pending identification partial fields have been entered the identification details are required in order for the account to be approved pending directors id partial fields have been entered the director details are required in order for the account to be approved pending shareholders id partial fields have been entered the shareholder details are required in order for the account to be approved active the account has been activated rejected the account has been rejected closed the account has been closed