Create Recipient

Create Recipient

curl --request POST \
  --url https://api.usepooler.com/payments/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_number": "<string>",
  "account_name": "<string>",
  "account_currency": "<string>",
  "account_country_code": "<string>",
  "account_bank_name": "<string>",
  "account_bank_code": "<string>",
  "amount_limit": 123,
  "identification": {
    "identification_type": "<string>",
    "identification_number": "<string>",
    "identification_image": "<string>"
  },
  "payment_details": {
    "account_number": "<string>",
    "bank_code": "<string>",
    "bank_name": "<string>",
    "routing_number": "<string>",
    "swift_code": "<string>",
    "payment_rails": "<string>"
  }
}
'

import requests

url = "https://api.usepooler.com/payments/recipients"

payload = {
    "account_number": "<string>",
    "account_name": "<string>",
    "account_currency": "<string>",
    "account_country_code": "<string>",
    "account_bank_name": "<string>",
    "account_bank_code": "<string>",
    "amount_limit": 123,
    "identification": {
        "identification_type": "<string>",
        "identification_number": "<string>",
        "identification_image": "<string>"
    },
    "payment_details": {
        "account_number": "<string>",
        "bank_code": "<string>",
        "bank_name": "<string>",
        "routing_number": "<string>",
        "swift_code": "<string>",
        "payment_rails": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_number: '<string>',
    account_name: '<string>',
    account_currency: '<string>',
    account_country_code: '<string>',
    account_bank_name: '<string>',
    account_bank_code: '<string>',
    amount_limit: 123,
    identification: {
      identification_type: '<string>',
      identification_number: '<string>',
      identification_image: '<string>'
    },
    payment_details: {
      account_number: '<string>',
      bank_code: '<string>',
      bank_name: '<string>',
      routing_number: '<string>',
      swift_code: '<string>',
      payment_rails: '<string>'
    }
  })
};

fetch('https://api.usepooler.com/payments/recipients', 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://api.usepooler.com/payments/recipients",
  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([
    'account_number' => '<string>',
    'account_name' => '<string>',
    'account_currency' => '<string>',
    'account_country_code' => '<string>',
    'account_bank_name' => '<string>',
    'account_bank_code' => '<string>',
    'amount_limit' => 123,
    'identification' => [
        'identification_type' => '<string>',
        'identification_number' => '<string>',
        'identification_image' => '<string>'
    ],
    'payment_details' => [
        'account_number' => '<string>',
        'bank_code' => '<string>',
        'bank_name' => '<string>',
        'routing_number' => '<string>',
        'swift_code' => '<string>',
        'payment_rails' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.usepooler.com/payments/recipients"

	payload := strings.NewReader("{\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_currency\": \"<string>\",\n  \"account_country_code\": \"<string>\",\n  \"account_bank_name\": \"<string>\",\n  \"account_bank_code\": \"<string>\",\n  \"amount_limit\": 123,\n  \"identification\": {\n    \"identification_type\": \"<string>\",\n    \"identification_number\": \"<string>\",\n    \"identification_image\": \"<string>\"\n  },\n  \"payment_details\": {\n    \"account_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"payment_rails\": \"<string>\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.usepooler.com/payments/recipients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_currency\": \"<string>\",\n  \"account_country_code\": \"<string>\",\n  \"account_bank_name\": \"<string>\",\n  \"account_bank_code\": \"<string>\",\n  \"amount_limit\": 123,\n  \"identification\": {\n    \"identification_type\": \"<string>\",\n    \"identification_number\": \"<string>\",\n    \"identification_image\": \"<string>\"\n  },\n  \"payment_details\": {\n    \"account_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"payment_rails\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usepooler.com/payments/recipients")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_currency\": \"<string>\",\n  \"account_country_code\": \"<string>\",\n  \"account_bank_name\": \"<string>\",\n  \"account_bank_code\": \"<string>\",\n  \"amount_limit\": 123,\n  \"identification\": {\n    \"identification_type\": \"<string>\",\n    \"identification_number\": \"<string>\",\n    \"identification_image\": \"<string>\"\n  },\n  \"payment_details\": {\n    \"account_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"payment_rails\": \"<string>\"\n  }\n}"

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

{
  "success": true,
  "message": "<string>",
  "stan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_number": "<string>",
    "account_name": "<string>",
    "account_type": "<string>",
    "is_internal_account": true,
    "account_currency": "<string>",
    "account_bank_name": "<string>",
    "account_bank_code": "<string>",
    "account_country_code": "<string>",
    "account_country": "<string>",
    "identification": {},
    "limit": "<string>",
    "payment_details": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

POST

payments

recipients

Create Recipient

curl --request POST \
  --url https://api.usepooler.com/payments/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_number": "<string>",
  "account_name": "<string>",
  "account_currency": "<string>",
  "account_country_code": "<string>",
  "account_bank_name": "<string>",
  "account_bank_code": "<string>",
  "amount_limit": 123,
  "identification": {
    "identification_type": "<string>",
    "identification_number": "<string>",
    "identification_image": "<string>"
  },
  "payment_details": {
    "account_number": "<string>",
    "bank_code": "<string>",
    "bank_name": "<string>",
    "routing_number": "<string>",
    "swift_code": "<string>",
    "payment_rails": "<string>"
  }
}
'

import requests

url = "https://api.usepooler.com/payments/recipients"

payload = {
    "account_number": "<string>",
    "account_name": "<string>",
    "account_currency": "<string>",
    "account_country_code": "<string>",
    "account_bank_name": "<string>",
    "account_bank_code": "<string>",
    "amount_limit": 123,
    "identification": {
        "identification_type": "<string>",
        "identification_number": "<string>",
        "identification_image": "<string>"
    },
    "payment_details": {
        "account_number": "<string>",
        "bank_code": "<string>",
        "bank_name": "<string>",
        "routing_number": "<string>",
        "swift_code": "<string>",
        "payment_rails": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_number: '<string>',
    account_name: '<string>',
    account_currency: '<string>',
    account_country_code: '<string>',
    account_bank_name: '<string>',
    account_bank_code: '<string>',
    amount_limit: 123,
    identification: {
      identification_type: '<string>',
      identification_number: '<string>',
      identification_image: '<string>'
    },
    payment_details: {
      account_number: '<string>',
      bank_code: '<string>',
      bank_name: '<string>',
      routing_number: '<string>',
      swift_code: '<string>',
      payment_rails: '<string>'
    }
  })
};

fetch('https://api.usepooler.com/payments/recipients', 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://api.usepooler.com/payments/recipients",
  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([
    'account_number' => '<string>',
    'account_name' => '<string>',
    'account_currency' => '<string>',
    'account_country_code' => '<string>',
    'account_bank_name' => '<string>',
    'account_bank_code' => '<string>',
    'amount_limit' => 123,
    'identification' => [
        'identification_type' => '<string>',
        'identification_number' => '<string>',
        'identification_image' => '<string>'
    ],
    'payment_details' => [
        'account_number' => '<string>',
        'bank_code' => '<string>',
        'bank_name' => '<string>',
        'routing_number' => '<string>',
        'swift_code' => '<string>',
        'payment_rails' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.usepooler.com/payments/recipients"

	payload := strings.NewReader("{\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_currency\": \"<string>\",\n  \"account_country_code\": \"<string>\",\n  \"account_bank_name\": \"<string>\",\n  \"account_bank_code\": \"<string>\",\n  \"amount_limit\": 123,\n  \"identification\": {\n    \"identification_type\": \"<string>\",\n    \"identification_number\": \"<string>\",\n    \"identification_image\": \"<string>\"\n  },\n  \"payment_details\": {\n    \"account_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"payment_rails\": \"<string>\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.usepooler.com/payments/recipients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_currency\": \"<string>\",\n  \"account_country_code\": \"<string>\",\n  \"account_bank_name\": \"<string>\",\n  \"account_bank_code\": \"<string>\",\n  \"amount_limit\": 123,\n  \"identification\": {\n    \"identification_type\": \"<string>\",\n    \"identification_number\": \"<string>\",\n    \"identification_image\": \"<string>\"\n  },\n  \"payment_details\": {\n    \"account_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"payment_rails\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usepooler.com/payments/recipients")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_currency\": \"<string>\",\n  \"account_country_code\": \"<string>\",\n  \"account_bank_name\": \"<string>\",\n  \"account_bank_code\": \"<string>\",\n  \"amount_limit\": 123,\n  \"identification\": {\n    \"identification_type\": \"<string>\",\n    \"identification_number\": \"<string>\",\n    \"identification_image\": \"<string>\"\n  },\n  \"payment_details\": {\n    \"account_number\": \"<string>\",\n    \"bank_code\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"routing_number\": \"<string>\",\n    \"swift_code\": \"<string>\",\n    \"payment_rails\": \"<string>\"\n  }\n}"

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

{
  "success": true,
  "message": "<string>",
  "stan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_number": "<string>",
    "account_name": "<string>",
    "account_type": "<string>",
    "is_internal_account": true,
    "account_currency": "<string>",
    "account_bank_name": "<string>",
    "account_bank_code": "<string>",
    "account_country_code": "<string>",
    "account_country": "<string>",
    "identification": {},
    "limit": "<string>",
    "payment_details": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Create a new payment recipient. Recipients are bank accounts or payment destinations that you can send payments to.

Overview

Recipients are saved payment destinations that you can reuse for multiple payments. Creating a recipient allows you to:

Store bank account details securely
Reuse payment destinations without re-entering details
Set payment limits per recipient
Add identification and verification information

Request Body

string

required

Bank account number

string

required

Account holder name

string

required

Type of account holder: “individual” or “business”

string

required

Currency code (e.g., “NGN”, “USD”, “KES”)

string

Country code or country name

string

Bank name

string

Bank code or routing number

number

Maximum amount limit for payments to this recipient

object

Identification information object:

identification_type: Type of ID (e.g., “passport”, “national_id”)
identification_number: ID number
identification_image: Base64 encoded image of ID

object

Additional payment details object:

account_number: Payment account number
bank_code: Bank code
bank_name: Bank name
routing_number: Routing number
swift_code: SWIFT code
payment_rails: Payment rails identifier (e.g., “nip”)

Headers

string

Optional idempotency key to prevent duplicate recipient creation

Response

object

Created recipient object including:

id: Recipient UUID (use this for payments)
merchant_id: Your merchant ID
account_number: Account number
account_name: Account holder name
account_type: Account type
account_currency: Currency code
account_bank_name: Bank name
account_bank_code: Bank code
account_country_code: Country code
limit: Payment limit
is_internal_account: Whether it’s an internal Pooler account
created_at: Creation timestamp
updated_at: Last update timestamp

Authorizations

Authorization

string

header

required

Bearer token authentication. Include your API key in the Authorization header as: Bearer {your_api_key}

Body

application/json

account_number

string

required

Bank account number

account_name

string

required

Account holder name

account_type

enum<string>

required

Type of account holder

Available options:

individual,

business

account_currency

string

required

Currency code

account_country_code

string

Country code

account_bank_name

string

Bank name

account_bank_code

string

Bank code

amount_limit

number

Maximum amount limit for this recipient

identification

object

Show child attributes

payment_details

object

Show child attributes

Response

201 - application/json

Recipient created successfully

success

boolean

message

string

stan

string<uuid>

data

object

Show child attributes

API documentation

Business

Payments

Accounts

Recipients

Webhooks

FX

Utilities

Overview

Request Body

Headers

Response

Authorizations

Body

Response

​Overview

​Request Body

​Headers

​Response

Authorizations

Body

Response

Overview

Request Body

Headers

Response