Approve Payee Address

Approve a payee address using the confirmation token received via email. This endpoint is used to confirm and activate a previously registered payee address.

Auth:Bearer <api_key>

Tags:Banking

Request

cURL

curl https://publicapi.sandbox.hercle.financial/api/v1/payees/{payeeId}/addresses/{payeeAddressId}/approve \
  -H "Authorization: Bearer eyJhb..." \

Path Parameters

Name	Type	Required	Description
payeeId	string	Yes	The ID of the payee Example: `123e4567-e89b-12d3-a456-426614174000`
payeeAddressId	string	Yes	The ID of the payee address to approve Example: `123e4567-e89b-12d3-a456-426614174001`

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication
Content-Type	string	Yes	Content type of the request body

Request Body

Schema

object

email*:string

// Email address associated with the confirmation

confirmationToken*:string

// The confirmation token used to approve the payee address. When confirmationStrategy is EMAIL, a confirmation link containing the token is sent to the registered email address. When confirmationStrategy is API, the token is returned directly in the Register Payee Address response.

Example

{
  "email": "user@example.com",
  "confirmationToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response

Success Response Schema

Field	Type	Description
`id`	string	Unique identifier for the payee address
`payeeId`	string	Payee identifier this address belongs to
`name`	string	Name associated with the address
`asset`	string	Asset code (e.g., EUR, USD, BTC)
`address`	string	The payment or blockchain address
`addressParams`	array \| null	Additional address parameters
`addressParams[].id`	string	Parameter identifier
`addressParams[].value`	string	Parameter value
`network`	string	Network name (e.g., Sepa, BTC)
`status`	number	Status of the address `0`→ created `1`→ pending `2`→ refused
`comment`	string \| null	Optional comment for the address
`confirmationStrategy`	string	Strategy for confirming the address Allowed values: `EMAIL` `API`
`confirmationToken`	string \| null	Token used for confirming the address

Responses

200 application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "payeeId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Payee Address",
  "asset": "BTC",
  "address": "bc1q...",
  "addressParams": null,
  "network": "BTC",
  "status": 1,
  "comment": null,
  "confirmationStrategy": "EMAIL",
  "confirmationToken": null
}

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Path Parameters

payeeId

Required

The ID of the payee

payeeAddressId

Required

The ID of the payee address to approve

Request Body

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/payees/{payeeId}/addresses/{payeeAddressId}/approve