A transaction is a financial activity on an Account and it represents the debits and credits on the account. The transaction detail is dependent on the type of the transaction. The Transaction object represents completed transactions associated with the bank account, including the amount, type of transaction, destination and source details.
You cannot create, delete or update transactions as they represent the actual movement of funds in your account. For example, when you make a payout request, a corresponding transaction entry is recorded on the Merge platform with a unique identifier of type as funds_out. Likewise, when you receive funds in your Account created on the Merge platform, a corresponding transaction entry is recorded on the Merge platform with a unique identifier of type as funds_in.
The Transaction object is composed of the attributes listed below:
transaction_id string
The unique identifier (UUID) of the transaction.
Example: 2f546c20-499e-11ed-b878-0242ac120002
account_id string
The unique identifier (UUID) of the account.
Example: 6105b9d6-499e-11ed-b878-0242ac120002
company_id string
The unique identifier (UUID) of the company.
Example: 2a05b9d6-499e-11ed-b878-0242ac120001
client_reference string
The transaction reference used by you when the payment is created.
Example: Merge
status enum
The status of the transaction. Check Transaction Statuses to have a better understanding of each status.
Possible enum values: processing, successful, or failed
source enum
The nature of the transaction, such as incoming and outgoing. Important: This attribute is scheduled for depreciation and will be replaced by payment_type.
Possible enum values: incoming or outgoing
payment_type enum
Type of transaction, such as payin, payout and fee.
Possible enum values: payin, payout, or fee
type enum
The direction in which funds are moved. If funds_in the amount is deposited in your account. If funds_out the amount is deducted from your account. Important: This attribute is scheduled for depreciation and will be replaced by payment_direction
Possible enum values: funds_in or funds_out
payment_direction enum
The direction in which funds are moved. If funds_in the amount is deposited in your account. If funds_out the amount is deducted from your account.
Possible enum values: funds_in or funds_out
amount string
The transaction amount, which will be reflected in your balance. This amount is in the transaction's currency.
Example: 123.12
currency enum
The currency in which the transaction was posed based on the three-letter ISO 4217 code.
Possible enum values: GBP or EUR
fee_amount string
The fee paid for the transaction.
Example: 0.12
reference string
The transaction's reference.
Example: outgoing
destination_name string
The account holder's name in the destination bank account that received the funds.
Example: John Smith
destination_type string
The type of account that received the funds.
Example: business account
destination_account_number string
The number of the destination account that received the funds.
Example: 71824905
destination_sort_code string
The sort code associated with the destination account that received the funds. It is a 6-digit number that identifies both the bank (in the first digit or the first two digits) and the branch where the account is held.
Example: 12-34-56
destination_bic string
The business identifier code (BIC) associated with the destination EUR account. The BIC is an 8 to 11-character code consisting of the business party prefix (four alphanumeric), the country code (two alphabetic), and the business party suffix. This attribute is optional for EUR accounts.
Example: MOCKGB21
destination_iban string
The International Bank Account Number (IBAN), associated with the destination EUR account. The IBAN number consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters. This attribute is only mandatory for EUR accounts.
Example: GB60MOCK00000002166663
destination_email string
The destination account holder's email.
Example: [email protected]
destination_summary string
A summary of the destination account that is shown with the account holder's name in the trasaction statement on the Merge platform.
Example: GB Account
source_name string
The account holder's name of the source bank account that sent the funds.
Example: Jane Smith
source_type string
The type of account that sent the funds.
Example: business account
source_account_number string
The number of the source account from which the funds were sent.
Example: 01892834
source_sort_code string
The sort code associated with the source account from which the funds were sent. It is a 6-digit number that identifies both the bank (in the first digit or the first two digits) and the branch where the account is held.
Example: 00-00-00
source_bic string
The business identifier code (BIC) associated with the source EUR account. The BIC is an 8 to 11-character code consisting of the business party prefix (four alphanumeric), the country code (two alphabetic), and the business party suffix. This attribute is optional for EUR accounts.
Example: MOCKGB21
source_iban string
The International Bank Account Number (IBAN), associated with the source EUR account. The IBAN number consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters. This attribute is only mandatory for EUR accounts.
Example: GB60MOCK00000002166663
source_email string
The source account holder's email.
Example: [email protected]
source_summary string
A summary of the source account that is shown with the account holder's name in the trasaction statement on the Merge platform.
Example: GB Account
payment_date timestamp
ISO 8601 timestamp at which the transaction has been processed. For funds received in your account, this is the date when they are credited into your account. For payout from your account, this is the date when the payment is actually debited and processed from your account.
Example: 2022-10-05T22:36:19.612440+00:00
created_at timestamp
ISO 8601 timestamp at which the transaction was created.
Example: 2022-10-05T22:36:19.612440+00:00
updated_at timestamp
ISO 8601 timestamp at which the transaction was last updated.
Example: 2022-10-05T22:36:19.612440+00:00
member_id string
The unique identifier of the member.
Example: af221980-450b-11ed-b878-0242ac120002
member_type string
The type of the associated member, the value can be business or linked_individual.
Possible values: business or linked_individual
reversal_reason string
The reason for the payin is being reversed.
⚠️ Relevant only for Payin Reversal endpoint. ⚠️
Possible values: order_refund or order_cancelled
parent_transaction_id string
The unique identifier of the payin to be reversed.
⚠️ Relevant only for Payin Reversal endpoint. ⚠️
account_holder_name string
The account's holder name. Must match the `source_name` in the payin.
⚠️ Relevant only for Payin Reversal endpoint. ⚠️
Transaction Statuses
| Transaction Status | Description |
|---|---|
processing |
The inital state for all transactions when they have been created and submiited to the network for further processing.This is a transient state. |
successful |
The transaction has been sucessfully posted and funds are added or deducted successfully from the account. This is a final state. |
failed |
The transaction failed. This is final state. |