Skip to main content
Version: 1.0.0

Account Bank Transfers


Endpoint Overview

Our Account Bank Transfers endpoint collects withdrawals, incoming bank transfers and outgoing bank transfers. These types of transactions provide us with more complete profiles of merchants which improves the quality of the Merchant Fraud and/or the AML product for you.

Account bank transfers are only applicable under the following circumstances:

  • you are using the Merchant Fraud product and/or the AML product
  • you have visibility over merchants' bank accounts
  • the bank transfers are initiated by the merchants (if the transfers are all scheduled and automated by default, then there is no need to send bank transfers to this endpoint)

The account bank transfers can be sent either individually or in batch.

Request Parameters

Request parameters in JSON format

"transactionid": "00000001",
"transactiontype": "withdrawal",
"timestamp": 1646063615,
"merchant": "853CA6B7-79BB-DE46-049F-FC2603FAC59F",
"walletid": "893067473928",
"originalamount": 1.1,
"currency": "978",
"iban": "NL51INGB40123456789876"

Request parameters: Field Reference Table

FieldData TypePayment Fraud (Issuer)Payment Fraud (Acquirer / Processor)Merchant Fraud / AMLDescription
The unique identifier of the transaction event. Every transaction event, so auth, capture, auth_capture, etc., has its own unique ID.
The UTC time at which the transaction was made. When sending events in realtime, this will usually be 'now'. Only Unix Timestamps are accepted.
The type of transaction event. Possible values are: auth, capture, auth_capture, refund, void, top_up, incremental_auth, atm or reversal. Details about each possible value below.

auth: An authorisation is used to reserve funds on the customer's card without yet deducting them.

capture: A capture is used to immediately deduct authorised funds (up to the amount auth'd) from a customer's card. A capture should always be linked to at least one authorisation via the parenttransactionid.

auth_capture: A simultaneous combination of auth and capture in the same transaction, for when there is no need to perform these operations separately.

refund: A refund transaction returns credit to a customer's payment method.

void: A void transaction is the explicit discarding of authorisation of funds.

top_up: Increases the available credit of a credit card.

incremental_auth: A transaction that increases the authorised amount of a confirmed auth transaction that has not yet been captured.

atm: An automated teller machine (atm) transaction.

reversal: A reversal annuls the transaction and re-credits the customer's payment method. This happens directly after the transaction has taken place but before the funds have been fully processed.

none: Use only when the transactiontype is unknown.
Amount/value of the transaction in the original currency. Must be a nonnegative value.
Numerical currency code of the currency used for the transaction (ISO 4217).
The name or identifier of the merchant. This field uniquely identifies the merchant, and should not be confused with the MID. Any name or unique identifier is accepted.
IBAN (International Bank Account Number). Bank account number or ID is also sufficient.
External ID of the merchant wallet.

Response Parameters

200 OK Response
"created": 2,
"deleted": 0,
"errors": 2,
"ignored": 5,
"received": 0,
"updated": 0
Status CodeStatus MessageDescriptionSchema
200OKStandard response for successful HTTP requests.200 OK - Post-auth response
4xx, 500, 501, 502, 503, 504errorVarious error messages for unsuccessful HTTP requests.Problem response

Code samples

curl -X POST \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
--data-raw '{"data":[{"transactionid":"00000001","transactiontype":"withdrawal","timestamp":1646063615,"merchant":"853CA6B7-79BB-DE46-049F-FC2603FAC59F","walletid":"893067473928","originalamount":1.1,"currency":"978","iban":"NL51INGB40123456789876"}]}'