Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Bank Simulator

Create incoming payment

Create an incoming payment to test your integration. This endpoint can only be used in the sandbox environment.

post/simulator/{connected_account_id}/incoming_payments

Path parameters

connected_account_idstring uuid required

The connected account ID.

Request body

type'sepa' | 'sepa_instant' | 'swift'

The type of payment. Only sepa, sepa_instant and swift are supported for now.

direction'credit' | 'debit'

Either credit or debit. Describes the direction the money is flowing. A credit moves money from someone else's account to your account. A debit moves money from your account to someone else's account.

amountinteger

The absolute amount of a payment, in the specified currency's smallest units. For euro payments, the smallest unit is cents. €20 is represented as 2000.

currencystring

The three-letter ISO 4217 currency code, in lowercase.

referencestring

The reference that will appear on the origin and destination account statements, with a maximum of 140 characters.

requested_execution_datestring date

The requested execution date of the incoming payment.

fee_options'originator' | 'receiver' | 'shared'

Network payment fee preference. Only applicable to Swift payments. Supported values include originator (fee paid by the originating party), receiver (paid by the receiving party), or shared (fee split between the originating and the receiving party).

purposestring

The purpose code of the incoming payment, ensuring compliance with regulatory requirements of certain beneficiary countries. Only applicable to swift and chaps payment types.

category_purpose_codestring

The category purpose of the incoming payment. Recommended for CHAPS payments.

Example request

[
  {
    "type": "sepa",
    "direction": "credit",
    "amount": 3000,
    "currency": "EUR",
    "reference": "Invoice 1234",
    "fee_options": "shared",
    "purpose": "SALA",
    "category_purpose_code": "B2B",
    "bank_data": {
      "message_id": "1gXrtKMxLJ",
      "transaction_id": "1zDrzOMxCJ",
      "end_to_end_id": "c3b2d737bc",
      "instruction_id": "c3b2d737bc"
    },
    "originating_account": {
      "account_number": "FR7601234567891127967100082",
      "bank_code": "BNPAFRPPXXX",
      "holder_name": "PartnerCo",
      "holder_address": {
        "building_number": "1",
        "street_name": "rue de l'Abondance",
        "postal_code": "69003",
        "region_state": "Ile-de-France",
        "city": "Lyon",
        "country": "FR",
        "department": "Marketing",
        "sub_department": "Content team",
        "building_name": "Bat. 4",
        "floor": "3",
        "postal_box": "67b",
        "room": "47",
        "city_location_name": "Confluences"
      },
      "creditor_identifier": "FR12ZZZ123456",
      "organization_identification": {
        "legal_entity_identifier": "529900T8BM49AURSDO55"
      }
    },
    "receiving_account": {
      "creditor_identifier": "FR12ZZZ123456",
      "account_number": "FR7601234567891127967100082",
      "bank_code": "BNPAFRPPXXX",
      "holder_name": "PartnerCo",
      "holder_address": {
        "building_number": "1",
        "street_name": "rue de l'Abondance",
        "postal_code": "69003",
        "region_state": "Ile-de-France",
        "city": "Lyon",
        "country": "FR",
        "department": "Marketing",
        "sub_department": "Content team",
        "building_name": "Bat. 4",
        "floor": "3",
        "postal_box": "67b",
        "room": "47",
        "city_location_name": "Confluences"
      },
      "organization_identification": {
        "legal_entity_identifier": "529900T8BM49AURSDO55"
      }
    },
    "direct_debit_mandate": {
      "reference": "REF-783232"
    },
    "intermediary_agents": [
      {
        "financial_institution_identification": {
          "swift_code": "SOMEBIC0XXX",
          "bank_code": "SOMEBIC0XXX",
          "bank_code_format": "bic",
          "name": "Bank A",
          "legal_entity_identifier": "219200WSGIIZEPF1P999",
          "postal_address": {
            "line_1": "1 rue de la Paix",
            "building_number": "1",
            "street_name": "rue de la Paix",
            "postal_code": "75001",
            "city": "Paris",
            "country": "FR"
          },
          "other": {
            "identification": "35664632",
            "identification_type": "bank_identification",
            "custom_identification_type": "custom_type",
            "identification_issuer": "HMRC"
          }
        },
        "account_number": "GB7601234567890627967100010",
        "account_number_format": "iban"
      }
    ]
  }
]

Response

Incoming payment was successfully created.

Example response

{
  "files": [
    {
      "file_id": "acc2ef51-5c71-4a1e-b011-ecdbce1b9b73",
      "file_name": "SIM.V2.SOMETHING.AAABBBCCC",
      "created_at": "2025-01-26T13:51:10Z"
    }
  ]
}