Account notifications

It is possible receive a callback notification from our system when one of your accounts is debited or credited. This can be useful as a way to know when funds are available, or maybe as a notification that a large value transaction has been debited.

Callbacks take the form of a HTTP request to a server you have specified. The AccountNotification data type forms the body of these requests and contains details of the account entry.

📘
Setup Required
Account Callback Notifications are not enabled by default. You will need to login to the Merchant Administration System and enable them.

Property	Type	Description
TransactionId	Number	Our internal ID for the debit/credit transaction.
IsDebit	Boolean	Flag to indicate if the transaction is a debit from the account - true if it's a debit, false if it's a credit.
IsJournalTransaction	Boolean	Flag to indicate if this is a transaction posted by our operations staff to your account (true if it is). false if this is a post associated with a transaction request through the API.
Amount	Number	Amount of the entry.
Currency	String	The three character currency code such as GBP or EUR.
Reason	String	Text indicating why the debit or credit was made. Typically this will be “Approving Journal” for any movement that is actioned by staff at Vitesse or “Moving from merchant to FX account”, or in the event of a return this will indicate the reason for that return.
ExternalReference1	String (optional)	Text reference, either manually entered in by our operations staff for journal transactions, or the value sent to the API when the original transaction was created.
ExternalReference2	String (optional)	Text reference, either manually entered in by our operations staff for journal transactions, or the value sent to the API when the original transaction was created.
ExternalReference3	String (optional)	If provided, the value of the TransactionReference3 field supplied to the API when the original transaction was created.
Narrative	String	Text narrative, either manually entered in by our operations staff for journal transactions, or a combination of the TransactionReference3 and recipient name fields.
TransactionType	String	The transaction type (see below).
AccountId	Int	The ID of the account that this debit or credit is associated with.
AccountName	String	The name of the account that was debited or credited.
CreatedOnUTC	DateTime	A timestamp when the debit or credit was recorded by the system.

{
  "TransactionId": 158,
  "IsDebit": false,
  "IsJournalTransaction": true,
  "Amount": 3.0000,
  "Currency": "GBP",
  "Reason": "Approving Journal",
  "ExternalReference1": "xxxxx",
  "ExternalReference2": "yyyyy",
  "ExternalReference3": "zzzzz",
  "Narrative": "zzzzz : Bilbo Baggins",
  "TransactionType": "MerchantLiquidity",
  "AccountId" : 12345,
  "AccountName" : "Test System GBP",
  "CreatedOnUTC" : "2017-10-16T19:37:49.0651435Z"
}

Transaction Types

There are a number of transaction types defined by our system that callbacks can be setup for. These are as follows:

Transaction Type	Description
AccountMovement	Funds movement between accounts.
AccountMovementFee	Any fees due as a result of Funds moved between accounts where the merchant liquidity accounts are debited.
Fees	Any fees due as a result of completed payments where the merchant liquidity accounts are debited.
MerchantFees	Any fees due as a result of completed payments where the merchant liquidity accounts are debited.
MerchantLiquidity	Received liquidity to fund payment requests.
MerchantLiquidityReversal	Movement of applied liquidity to a different account on request.
PayinReversal	Refund of received account funds.
Payin	Received funds into the account – not liquidity.
Payout	A payment request.
PayoutRejection	A payment that has been rejected by our network before processing – includes as much reason detail as possible.
PayoutReturned	A payment that has been returned by our network after processing – includes as much reason detail as possible.
ReturnOfFunds	A payment that is made into a Payment account when funds have been recovered in response to an initial over- payment.
RefundOfPayment	Movement of recovery funds from a payment account into an associated funding account.

Callbacks are only issued if setup by you. The callback is purely for informational purposes, and not to ensure that accounts in your system are up to date with accounts in ours. Please note - there are additional transaction events inside our system that are not reported to you, and these can alter the balance of your accounts.