Skip to main content
GET
/
payments
/
recipients
/
{id}
Retrieve Recipient
curl --request GET \
  --url https://api.usepooler.com/payments/recipients/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}
Retrieve detailed information about a specific payment recipient by its ID.

​
Overview

This endpoint returns comprehensive details about a single recipient, including all account information, limits, identification, and payment details.

​
Path Parameters

​
id
string
required
Recipient UUID

​
Response

​
data
object
Complete recipient object including:
  • id: Recipient UUID
  • merchant_id: Your merchant ID
  • account_number: Account number
  • account_name: Account holder name
  • account_type: Account type (individual/business)
  • is_internal_account: Whether it’s an internal Pooler account
  • account_currency: Currency code
  • account_bank_name: Bank name
  • account_bank_code: Bank code
  • account_country_code: Country code
  • account_country: Country name
  • identification: Identification object with type, number, and image
  • limit: Payment limit
  • payment_details: Payment details object
  • 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}

Path Parameters

​
id
string<uuid>
required

Recipient ID

Response

200 - application/json

Recipient retrieved successfully

​
success
boolean
​
message
string
​
stan
string<uuid>
​
data
object