Memo Bank API documentation

Get a transaction

GET /v2/transactions/{id}

Path parameters

id string(uuid) Required

ID of the transaction.

Responses

• 200 application/json

OK
Hide response attributes Show response attributes object
- id string(uuid) Required
  
  Unique ID of the transaction.
- reference string(uuid) Required
  
  Reference of the money movement. In case you initiate a transfer between two of your own accounts, both transactions (debit and credit) will have the same reference, it can be safely used to correlate them.
- account_id string(uuid) Required
  
  ID of the account this transaction belongs to.
- amount integer(int64) Required
  
  Amount of the transaction, in cents. The amount is always positive, use direction to give it a sign.
- local_iban string Required
  
  IBAN through which this transaction got in or out of the account. Can be the main IBAN of the account or a virtual IBAN.
- currency string Required
  
  Currency of the transaction amount, in ISO 4217 format.
- direction string Required
  
  Direction of the transaction.
  
  Values are debit or credit.
- request_date string(date-time) Required
  
  Date at which the transaction has been requested, in ISO8601 format. Usually the same as the execution date, except for scheduled transfers and transfer requests.
- execution_date string(date-time) Required
  
  Date at which the transaction processing has started or will start, in ISO8601 format. For debits, that’s when the money is removed from the available balance of the account.
- accounting_date string(date-time)
  
  Date at which the transaction has been confirmed, in ISO8601 format. For credits, that’s when the money is credited from the available balance of the account.
- counterparty_name string Required
  
  Name of the counterparty.
- internal_note string
  
  Internal note attached to this transaction, visible only in your Memo Bank workspace.
- status string Required
  
  Current status of the transaction.
  
  Values are scheduled, authorized, confirmed, rejected, or canceled.
- batch_id string(uuid)
  
  ID of the batch this transaction belongs to, if any.
- custom_id string
  
  Custom identifier attached to the transaction. It is not transmitted nor visible in your Memo Bank workspace. It can only be retrieved or used to search for transactions via Memo Bank API.
- custom_metadata string
  
  Custom metadata attached to the transaction. It is not transmitted nor visible in your Memo Bank workspace and can only be retrieved via API.
- attachment_count integer(int32)
  
  Number of documents attached to this transaction.
- source object Required
  
  One of:
  BankAccountRemunerationSource object CardDeferredSource object CardWithdrawalSource object CollectionIncomingSource object CollectionOutgoingSource object CollectionIncomingReturnSource object CollectionOutgoingReturnSource object DebtPurchaseApplicationFeesSource object DebtPurchaseDisbursementSource object DebtPurchaseInterestsSource object DebtPurchaseRepaymentSource object DiverseOperationSource object LoanApplicationFeesSource object LoanDisbursementSource object LoanGuaranteeFeeSource object LoanReimbursementSource object LoanRepaymentSource object MaintenanceTransferSource object OverdraftAgiosSource object OverdraftApplicationFeesSource object SubscriptionSource object TermDepositClosureSourceDTO object TermDepositCreationSourceDTO object TermDepositInterestPaymentSourceDTO object TermDepositWithdrawalSourceDTO object TransferIncomingSource object TransferOutgoingSource object TransferIncomingReturnSource object TransferOutgoingReturnSource object WireTransferIncomingSource object WireTransferOutgoingSource object
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attribute Show attribute
  
  type string Required Discriminator
  
  Value is bank_account_remuneration.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Value is collection_incoming.
  
  counterparty_iban string
  
  IBAN of the counterparty. Can be null on old transactions for legacy reasons.
  
  counterparty_bank_bic string
  
  BIC of the counterpart's bank. Can be null on old transactions for legacy reasons.
  
  message string
  
  Message attached to this transfer, visible by all involved parties.
  
  end_to_end_id string
  
  Unique identification to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. It can be used for reconciliation or to link tasks relating to the transaction.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Value is collection_outgoing.
  
  counterparty_iban string
  
  IBAN of the counterparty. Can be null on old transactions for legacy reasons.
  
  counterparty_bank_bic string
  
  BIC of the counterpart's bank. Can be null on old transactions for legacy reasons.
  
  message string
  
  Message attached to this transfer, visible by all involved parties.
  
  end_to_end_id string
  
  Unique identification to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. It can be used for reconciliation or to link tasks relating to the transaction.
  
  collection_id string(uuid) Required
  
  ID of the collection that created this transaction.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Value is collection_incoming_return.
  
  counterparty_iban string
  
  IBAN of the counterparty. Can be null on old transactions for legacy reasons.
  
  counterparty_bank_bic string
  
  BIC of the counterpart's bank. Can be null on old transactions for legacy reasons.
  
  message string
  
  Message attached to this transfer, visible by all involved parties.
  
  end_to_end_id string
  
  Unique identification to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. It can be used for reconciliation or to link tasks relating to the transaction.
  
  returned_collection_reference string Required
  
  Reference of the original collection being returned.
  
  reason string
  
  Reason for the return of the original collection. Can be null on old transactions for legacy reasons.
  
  Values are bank_identifier_incorrect, blocked_account, closed_account, creditor_bank_is_not_registered, creditor_psp_not_registered, customer_deceased, customer_disabled_direct_debit, debtor_psp_not_registered, disputed, duplication, end_customer_deceased, eri_option_not_supported, following_cancellation_request, fraudulent_originated, inactive_mandate, incorrect_account_number, insufficient_funds, invalid_bank_operation_code, invalid_code_or_format, invalid_creditor_account_number, invalid_debtor_account, invalid_interbank_communication, invalid_transaction_code_or_invalid_file_format, mandate_mismatch, missing_creditors_name_or_address, missing_creditor_address, missing_creditor_name_or_address, missing_debtors_name_or_address, missing_debtor_account_or_identification, missing_debtor_name_or_address, missing_mandatory_information_mandate, no_mandate, no_mandate_on_scheme, not_specified_reason_agent_generated, not_specified_reason_customer_generated, psp_identifier_incorrect, refund_request_by_bank, refund_request_by_end_customer, regulatory_reason, requested_by_the_debtor, settlement_failed, specific_service_offered_by_debtor_psp, technical_problem, transaction_forbidden, transaction_unauthorized, unrecognized_initiating_party, or wrong_amount.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Value is collection_outgoing_return.
  
  counterparty_iban string
  
  IBAN of the counterparty. Can be null on old transactions for legacy reasons.
  
  counterparty_bank_bic string
  
  BIC of the counterpart's bank. Can be null on old transactions for legacy reasons.
  
  message string
  
  Message attached to this transfer, visible by all involved parties.
  
  end_to_end_id string
  
  Unique identification to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. It can be used for reconciliation or to link tasks relating to the transaction.
  
  returned_collection_id string(uuid) Required
  
  ID of the original collection being returned.
  
  returned_collection_reference string Required
  
  Reference of the original collection being returned.
  
  reason string
  
  Reason for the return of the original collection. Can be null on old transactions for legacy reasons.
  
  Values are bank_identifier_incorrect, blocked_account, closed_account, creditor_bank_is_not_registered, creditor_psp_not_registered, customer_deceased, customer_disabled_direct_debit, debtor_psp_not_registered, disputed, duplication, end_customer_deceased, eri_option_not_supported, following_cancellation_request, fraudulent_originated, inactive_mandate, incorrect_account_number, insufficient_funds, invalid_bank_operation_code, invalid_code_or_format, invalid_creditor_account_number, invalid_debtor_account, invalid_interbank_communication, invalid_transaction_code_or_invalid_file_format, mandate_mismatch, missing_creditors_name_or_address, missing_creditor_address, missing_creditor_name_or_address, missing_debtors_name_or_address, missing_debtor_account_or_identification, missing_debtor_name_or_address, missing_mandatory_information_mandate, no_mandate, no_mandate_on_scheme, not_specified_reason_agent_generated, not_specified_reason_customer_generated, psp_identifier_incorrect, refund_request_by_bank, refund_request_by_end_customer, regulatory_reason, requested_by_the_debtor, settlement_failed, specific_service_offered_by_debtor_psp, technical_problem, transaction_forbidden, transaction_unauthorized, unrecognized_initiating_party, or wrong_amount.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attribute Show attribute
  
  type string Required Discriminator
  
  Value is debt_purchase_application_fees.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attribute Show attribute
  
  type string Required Discriminator
  
  Value is debt_purchase_disbursement.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attribute Show attribute
  
  type string Required Discriminator
  
  Value is overdraft_application_fees.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attribute Show attribute
  
  type string Required Discriminator
  
  Value is term_deposit_interest_payment.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Value is transfer_incoming.
  
  transfer_type string Required
  
  Type of the transfer.
  
  Values are standard or instant.
  
  counterparty_iban string
  
  IBAN of the counterparty. Can be null on old transactions for legacy reasons.
  
  counterparty_bank_bic string
  
  BIC of the counterpart's bank. Can be null on old transactions for legacy reasons.
  
  message string
  
  Message attached to this transfer, visible by all involved parties.
  
  end_to_end_id string
  
  Unique identification to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. It can be used for reconciliation or to link tasks relating to the transaction.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Value is transfer_outgoing.
  
  transfer_type string Required
  
  Type of the transfer.
  
  Values are standard or instant.
  
  counterparty_iban string
  
  IBAN of the counterparty. Can be null on old transactions for legacy reasons.
  
  counterparty_bank_bic string
  
  BIC of the counterpart's bank. Can be null on old transactions for legacy reasons.
  
  message string
  
  Message attached to this transfer, visible by all involved parties.
  
  end_to_end_id string
  
  Unique identification to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. It can be used for reconciliation or to link tasks relating to the transaction.
  
  transfer_id string(uuid) Required
  
  ID of the transfer that created this transaction.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Value is transfer_incoming_return.
  
  transfer_type string Required
  
  Type of the transfer.
  
  Values are standard or instant.
  
  counterparty_iban string
  
  IBAN of the counterparty. Can be null on old transactions for legacy reasons.
  
  counterparty_bank_bic string
  
  BIC of the counterpart's bank. Can be null on old transactions for legacy reasons.
  
  message string
  
  Message attached to this transfer, visible by all involved parties.
  
  end_to_end_id string
  
  Unique identification to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. It can be used for reconciliation or to link tasks relating to the transaction.
  
  returned_transfer_reference string Required
  
  Reference of the original transfer being returned.
  
  reason string
  
  Reason for the return of the original transfer. Can be null on old transactions for legacy reasons.
  
  Values are bank_identifier_incorrect, blocked_account, closed_account, creditor_bank_is_not_registered, creditor_psp_not_registered, customer_deceased, customer_disabled_direct_debit, debtor_psp_not_registered, disputed, duplication, end_customer_deceased, eri_option_not_supported, following_cancellation_request, fraudulent_originated, inactive_mandate, incorrect_account_number, insufficient_funds, invalid_bank_operation_code, invalid_code_or_format, invalid_creditor_account_number, invalid_debtor_account, invalid_interbank_communication, invalid_transaction_code_or_invalid_file_format, mandate_mismatch, missing_creditors_name_or_address, missing_creditor_address, missing_creditor_name_or_address, missing_debtors_name_or_address, missing_debtor_account_or_identification, missing_debtor_name_or_address, missing_mandatory_information_mandate, no_mandate, no_mandate_on_scheme, not_specified_reason_agent_generated, not_specified_reason_customer_generated, psp_identifier_incorrect, refund_request_by_bank, refund_request_by_end_customer, regulatory_reason, requested_by_the_debtor, settlement_failed, specific_service_offered_by_debtor_psp, technical_problem, transaction_forbidden, transaction_unauthorized, unrecognized_initiating_party, or wrong_amount.
  
  Source of the transaction. We may add additional source types over time; your application should be able to handle such additions gracefully.
  
  Hide attributes Show attributes
  
  type string Required Discriminator
  
  Value is transfer_outgoing_return.
  
  transfer_type string Required
  
  Type of the transfer.
  
  Values are standard or instant.
  
  counterparty_iban string
  
  IBAN of the counterparty. Can be null on old transactions for legacy reasons.
  
  counterparty_bank_bic string
  
  BIC of the counterpart's bank. Can be null on old transactions for legacy reasons.
  
  message string
  
  Message attached to this transfer, visible by all involved parties.
  
  end_to_end_id string
  
  Unique identification to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. It can be used for reconciliation or to link tasks relating to the transaction.
  
  returned_transfer_id string(uuid) Required
  
  ID of the original transfer being returned.
  
  returned_transfer_reference string Required
  
  Reference of the original transfer being returned.
  
  reason string
  
  Reason for the return of the original transfer. Can be null on old transactions for legacy reasons.
  
  Values are bank_identifier_incorrect, blocked_account, closed_account, creditor_bank_is_not_registered, creditor_psp_not_registered, customer_deceased, customer_disabled_direct_debit, debtor_psp_not_registered, disputed, duplication, end_customer_deceased, eri_option_not_supported, following_cancellation_request, fraudulent_originated, inactive_mandate, incorrect_account_number, insufficient_funds, invalid_bank_operation_code, invalid_code_or_format, invalid_creditor_account_number, invalid_debtor_account, invalid_interbank_communication, invalid_transaction_code_or_invalid_file_format, mandate_mismatch, missing_creditors_name_or_address, missing_creditor_address, missing_creditor_name_or_address, missing_debtors_name_or_address, missing_debtor_account_or_identification, missing_debtor_name_or_address, missing_mandatory_information_mandate, no_mandate, no_mandate_on_scheme, not_specified_reason_agent_generated, not_specified_reason_customer_generated, psp_identifier_incorrect, refund_request_by_bank, refund_request_by_end_customer, regulatory_reason, requested_by_the_debtor, settlement_failed, specific_service_offered_by_debtor_psp, technical_problem, transaction_forbidden, transaction_unauthorized, unrecognized_initiating_party, or wrong_amount.

GET /v2/transactions/{id}

curl \
 -X GET https://api.memo.bank/v2/transactions/c70bd7bc-58e0-4fdb-8c1f-70186e0de587 \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "id": "fe98f29d-5165-45ff-83f9-d7aa83e970b5",
  "reference": "fe98f29d-5165-45ff-83f9-d7aa83e970b5",
  "account_id": "708683cb-60f6-464a-a62f-be2e339c34aa",
  "amount": 42,
  "local_iban": "FR27590171083068762111832788",
  "currency": "EUR",
  "direction": "debit",
  "request_date": "2023-05-04T09:42:00+00:00",
  "execution_date": "2023-05-04T09:42:00+00:00",
  "accounting_date": "2023-05-04T09:42:00+00:00",
  "counterparty_name": "string",
  "internal_note": "phone bill",
  "status": "scheduled",
  "batch_id": "dc47b1ee-1bd7-4072-8d1b-27ff4297b33e",
  "custom_id": "637406efda8534de8c0e",
  "custom_metadata": "This is some metadata",
  "attachment_count": 42,
  "source": {
    "type": "bank_account_remuneration"
  }
}