Skip to main content
PUT
/
payments
/
recipients
/
{id}
Edit Recipient
curl --request PUT \
  --url https://api.usepooler.com/payments/recipients/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_number": "<string>",
  "account_name": "<string>",
  "account_type": "<string>",
  "account_currency": "<string>",
  "account_country_code": "<string>",
  "account_bank_name": "<string>",
  "account_bank_code": "<string>",
  "amount_limit": 123,
  "identification_type": "<string>",
  "identification_number": "<string>",
  "payment_details": {}
}
'
{
  "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"
  }
}
Update an existing payment recipient’s information. This allows you to modify account details, limits, or identification information.

​
Overview

Use this endpoint to update recipient information such as account details, payment limits, or identification documents.

​
Path Parameters

​
id
string
required
Recipient UUID

​
Request Body

​
account_number
string
Updated bank account number
​
account_name
string
Updated account holder name
​
account_type
string
Updated account type
​
account_currency
string
Updated currency code
​
account_country_code
string
Updated country code
​
account_bank_name
string
Updated bank name
​
account_bank_code
string
Updated bank code
​
amount_limit
number
Updated payment limit
​
identification_type
string
Updated identification type
​
identification_number
string
Updated identification number
​
payment_details
object
Updated payment details object

​
Response

​
data
object
Updated recipient object with all current information

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

Body

application/json
​
account_number
string
​
account_name
string
​
account_type
string
​
account_currency
string
​
account_country_code
string
​
account_bank_name
string
​
account_bank_code
string
​
amount_limit
number
​
identification_type
string
​
identification_number
string
​
payment_details
object

Response

200 - application/json

Recipient updated successfully

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