Make a payout in Poland (PLN)

Create a payout in the PLN currency and send it to a beneficiary NRB.

To make payouts in PLN, make a POST request to the /v3/payouts endpoint as for standard Payouts.

You also need to set the correct values for fields:

  • currency
  • account identifier
  • payment scheme.

Note that PLN payouts cannot be made with EUR schemes.

Currency

Within the create payout API request, set the currency to PLN.

Account identifier

Within the beneficiary object, set the external_account.account_identifier type to nrb or iban.

Then, pass a valid beneficiary NRB in the nrb parameter, or Polish IBAN in the iban parameter.

{
  "currency": "PLN",
  "beneficiary": {
    "type": "external_account",
    "account_identifier": {
      "type": "nrb",
      "nrb": "{your-nrb}"
    }
  },
{
  "currency": "PLN",
  "beneficiary": {
    "type": "external_account",
    "account_identifier": {
      "type": "iban",
      "iban": "{your-iban}"
    }
  },

Scheme selection

To complete a PLN payout, you can set the scheme_selection type to one of:

  • instant_preferred
  • instant_only
  • preselected.

instant_preferred

Preferably selects a payment scheme that supports instant payments. However, the API falls back to a non-instant scheme if instant payments are unavailable. The payout_executed webhook will specify the actual scheme used.

instant_only

Automatically selects a payment scheme that supports instant payments. This type is optimal when you need payments to settle quickly.

preselected

Selects a payment scheme compatible with the currency of the payment and geographic region that you are paying in. This is useful if you want full control over the scheme that a payout goes through.

When you use a preselected scheme, you need to specify a scheme_id. There are two valid scheme_ids for Polish payouts:

  • polish_domestic_express , which is an instant payment scheme
  • polish_domestic_standard , which is a non-instant payment scheme. Payments settle on the next business day.
 "scheme_selection": {
    "type": "preselected",
    "scheme_id": "polish_domestic_express"
  },

Example

A complete example of a PLN payout looks like this:

{
	"merchant_account_id": "Remitter Merch Acc ID",
	"amount_in_minor": 1,
	"currency": "PLN",
	"beneficiary": {
		"type": "external_account",
		"account_holder_name": "Beneficiary AHN",
		"account_identifier": {
			"type": "nrb",
			"nrb": "20_char_NRB_string"
		},
		"reference": "Ref Example",
		"address": {
			"address_line1": "40 Finsbury Square",
			"state": "London",
			"city": "London",
			"country_code": "GB",
			"zip": "EC2A 1PX"
		},
		"date_of_birth": "1990-01-31"
	},
	"scheme_selection": {
	  "type": "instant_preferred"
	},
}

As for standard payouts, a successful payout response contains a payout id. For example:

{
  "id": "0cd1b0f7-71bc-4d24-b209-95259dadcc20"
}