POST
Create New Transfer Transaction

Body

application/json

Request to create a new transfer transaction

account_id
string<uuid>
required

Account UUID initiating the transfer

cr_bank_bic
string
required
cr_iban
string
required
cr_name
string
required
credit_amount
string
required

Credit amount

Example:

"1000.00"

debit_amount
string
required

Debit amount

Example:

"1000.00"

direction
enum<string>
required

Transfer direction

Available options:
INBOUND,
OUTBOUND
dr_bank_bic
string
required
dr_iban
string
required
dr_name
string
required
method
enum<string>
required

Transfer method/rail

Available options:
SEPA,
INTERNAL,
SDD,
SDD_INTERNAL,
INST,
CARD,
SWIFT,
DOMESTIC
purpose
string
required
settlement_date
string<date>
required

Settlement date (YYYY-MM-DD)

transfer_type
enum<string>
required

Transfer type

Available options:
FEE,
PAYMENT,
PAYMENT_CANCELLATION,
PAYMENT_RETURN,
FEE_CANCELLATION,
CCY_EXCHANGE,
ADJUSTMENT,
PAYMENT_TECHNICAL_REVERSAL,
PAYMENT_REVERSAL,
CARD_AUTH,
CARD_ADVICE,
CARD_REVERSAL,
FX_POSITION_CLOSING,
CARD_CLEARING
unique_reference
string
required

Unique reference for idempotency

beneficiary_id
string<uuid> | null

Beneficiary UUID (required for outbound transfers)

category_purpose_code
string | null
cr_address
string | null
cr_bank_name
string | null
cr_city
string | null
cr_country_code
string | null

ISO 3166-1 alpha-3 country code

cr_postal_code
string | null
credit_currency
string

Credit currency (ISO 4217)

debit_currency
string

Debit currency (ISO 4217)

dr_address
string | null
dr_bank_name
string | null
dr_city
string | null
dr_country_code
string | null

ISO 3166-1 alpha-3 country code

dr_postal_code
string | null
exchange_rate
string | null

Exchange rate (if currency conversion)

Example:

"1.085600"

fx_fee_amount
string | null

FX fee amount

Example:

"5.00"

is_instant
boolean

Is this an instant transfer

parent_transaction_id
string<uuid> | null

Parent transaction ID (for related transactions)

purpose_code
string | null
structured_reference
string | null
structured_reference_issuer
string | null

Response

Transfer created successfully

Transfer Transaction - Represents a bank transfer (SEPA, SWIFT, Domestic, etc.)

account_id
string<uuid>
required
cr_bank_bic
string
required
cr_iban
string
required
cr_name
string
required
created_at
string<date-time>
required
credit_amount
string
required
Example:

"1000.00"

credit_currency
string
required
debit_amount
string
required
Example:

"1000.00"

debit_currency
string
required
direction
enum<string>
required

Transfer Direction - Indicates if money is coming in or going out

Available options:
INBOUND,
OUTBOUND
dr_bank_bic
string
required
dr_iban
string
required
dr_name
string
required
id
string<uuid>
required
is_instant
boolean
required
method
enum<string>
required

Transfer Method - The payment method/rail used

Available options:
SEPA,
INTERNAL,
SDD,
SDD_INTERNAL,
INST,
CARD,
SWIFT,
DOMESTIC
purpose
string
required
settlement_date
string<date>
required
status
enum<string>
required

Transfer Status - Current status of the transfer transaction

Available options:
CREATED,
SIGNED,
REVIEW,
READY_TO_CLEAR,
SENT_TO_PACK,
PACKED,
SENT_TO_CLEAR,
COMPLETED,
SOME_PROBLEMS,
CANCELLED,
REJECTED,
INVALID,
ACCEPTED,
TO_SIGN,
RESERVED,
TO_RESERVE,
RECEIVED,
DROPPED,
ON_HOLD,
READY_FOR_SCREENING,
AML_APPROVED,
AML_REJECTED,
MANUAL_ACTION,
CREDIT_TECH_BALANCE,
TO_RESEND,
MANUAL_REJECTED,
TO_CANCEL,
BLACKLIST_SCANNING,
AML_SCANNING,
TO_RETURN
transfer_type
enum<string>
required

Transfer Type - The type/nature of the transfer

Available options:
FEE,
PAYMENT,
PAYMENT_CANCELLATION,
PAYMENT_RETURN,
FEE_CANCELLATION,
CCY_EXCHANGE,
ADJUSTMENT,
PAYMENT_TECHNICAL_REVERSAL,
PAYMENT_REVERSAL,
CARD_AUTH,
CARD_ADVICE,
CARD_REVERSAL,
FX_POSITION_CLOSING,
CARD_CLEARING
unique_reference
string
required
updated_at
string<date-time>
required
bank_partner_id
string | null
bank_partner_trx_id
integer<int64> | null
beneficiary_id
string<uuid> | null
category_purpose_code
string | null
cr_account_id
string | null
cr_address
string | null
cr_bank_name
string | null
cr_city
string | null
cr_country_code
string | null
cr_postal_code
string | null
dr_account_id
string | null
dr_address
string | null
dr_bank_name
string | null
dr_city
string | null
dr_country_code
string | null
dr_postal_code
string | null
exchange_rate
string | null
Example:

"1.085600"

fx_fee_amount
string | null
Example:

"5.00"

parent_transaction_id
string<uuid> | null
purpose_code
string | null
signed_at
string<date-time> | null
status_reason
string | null
status_reason_code
string | null
structured_reference
string | null
structured_reference_issuer
string | null
third_party_status
string | null
third_party_status_code
string | null
third_party_status_reason
string | null