Create a transaction

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

accountId*string

Unique identifier of the account.

Formatuuid

Header Parameters

Idempotency-Key*string

It helps preventing duplicates in your POST requests. It is recommend using a UUID for the key, however you may use any other unique identifier you choose.

Lengthlength <= 160

X-Volt-Api-Version*integer

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

Value in1

X-JWS-Signature*string

Detached JWS signature for request integrity and authenticity.

X-Volt-Testing-Scenario?string

[SANDBOX ONLY] used to trigger specific transaction failure or verification mocks.

Value in

"PAYOUT_REJECTED" | "ACCOUNT_HOLDER_VERIFICATION_CLOSE_MATCH" | "ACCOUNT_HOLDER_VERIFICATION_NO_MATCH" | "ACCOUNT_HOLDER_VERIFICATION_ERROR" | "ONBOARDING_REJECTED" | "ONBOARDING_ADDITIONAL_INFO_REQUIRED" | "ONBOARDING_EXPIRED" | "ORDER_NAMED_ACCOUNTS_FAILED"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*string

amount*integer

The total value of the transaction represented in minor units (e.g. 100 for 1.00 EUR). Must be a positive integer.

Formatint64

Range1 <= value

currency*string

Three-letter ISO 4217 currency code.

Match^[A-Z]{3}$

paymentReference*string

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

internalReference?|

Unique identifier of the transaction in the partner's system. Useful for automated reconciliation and logging.

Match^[a-zA-Z0-9!@#$%^&*()_+={\[\]};:?|\-]*$

Lengthlength <= 100

beneficiary*

communication?

type*string

Must be set to PAYOUT.

amount*integer

The total value of the transaction represented in minor units (e.g., 100 for 1.00 EUR). Must be a positive integer.

Formatint64

Range1 <= value

currency*string

Three-letter ISO 4217 currency code.

Match^[A-Z]{3}$

paymentReference*string

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

internalReference?|

Unique identifier of the transaction in the partner's system. Useful for automated reconciliation and logging.

Match^[a-zA-Z0-9!@#$%^&*()_+={\[\]};:?|\-]*$

Lengthlength <= 100

beneficiary*

communication?

type*string

Must be set to INTERNAL.

amount*integer

The total value of the transaction represented in minor units (e.g., 100 for 1.00 EUR). Must be a positive integer.

Formatint64

Range1 <= value

currency*string

Three-letter ISO 4217 currency code.

Match^[A-Z]{3}$

paymentReference*string

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

internalReference?|

Unique identifier of the transaction in the partner's system. Useful for automated reconciliation and logging.

Match^[a-zA-Z0-9!@#$%^&*()_+={\[\]};:?|\-]*$

Lengthlength <= 100

beneficiary*

The unique UUID of the account receiving the funds.

communication?

Response Body

`application/json`

curl -X POST "https://accounts.sandbox.volt.io/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/transactions" \
  -H "Idempotency-Key: 85136c79cbf9fe36bb9d05d0639c70c265c18d37" \
  -H "X-Volt-Api-Version: 1" \
  -H "X-JWS-Signature: eyJhbGciOXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "PAYOUT",
    "amount": 1000,
    "currency": "EUR",
    "paymentReference": "Reconciliation-1",
    "internalReference": "INT-99",
    "beneficiary": {
      "name": "John Doe",
      "email": "email@email.com",
      "accountIdentifiers": {
        "iban": "DE07500105176551562526",
        "swiftBic": "123456"
      },
      "address": {
        "addressLine1": "123, Main Street",
        "addressLine2": "",
        "city": "Berlin",
        "postalCode": "12332",
        "country": "DE"
      }
    },
    "communication": {
      "notifications": {
        "url": "https://mywebsite.com/webhooks"
      }
    }
  }'

curl -X POST "https://accounts.sandbox.volt.io/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/transactions" \  -H "Idempotency-Key: 85136c79cbf9fe36bb9d05d0639c70c265c18d37" \  -H "X-Volt-Api-Version: 1" \  -H "X-JWS-Signature: eyJhbGciOXXXXX" \  -H "Content-Type: application/json" \  -d '{    "type": "PAYOUT",    "amount": 1000,    "currency": "EUR",    "paymentReference": "Reconciliation-1",    "internalReference": "INT-99",    "beneficiary": {      "name": "John Doe",      "email": "email@email.com",      "accountIdentifiers": {        "iban": "DE07500105176551562526",        "swiftBic": "123456"      },      "address": {        "addressLine1": "123, Main Street",        "addressLine2": "",        "city": "Berlin",        "postalCode": "12332",        "country": "DE"      }    },    "communication": {      "notifications": {        "url": "https://mywebsite.com/webhooks"      }    }  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

{
  "code": "BAD_REQUEST",
  "message": "string"
}

{
  "code": "UNAUTHORISED",
  "message": "string"
}

{
  "code": "ACCESS_DENIED",
  "message": "string"
}

{
  "code": "RESOURCE_NOT_FOUND",
  "message": "string"
}

{
  "code": "METHOD_NOT_SUPPORTED",
  "message": "string"
}

{
  "code": "MEDIA_TYPE_NOT_ACCEPTABLE",
  "message": "string"
}

{
  "code": "CONFLICT",
  "message": "string"
}

{
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "string"
}

{
  "code": "VALIDATION_FAILURE",
  "message": "string",
  "errors": [
    {
      "type": "TOO_FEW",
      "propertyPath": "string",
      "message": "string"
    }
  ]
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "string"
}

Create a transaction

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

405application/json

406application/json

409application/json

415application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`