Initiate a wire transfer

POST /v2/wire_transfers

Jwt

This endpoint allows you to initiate a wire transfer from your account.

application/json

Body Required

instructed_amount integer(int64) Required

Amount of the wire transfer, in the smallest unit of the instructed currency.

Minimum value is 1.
instructed_currency string Required

Currency of the wire transfer. An exchange rate will be applied if the currency differs from the currency of the local account.

Format should match the following pattern: ^[A-Z]{3}$.
local_iban string Required

Existing IBAN to be used as the source of the wire transfer. Can be the main IBAN of an account or a virtual IBAN.

Format should match the following pattern: ^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$.
beneficiary object Required

Information regarding the beneficiary of this wire transfer.
Hide beneficiary attributes Show beneficiary attributes object
- name string Required
  
  Name of the beneficiary. Will be used to create the beneficiary if one doesn't already exist with the same account_identifier, will be ignored otherwise.
- account_identifier object Required
  
  Account identifier of the beneficiary.
  
  One of:
  object-2 object object-2 object object-2 object
  
  Hide attributes Show attributes
  
  type string Required
  
  iban string Required
  
  Format should match the following pattern: ^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$.
  
  bic string Required
  
  Format should match the following pattern: ^[A-Z0-9]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$.
  
  Hide attributes Show attributes
  
  type string Required
  
  account_number string Required
  
  bic string Required
  
  Format should match the following pattern: ^[A-Z0-9]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$.
- bank_country string Required
  
  Country of the beneficiary's bank. Will be used to create the beneficiary if one doesn't already exist with the same account_identifier, will be ignored otherwise.
  
  Format should match the following pattern: ^[A-Z]{2}$.
- address object Required
  
  Address of the beneficiary. Will be used to create the beneficiary if one doesn't already exist with the same account_identifier, will be ignored otherwise.
  Hide address attributes Show address attributes object
  
  street string Required
  
  Name of the street.
  
  Minimum length is 1, maximum length is 256.
  
  postal_code string Required
  
  Postal or zip code.
  
  Minimum length is 1, maximum length is 256.
  
  city string Required
  
  Name of the city.
  
  Minimum length is 1, maximum length is 256.
  
  country string Required
  
  ISO3166-1 alpha-2 country code.
  
  Format should match the following pattern: ^[A-Z]{2}$.
- type string Required
  
  Type of the beneficiary. Will be used to create the beneficiary if one doesn't already exist with the same account_identifier, will be ignored otherwise.
  
  Values are person, company, or government.
- lei string
  
  LEI of the beneficiary. Will be used to create the beneficiary if one doesn't already exist with the same account_identifier, will be ignored otherwise. This is only required if the selected type is company.
  
  Format should match the following pattern: ^[0-9A-Z]{18}[0-9]{2}$.
purpose string Required

Purpose of this wire transfer.

Values are goods_purchase or services_purchase.
message string Required

Message attached to this wire transfer, visible to all involved parties.

Minimum length is 10, maximum length is 140.
internal_note string

Internal note attached to this wire transfer, visible only in your Memo Bank workspace.

Minimum length is 1, maximum length is 3000.
custom_id string

Custom identifier that will be attached to the transaction resulting from this wire transfer. It will not be transmitted nor visible in your Memo Bank workspace. It can only be retrieved or used to search for transactions via Memo Bank API.

Minimum length is 1, maximum length is 256.
custom_metadata string

Custom metadata that will be attached to the transaction resulting from this wire transfer. It will not be transmitted nor visible in your Memo Bank workspace and can only be retrieved via API.

Minimum length is 1, maximum length is 2048.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id string(uuid) Required
  
  ID of the wire transfer
- reference string(uuid) Required
  
  Unique reference, can be used to correlate with the resulting Transaction.
- instructed_amount integer(int64) Required
  
  Amount of the wire transfer, in the smallest unit of the instructed currency.
- instructed_currency string Required
  
  Currency of the wire transfer, in ISO 4217 format.
- account_id string(uuid)
  
  ID of the account this wire transfer belongs to, it can be missing while we process it according to the local IBAN.
- local_iban string Required
  
  IBAN used as a source of the wire transfer. It can be the main IBAN of an account or a virtual IBAN.
- beneficiary_account_identifier object Required
  
  Account identifier of the beneficiary.
  
  One of:
  object-2 object object-2 object object-2 object
  
  Hide attributes Show attributes
  
  type string Required
  
  iban string Required
  
  Format should match the following pattern: ^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$.
  
  bic string Required
  
  Format should match the following pattern: ^[A-Z0-9]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$.
  
  Hide attributes Show attributes
  
  type string Required
  
  account_number string Required
  
  bic string Required
  
  Format should match the following pattern: ^[A-Z0-9]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$.
- message string Required
  
  Message attached to this wire transfer, visible to all involved parties.
- internal_note string
  
  Internal note attached to this wire transfer, visible only in your Memo Bank workspace.
- uetr string
  
  Unique End-to-end Transaction Reference for this wire transfer. This allows you to track and trace the transaction through tools like Swift GPI.
- custom_id string
  
  Custom identifier attached to the transaction resulting from this wire transfer. 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 resulting from this wire transfer. It is not transmitted nor visible in your Memo Bank workspace and can only be retrieved via API.
- status string Required
  
  Current status of the wire transfer.
  
  Values are pending, pending_attachment_required, authorized, confirmed, returned, or failed.
- failure_code string
  
  Code that represents the failure reason when the wire transfer has failed.
  
  Values are insufficient_funds, execution_failure, maximum_amount_exceeded, current_account_not_found, transfer_to_same_account, transfer_to_owned_account_with_virtual_iban, transfer_from_saving_account_to_external_beneficiary, new_beneficiary_is_owned_iban, iban_and_bic_inconsistency, country_and_account_identifier_inconsistency, country_unavailable, currency_unavailable, amount_too_low, amount_too_high, invalid_account_identifier_for_country, invalid_routing_code_for_country, missing_beneficiary_lei, beneficiary_bank_account_closed, beneficiary_bank_error, beneficiary_bank_invalid_bank_details, beneficiary_bank_refusal, intermediary_system_error, memo_error, or memo_refusal.

POST /v2/wire_transfers

curl \
 --request POST 'https://api.memo.bank/v2/wire_transfers' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"instructed_amount":500,"instructed_currency":"EUR","local_iban":"FR6430003000509825397888D64","beneficiary":{"name":"John Doe","account_identifier":{"type":"string","iban":"FR2512739000308553756377J95","bic":"MEMOFRP2XXX"},"bank_country":"FR","address":{"street":"rue de la Boétie","postal_code":"75008","city":"Paris","country":"FR"},"type":"person","lei":"969500151TTK0D1U6N42"},"purpose":"goods_purchase","message":"invoice no12345","internal_note":"phone bill","custom_id":"637406efda8534de8c0e","custom_metadata":"This is some metadata"}'

Request examples

{
  "instructed_amount": 500,
  "instructed_currency": "EUR",
  "local_iban": "FR6430003000509825397888D64",
  "beneficiary": {
    "name": "John Doe",
    "account_identifier": {
      "type": "string",
      "iban": "FR2512739000308553756377J95",
      "bic": "MEMOFRP2XXX"
    },
    "bank_country": "FR",
    "address": {
      "street": "rue de la Boétie",
      "postal_code": "75008",
      "city": "Paris",
      "country": "FR"
    },
    "type": "person",
    "lei": "969500151TTK0D1U6N42"
  },
  "purpose": "goods_purchase",
  "message": "invoice no12345",
  "internal_note": "phone bill",
  "custom_id": "637406efda8534de8c0e",
  "custom_metadata": "This is some metadata"
}

Response examples (200)

{
  "id": "61b05c4f-3f72-4951-8c30-a2a9faaa5184",
  "reference": "ab004cfc-99fb-4ba9-bc9c-70982f853cb1",
  "instructed_amount": 500,
  "instructed_currency": "EUR",
  "account_id": "708683cb-60f6-464a-a62f-be2e339c34aa",
  "local_iban": "FR6430003000509825397888D64",
  "beneficiary_account_identifier": {
    "type": "string",
    "iban": "FR2512739000308553756377J95",
    "bic": "MEMOFRP2XXX"
  },
  "message": "invoice no12345",
  "internal_note": "phone bill",
  "uetr": "62dacdad-b003-4738-b21d-29fbfca5d1ea",
  "custom_id": "637406efda8534de8c0e",
  "custom_metadata": "This is some metadata",
  "status": "failed",
  "failure_code": "insufficient_funds"
}

Initiate a wire transfer

Body Required

account_identifier object Required

Responses

beneficiary_account_identifier object Required