Preview an external bank payout for a ready customer account

curl --request POST \
  --url https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": "<string>",
  "beneficiary": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "address": {
      "line_1": "<string>",
      "city": "<string>",
      "country": "<string>",
      "line_2": "<string>",
      "state": "<string>",
      "postal_code": "<string>"
    }
  },
  "bank": {
    "account_holder_name": "<string>",
    "country": "<string>",
    "scheme": "<string>",
    "swift_bic": "<string>",
    "iban": "<string>",
    "routing_number": "<string>",
    "account_type": "<string>",
    "bank_institution_number": "<string>",
    "transit_number": "<string>",
    "bank_code": "<string>",
    "account_number": "<string>",
    "email": "<string>",
    "bank_name": "<string>"
  }
}
'

import requests

url = "https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview"

payload = {
    "amount": "<string>",
    "beneficiary": {
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "address": {
            "line_1": "<string>",
            "city": "<string>",
            "country": "<string>",
            "line_2": "<string>",
            "state": "<string>",
            "postal_code": "<string>"
        }
    },
    "bank": {
        "account_holder_name": "<string>",
        "country": "<string>",
        "scheme": "<string>",
        "swift_bic": "<string>",
        "iban": "<string>",
        "routing_number": "<string>",
        "account_type": "<string>",
        "bank_institution_number": "<string>",
        "transit_number": "<string>",
        "bank_code": "<string>",
        "account_number": "<string>",
        "email": "<string>",
        "bank_name": "<string>"
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '<string>',
    beneficiary: {
      first_name: '<string>',
      last_name: '<string>',
      email: '<string>',
      address: {
        line_1: '<string>',
        city: '<string>',
        country: '<string>',
        line_2: '<string>',
        state: '<string>',
        postal_code: '<string>'
      }
    },
    bank: {
      account_holder_name: '<string>',
      country: '<string>',
      scheme: '<string>',
      swift_bic: '<string>',
      iban: '<string>',
      routing_number: '<string>',
      account_type: '<string>',
      bank_institution_number: '<string>',
      transit_number: '<string>',
      bank_code: '<string>',
      account_number: '<string>',
      email: '<string>',
      bank_name: '<string>'
    }
  })
};

fetch('https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => '<string>',
    'beneficiary' => [
        'first_name' => '<string>',
        'last_name' => '<string>',
        'email' => '<string>',
        'address' => [
                'line_1' => '<string>',
                'city' => '<string>',
                'country' => '<string>',
                'line_2' => '<string>',
                'state' => '<string>',
                'postal_code' => '<string>'
        ]
    ],
    'bank' => [
        'account_holder_name' => '<string>',
        'country' => '<string>',
        'scheme' => '<string>',
        'swift_bic' => '<string>',
        'iban' => '<string>',
        'routing_number' => '<string>',
        'account_type' => '<string>',
        'bank_institution_number' => '<string>',
        'transit_number' => '<string>',
        'bank_code' => '<string>',
        'account_number' => '<string>',
        'email' => '<string>',
        'bank_name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview"

	payload := strings.NewReader("{\n  \"amount\": \"<string>\",\n  \"beneficiary\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"address\": {\n      \"line_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line_2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    }\n  },\n  \"bank\": {\n    \"account_holder_name\": \"<string>\",\n    \"country\": \"<string>\",\n    \"scheme\": \"<string>\",\n    \"swift_bic\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"account_type\": \"<string>\",\n    \"bank_institution_number\": \"<string>\",\n    \"transit_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"email\": \"<string>\",\n    \"bank_name\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"<string>\",\n  \"beneficiary\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"address\": {\n      \"line_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line_2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    }\n  },\n  \"bank\": {\n    \"account_holder_name\": \"<string>\",\n    \"country\": \"<string>\",\n    \"scheme\": \"<string>\",\n    \"swift_bic\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"account_type\": \"<string>\",\n    \"bank_institution_number\": \"<string>\",\n    \"transit_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"email\": \"<string>\",\n    \"bank_name\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"<string>\",\n  \"beneficiary\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"address\": {\n      \"line_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line_2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    }\n  },\n  \"bank\": {\n    \"account_holder_name\": \"<string>\",\n    \"country\": \"<string>\",\n    \"scheme\": \"<string>\",\n    \"swift_bic\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"account_type\": \"<string>\",\n    \"bank_institution_number\": \"<string>\",\n    \"transit_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"email\": \"<string>\",\n    \"bank_name\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Payout preview",
  "data": {
    "preview_token": "nvpay.eyJhbGciOiJIUzI1NiJ9.preview",
    "currency": "NGN",
    "from_account_id": 39,
    "amount": "1.00",
    "fee": null,
    "receive_amount": null,
    "fee_status": "pending_confirm",
    "scheme": "nip",
    "destination": {
      "rail": "bank",
      "country": "NG",
      "scheme": "nip",
      "bank_name": "Access Bank",
      "account_number_masked": "****0031"
    },
    "expires_at": "2026-09-14T12:10:00+00:00",
    "customer_id": "pcus_a1b2c3d4e5f6"
  }
}

{
  "status": "error",
  "message": "Unauthorized",
  "data": null
}

{
  "status": "error",
  "message": "Insufficient balance",
  "data": {
    "available": "0.00",
    "amount": "1.00",
    "currency": "NGN"
  }
}

POST

partner

customers

{customer_id}

accounts

{account_id}

payouts

preview

Preview an external bank payout for a ready customer account

curl --request POST \
  --url https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": "<string>",
  "beneficiary": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "address": {
      "line_1": "<string>",
      "city": "<string>",
      "country": "<string>",
      "line_2": "<string>",
      "state": "<string>",
      "postal_code": "<string>"
    }
  },
  "bank": {
    "account_holder_name": "<string>",
    "country": "<string>",
    "scheme": "<string>",
    "swift_bic": "<string>",
    "iban": "<string>",
    "routing_number": "<string>",
    "account_type": "<string>",
    "bank_institution_number": "<string>",
    "transit_number": "<string>",
    "bank_code": "<string>",
    "account_number": "<string>",
    "email": "<string>",
    "bank_name": "<string>"
  }
}
'

import requests

url = "https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview"

payload = {
    "amount": "<string>",
    "beneficiary": {
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "address": {
            "line_1": "<string>",
            "city": "<string>",
            "country": "<string>",
            "line_2": "<string>",
            "state": "<string>",
            "postal_code": "<string>"
        }
    },
    "bank": {
        "account_holder_name": "<string>",
        "country": "<string>",
        "scheme": "<string>",
        "swift_bic": "<string>",
        "iban": "<string>",
        "routing_number": "<string>",
        "account_type": "<string>",
        "bank_institution_number": "<string>",
        "transit_number": "<string>",
        "bank_code": "<string>",
        "account_number": "<string>",
        "email": "<string>",
        "bank_name": "<string>"
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '<string>',
    beneficiary: {
      first_name: '<string>',
      last_name: '<string>',
      email: '<string>',
      address: {
        line_1: '<string>',
        city: '<string>',
        country: '<string>',
        line_2: '<string>',
        state: '<string>',
        postal_code: '<string>'
      }
    },
    bank: {
      account_holder_name: '<string>',
      country: '<string>',
      scheme: '<string>',
      swift_bic: '<string>',
      iban: '<string>',
      routing_number: '<string>',
      account_type: '<string>',
      bank_institution_number: '<string>',
      transit_number: '<string>',
      bank_code: '<string>',
      account_number: '<string>',
      email: '<string>',
      bank_name: '<string>'
    }
  })
};

fetch('https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => '<string>',
    'beneficiary' => [
        'first_name' => '<string>',
        'last_name' => '<string>',
        'email' => '<string>',
        'address' => [
                'line_1' => '<string>',
                'city' => '<string>',
                'country' => '<string>',
                'line_2' => '<string>',
                'state' => '<string>',
                'postal_code' => '<string>'
        ]
    ],
    'bank' => [
        'account_holder_name' => '<string>',
        'country' => '<string>',
        'scheme' => '<string>',
        'swift_bic' => '<string>',
        'iban' => '<string>',
        'routing_number' => '<string>',
        'account_type' => '<string>',
        'bank_institution_number' => '<string>',
        'transit_number' => '<string>',
        'bank_code' => '<string>',
        'account_number' => '<string>',
        'email' => '<string>',
        'bank_name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview"

	payload := strings.NewReader("{\n  \"amount\": \"<string>\",\n  \"beneficiary\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"address\": {\n      \"line_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line_2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    }\n  },\n  \"bank\": {\n    \"account_holder_name\": \"<string>\",\n    \"country\": \"<string>\",\n    \"scheme\": \"<string>\",\n    \"swift_bic\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"account_type\": \"<string>\",\n    \"bank_institution_number\": \"<string>\",\n    \"transit_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"email\": \"<string>\",\n    \"bank_name\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"<string>\",\n  \"beneficiary\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"address\": {\n      \"line_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line_2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    }\n  },\n  \"bank\": {\n    \"account_holder_name\": \"<string>\",\n    \"country\": \"<string>\",\n    \"scheme\": \"<string>\",\n    \"swift_bic\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"account_type\": \"<string>\",\n    \"bank_institution_number\": \"<string>\",\n    \"transit_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"email\": \"<string>\",\n    \"bank_name\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"<string>\",\n  \"beneficiary\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"address\": {\n      \"line_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"line_2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    }\n  },\n  \"bank\": {\n    \"account_holder_name\": \"<string>\",\n    \"country\": \"<string>\",\n    \"scheme\": \"<string>\",\n    \"swift_bic\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"account_type\": \"<string>\",\n    \"bank_institution_number\": \"<string>\",\n    \"transit_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"account_number\": \"<string>\",\n    \"email\": \"<string>\",\n    \"bank_name\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Payout preview",
  "data": {
    "preview_token": "nvpay.eyJhbGciOiJIUzI1NiJ9.preview",
    "currency": "NGN",
    "from_account_id": 39,
    "amount": "1.00",
    "fee": null,
    "receive_amount": null,
    "fee_status": "pending_confirm",
    "scheme": "nip",
    "destination": {
      "rail": "bank",
      "country": "NG",
      "scheme": "nip",
      "bank_name": "Access Bank",
      "account_number_masked": "****0031"
    },
    "expires_at": "2026-09-14T12:10:00+00:00",
    "customer_id": "pcus_a1b2c3d4e5f6"
  }
}

{
  "status": "error",
  "message": "Unauthorized",
  "data": null
}

{
  "status": "error",
  "message": "Insufficient balance",
  "data": {
    "available": "0.00",
    "amount": "1.00",
    "currency": "NGN"
  }
}

Preview a same-currency fiat payout to an external bank. Requires available >= amount. Call payout-methods (and payout-banks for local rails) first. Returns preview_token; fees may be pending_confirm until confirm. Guide: External bank payouts.

Authorizations

X-API-Key

string

header

required

Path Parameters

customer_id

string

required

Public customer id returned by POST /partner/customers

Example:

"pcus_a1b2c3d4e5f6"

account_id

integer

required

Account id returned by the customer account API

Required range: x >= 1

Body

application/json

Preview an external bank payout from a fiat account (same-currency, no FX).

amount

string

required

Decimal amount in account currency, e.g. 1.00

beneficiary

PartnerEntityPayoutBeneficiary · object

required

External payout recipient identity (counterparty).

Show child attributes

bank

PartnerEntityPayoutBank · object

required

External bank destination. Required fields depend on account currency / scheme. CAD local: scheme eft (default) | interac_email | interac_account - eft / interac_account: bank_institution_number (3), transit_number (5), account_number, bank_name, country=CA - interac_email: email, account_holder_name, country=CA (bank_name optional) EUR SEPA: iban, country (EU), optional swift_bic USD ACH/wire: routing_number, account_number, country=US, optional scheme/account_type NGN NIP: bank_code, account_number, bank_name, country=NG (scheme nip or omit) GHS EFT: bank_code, account_number, bank_name, country=GH (scheme gh_eft, eft, or omit) SWIFT: scheme=swift, swift_bic, plus iban or account_number (any supported currency)

Show child attributes

security_question

string | null

CAD Interac outbound only: question the recipient must answer to deposit. Requires security_answer. Mapped upstream as payment-details meta.

Required string length: 1 - 256

security_answer

string | null

CAD Interac outbound only: answer for security_question. Share with the recipient out-of-band; never returned in partner responses.

Required string length: 1 - 128

Response

Preview token for confirm. Fee often pending_confirm until confirm.

status

enum<string>

required

Available options:

success

message

string

required

data

object

required