Creates a new payout.

post

https://api-sandbox.nofrixion.com/api/v1/payouts

Swagger narrows payout.currency to the currencies currently configured for holding accounts and
payout.fxDestinationCurrency to the currencies currently configured for Banking Circle FX support.
The authoritative lists for the current environment are exposed by GET /api/v1/currencies.

Authorization: End user or Merchant token is required.

User permissions required: CanCreatePayouts

Body Params

The object containing the details of the payout to create.

accountID

uuid

required

The ID of the source account for the payout.

type

string

enum

required

The type of account identifier to use for the payout destination.

Allowed:

description

string | null

currency

string

enum

required

Source payout currency. Swagger narrows this property to the currencies
currently configured for holding accounts. The authoritative list for the
current environment is exposed by GET /api/v1/currencies?capability=Holding.

Allowed:

amount

double | null

≥ 0.0001

Optional but one of Amount or FxDestinationAmount must be set.

For single currency payouts this property is mandatory.
For multi-currency payouts this property is optional. If FxDestinationAmount is set this field must be set to 0
and it will be dynamically adjusted based on the FX rate.

yourReference

string | null

The Your reference field is an optional field that gets set locally on the payer's transaction record. It does not get
sent out through the payment network. The maximum length for the field is 256 characters. An empty value is also supported.
Supported chracters:
a b c d e f g h i j k l m n o p q r s t u v w x y z
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
0 1 2 3 4 5 6 7 8 9
/ - ? : ( ) . , ' + Space
In addition the field cannot start with a : or - character.

theirReference

string | null

The Their reference field gets sent to the payee and appears on their transaction record.
The maximum length for the field varies depending on the payment network. For SEPA (Euro) it is 140 characters. For Faster Payments (GBP) it is 18 characters.
a b c d e f g h i j k l m n o p q r s t u v w x y z
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
0 1 2 3 4 5 6 7 8 9
/ - ? : ( ) . , ' + Space
In addition the field cannot start with a : or - character.

destination

object

invoiceID

string | null

Optional field to associate the payout with the invoice from an external
application such as Xero. The InvoiceID needs to be unique for each
account.

allowIncomplete

boolean

If set to true the payout will get created even if the business validation
rules fail. The basic data validation rules must still pass. The original
purpose of this flag was to allow payouts to be created from i3rd party applications,
such as Xero, that may not have things like an IBAN set for a supplier.
The missing information must be filled, either by an update from the 3rd party
application, or manually, before the payout can be submitted for processing.

tagIds

array of uuids | null

An optional list of tag ids to add to the payout.

tagIds

scheduled

boolean

Should this payout be scheduled for a future date?

scheduleDate

date-time | null

The date the payout should be submitted.

beneficiaryID

uuid | null

Optional. The ID of the beneficiary to use for the payout destination.

batchPayoutID

uuid | null

The ID of the batch payout this payout is part of.

topupPayrunID

uuid | null

Optional, if set it indicates that this payout will be used to top up
a payment account for a pay run by an internal transfer.

paymentRail

string

enum

Optional field to indicate the payment rail to use for the payout. Currently only
supports choosing between SEPA-CT and SEPA-INST for EUR payments. If not set, for a EUR
payment, the default behaviour is to attempt SEPA-INST and fallback to SEPA-CT if rejected.

Allowed:

documents

array of objects | null

List of documents to attach to the payout. Optional.
Used for identifying or associating documents with the payout.

documents

chargeBearer

string

enum

Optional field to set who should pay any fees for the payout. Typically only
used for international payments and ignored for SEPA and Faster Payments.

Allowed:

fxDestinationCurrency

string | null

enum

Optional. For an FX payout this is the currency that the beneficiary should be sent.
Swagger narrows this property to the currencies currently configured for
FX conversion support. The authoritative list for the current environment
is exposed by GET /api/v1/currencies?capability=FxConversion.

fxDestinationAmount

double | null

Optional but one of Amount or FxDestinationAmount must be set. If specified this will be the amount sent to the payee.
The payout's Amount will be dynamically adjusted based on this amount and the FX rate.

fxUseDestinationAmount

boolean

For a multi-currency payout this indicates how the Amount and FxDestinationAmount are treated.
If true the FxDestinationAmount is authoritative and the Amount is set based on the FxRate. If false then the Amount is authoritative
and the FxDestinationAmount is set based on the Amount and FxRate.

fxQuoteID

string | null

Optional. For multi-currency payouts this is the ID of a held rate that can be used for the FX conversion. If left
empty the mid-market FX rate will be used.

200OK