Process an simulated incoming transaction

POST
/payin

This endpoint receives and processes a simulated incoming transaction.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

X-Volt-Api-Version*1

Version of the API used. Currently, version 1 is the only version.

Value in1

Request Body

Payload of the SimulatedIncomingTransaction event.

application/json
  1. body

The main object representing a processed incoming payment event.

externalPaymentId*string

Unique identifier for the transaction.

Formatuuid
paymentReference*PaymentReference

The reconciliation reference that appears on the bank statement. This is crucial for matching the transaction with external banking records. Maximum length: 35 (EU) or 18 (UK).

Match^(?=.*\S)[a-zA-Z0-9\/\-?:().,'+ ]*$
Length1 <= length <= 35
beneficiary*
sender*
amount?

Response Body

The simulated incoming transaction was successfully received for processing.

Example Request
curl -X POST 'https://accounts.sandbox.volt.io/payin' \  -H 'X-Volt-Api-Version: 1' \  -H 'Content-Type: application/json' \  -d '{  "externalPaymentId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",  "paymentReference": "TXNREF-20251001-XYZ-987",  "amount": {    "amount": 123,    "currency": "PLN"  },  "sender": {    "name": "John Doe",    "accountIdentifiers": {      "iban": "DE89370400440532013000"    }  },  "beneficiary": {    "accountIdentifiers": {      "iban": "DE89370400440532013000"    }  }}'
Example Response
Empty