Incoming Transfer

Create an incoming transfer. The transfer_incoming_type must be specified (e.g., SWIFT) and the respective transfer type's payload be filled out in the request body. For example, if transfer_external_type is SWIFT_INCOMING, the swift 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.

Example Incoming Transfer

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-07-10T02:41:28.40322Z",
			"beneficiary_account_id": "account_ABC123",
			"beneficiary_name": "John Smith",
			"beneficiary_country": "US",
			"beneficiary_address_line_1": "90 Somersby Avenue",
			"sending_BIC": "PAVEGE20XXX",
			"sender_correspondent_account": "123123123",
			"ordering_customer_account": "account123",
			"ordering_customer_name": "Timothy Smith",
			"ordering_customer_address_1": "55 Watsons Road"
		}
	}'

Authorization

AuthorizationRequiredBearer <token>

Enter your token in the format: Bearer {token}

In: header

Request Body

application/jsonOptional

swiftRequiredobject

transfer_incoming_typeRequiredstring

enum, SWIFT_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 '{
    "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"
    },
    "transfer_incoming_type": "string"
  }'

{
  "transaction_id": "string"
}