Incoming Transfer

Create an incoming transfer. The transfer_incoming_type must be specified (SWIFT_INCOMING for MT103 or SWIFT_FI_TO_FI_INCOMING for PACS.008) and the respective transfer type's payload be filled out in the request body. For SWIFT_INCOMING, the swift parameters must be completed. For SWIFT_FI_TO_FI_INCOMING, the swift_fi_to_fi parameters must be completed.

This endpoint is only available in our sandbox environment. It is not available in production.

This endpoint facilitates the simulation and testing of incoming transaction processing within the staging environment, enabling developers to validate transfer workflows without affecting production systems.

Two transfer types are supported:

SWIFT_INCOMING — MT103 incoming transfer. Uses the swift payload field.
SWIFT_FI_TO_FI_INCOMING — PACS.008 FI-to-FI incoming transfer. Uses the swift_fi_to_fi payload field.

Example MT103 Incoming Transfer (SWIFT_INCOMING)

curl --request POST \
  --url https://developer-api-staging.pavebank.dev/v1/sandbox/transfer/incoming \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "transfer_incoming_type": "SWIFT_INCOMING",
    "swift": {
      "amount": "100000",
      "asset": "USD",
      "description": "TESTING REMITTANCE INFORMATION",
      "date": "2025-01-15T00:00:00Z",
      "beneficiary_account_id": "account_123abc456def",
      "beneficiary_name": "Jane Doe",
      "beneficiary_country": "US",
      "beneficiary_address_line_1": "123 Main Street, New York, NY 10001",
      "sending_BIC": "PAVEGE20XXX",
      "sender_correspondent_account": "123123123",
      "ordering_customer_account": "987654321",
      "ordering_customer_name": "John Doe",
      "ordering_customer_address_1": "456 Secondary Street, New York, NY 10002"
    }
  }'

Example FI-to-FI Incoming Transfer (SWIFT_FI_TO_FI_INCOMING)

curl --request POST \
  --url https://developer-api-staging.pavebank.dev/v1/sandbox/transfer/incoming \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "transfer_incoming_type": "SWIFT_FI_TO_FI_INCOMING",
    "swift_fi_to_fi": {
      "amount": "100000",
      "asset": "USD",
      "description": "TESTING REMITTANCE INFORMATION",
      "beneficiary_account_id": "account_123abc456def",
      "beneficiary_name": "Jane Doe",
      "beneficiary_address": {
        "building_name": "ABC Tower",
        "building_number": "123",
        "floor": "4AA",
        "street_name": "Main Street",
        "town_name": "New York",
        "country_sub_division": "NY",
        "country": "US",
        "postcode": "10001",
        "post_box": "PO Box 456",
        "room": "Suite 100",
        "department": "Finance",
        "sub_department": "Accounts Receivable",
        "district_name": "Manhattan",
        "town_location_name": "Downtown"
      },
      "sender_bic": "PAVEGE20XXX",
      "sender_agent_bic": "PAVEGE20XXX",
      "sender_account": "123123123",
      "sender_name": "John Doe",
      "sender_address": {
        "building_name": "DEF Tower",
        "building_number": "456",
        "floor": "4BB",
        "street_name": "Secondary Street",
        "town_name": "New York",
        "country_sub_division": "NY",
        "country": "US",
        "postcode": "10002",
        "post_box": "PO Box 789",
        "room": "Suite 200",
        "department": "Operations",
        "sub_department": "Transfer Services",
        "district_name": "Manhattan",
        "town_location_name": "Uptown"
      },
      "previous_instructing_agent1_bic": "CHASUS33XXX",
      "previous_instructing_agent2_bic": "DEUTDEFFXXX"
    }
  }'

Authorization

AuthorizationRequiredBearer <token>

Enter your token in the format: Bearer {token}

In: header

Request Body

application/jsonOptional

transfer_incoming_typeRequiredstring

enum, SWIFT_INCOMING (MT103 - will be deprecated) or SWIFT_FI_TO_FI_INCOMING (PACS.008 FI-to-FI)

Value in: "SWIFT_INCOMING" | "SWIFT_FI_TO_FI_INCOMING"

swiftobject

MT103 incoming transfer payload. Required when transfer_incoming_type is SWIFT_INCOMING.

swift_fi_to_fiobject

PACS.008 FI-to-FI incoming transfer payload. Required when transfer_incoming_type is SWIFT_FI_TO_FI_INCOMING.

Response Body

Success response

transaction_idRequiredstring

curl -X POST "https://developer-api-staging.pavebank.dev/v1/sandbox/transfer/incoming" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "transfer_incoming_type": "SWIFT_INCOMING",
    "swift": {
      "amount": "string",
      "asset": "string",
      "beneficiary_account_id": "string",
      "beneficiary_address_line_1": "string",
      "beneficiary_country": "string",
      "beneficiary_name": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "ordering_customer_account": "string",
      "ordering_customer_address_1": "string",
      "ordering_customer_name": "string",
      "sender_correspondent_account": "string",
      "sending_BIC": "string"
    },
    "swift_fi_to_fi": {
      "amount": "string",
      "asset": "string",
      "description": "string",
      "beneficiary_account_id": "string",
      "beneficiary_name": "string",
      "beneficiary_address": {
        "building_name": "string",
        "building_number": "string",
        "country": "string",
        "country_sub_division": "string",
        "department": "string",
        "district_name": "string",
        "floor": "string",
        "post_box": "string",
        "postcode": "string",
        "room": "string",
        "street_name": "string",
        "sub_department": "string",
        "town_location_name": "string",
        "town_name": "string"
      },
      "sender_bic": "string",
      "sender_agent_bic": "string",
      "sender_account": "string",
      "sender_name": "string",
      "sender_address": {
        "building_name": "string",
        "building_number": "string",
        "country": "string",
        "country_sub_division": "string",
        "department": "string",
        "district_name": "string",
        "floor": "string",
        "post_box": "string",
        "postcode": "string",
        "room": "string",
        "street_name": "string",
        "sub_department": "string",
        "town_location_name": "string",
        "town_name": "string"
      },
      "instructing_agent_bic": "string",
      "previous_instructing_agent1_bic": "string",
      "previous_instructing_agent2_bic": "string",
      "previous_instructing_agent3_bic": "string",
      "charge_bearer": "string",
      "settlement_method": "string"
    }
  }'

{
  "transaction_id": "string"
}