Create Transaction

post

https://api.sandbox.toq.io/wallet/api/customers/{customerId}/transactions

Issues a payment on behalf of a client. Supports internal transfers, SEPA, SWIFT, UK Faster Payments and FX payments depending on the source account provider and currency. The bank payment scheme is required (except for FX); call the bankPaymentSchemes endpoint first to discover which schemes are available for the chosen source/beneficiary pair.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Read more about Create Transaction

Path Params

customerId

string

required

customerId

Body Params

issuePayment

advancedInvoiceId

string

If the payment is related to an advanced invoice, the id of it.

amount

double

required

bankPaymentScheme

string

enum

For Railsr customers this field is REQUIRED except for FX payments. Accepted codes vary by provider and currency; call GET /customers/{customerId}/clients/{clientId}/provider/{provider}/transactions/bankPaymentSchemes to obtain the schemes available for a given source/beneficiary pair.

beneficiaryAccount

object

This object is REQUIRED if beneficiaryAccountId is empty

beneficiaryAccountId

string

This field is REQUIRED if beneficiaryAccount object is empty.

beneficiaryAssetType

string

billing

boolean

Defaults to false

Indicates if a payment is a billing fee

clientType

string

enum

This field is REQUIRED if beneficiaryAccountId is empty.

Allowed:

companyId

string

required

Client ID assgined by TOQIO system

concept

string

required

^[a-zA-Z0-9\s]{1,18}$

Reference to be used for the Payment. If your provider is Railsbank , Min 1 to max 18 characters; If your provider is Modulr, Min 1 to max 18 characters that are not all the same (up to 140 characters for currencies other than GBP).

currency

string

emails

string

list of emails separated by comma

fixedSide

string

enum

Allowed:

frequency

string

enum

Allowed:

meta

object

reason

string

reference

string

for FX payments

sourceAccountId

string

required

transferConfig

object

triggerType

string

enum

Allowed:

txFee

double

userId

string

Responses

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*