Sign in
Payouts

Creates payouts.

<b>Authorization</b>: End user or Merchant token is required.

<b>User permissions required</b>: CanCreateBatchPayouts

post/api/v1/payouts/batchcreate

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/payouts/batchcreate
  • Auth: API key in header Authorization

Request body

accountIDstring uuid required

The ID of the source account for the payout.

type'Unknown' | 'SCAN' | 'IBAN' | 'DD' | 'BTC' | 'BIC' required

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

descriptionstring nullable
currency'EUR' | 'GBP' | 'USD' 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.

amountnumber double nullable

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.
yourReferencestring nullable

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.

theirReferencestring nullable

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.

invoiceIDstring nullable

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.

allowIncompleteboolean

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.

tagIdsstring[] nullable

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

scheduledboolean

Should this payout be scheduled for a future date?

scheduleDatestring date-time nullable

The date the payout should be submitted.

beneficiaryIDstring uuid nullable

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

batchPayoutIDstring uuid nullable

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

topupPayrunIDstring uuid nullable

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'Default' | 'SEPA_CT' | 'SEPA_INST' | 'TARGET2'

Optional field to indicate the preferred payment rail intent for the payout. If not set, provider default routing logic is applied.

chargeBearer'Default' | 'BEN' | 'OUR' | 'SHA'

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.

fxDestinationCurrency'AED' | 'AUD' | 'CAD' | 'CHF' | 'CNH' | 'CZK' | 'DKK' | 'EUR' | 'GBP' | 'HKD' | 'HUF' | 'ILS' | 'JPY' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'USD' | 'ZAR' nullable

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.

fxDestinationAmountnumber double nullable

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.

fxUseDestinationAmountboolean

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.

fxQuoteIDstring nullable

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.

tagsstring[] nullable

Optional list of tag names to add to the payout.

Example request

[
  {
    "type": "IBAN"
  }
]

Response

A PayoutsCreateResponse.

failedPayoutsobject nullable

Changes

No recorded changes to this endpoint across all 2 revisions of this API.