POST/api/v2/banking/transfers/internal

Execute an internal transfer between balances for a specific user within the authenticated company.

Authentication

Send your API key in the x-api-key header on every request.

Request body

application/json

Request body fields
FieldTypeRequiredDescription
UserIdunknownYes
SourceBalanceIdstringYes
DestinationBalanceIdstringYes
AmountunknownYes
CurrencystringYes
ReferencestringNo

Responses

201 — Created

Response 201 fields
FieldTypeRequiredDescription
SuccessbooleanNo
TransferIdstringNo
StatusstringNo
AmountunknownNo
CurrencystringNo
ProviderBankProviderNoIndicates which banking provider owns a resource
CreatedAtstring (date-time)No
ErrorMessagestringNo

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X POST "https://{base_url}/api/v2/banking/transfers/internal" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"UserId":"…","SourceBalanceId":"…","DestinationBalanceId":"…","Amount":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.