Register Payee

Auth:Bearer <api_key>

Tags:Banking

Request

cURL

curl -X POST https://publicapi.sandbox.hercle.financial/api/v1/payee \
  -H "Authorization: Bearer eyJhb..." \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

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

type*:number

// Type of payee (0: Individual, 1: Company)

name*:string

// Name of the payee

endUserId:string

// End user identifier

surname*:string

// Surname of the payee

company*:string

// Company name of the payee (if applicable)

country*:string

// Country of the payee (ISO 3166-1 alpha-2 format)

state*:string

// State or province of the payee

city*:string

// City of the payee

address*:string

// Street address of the payee

postalCode*:string

// Postal code of the payee

Example

{
  "type": 0,
  "name": "John",
  "endUserId": "",
  "surname": "Doe",
  "company": "Company Inc.",
  "country": "US",
  "state": "CA",
  "city": "San Francisco",
  "address": "123 Market St",
  "postalCode": "94103"
}

Response

Success Response Schema

Payee created successfully

Field	Type	Description
`id`	string	Unique identifier for the payee
`userId`	string	User identifier who owns the payee
`endUserId`	string	End user identifier
`type`	number	Payee type `0`→ Individual `1`→ Company
`name`	string	First name of the payee
`surname`	string	Last name of the payee
`company`	string \| null	Company name if applicable
`country`	string	Country code (ISO 3166-1 alpha-2)
`state`	string	State or province
`city`	string	City name
`address`	string	Street address
`postalCode`	string	Postal or ZIP code

Responses

Payee created successfully

201 application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "987e6543-e21b-12d3-a456-426614174000",
  "endUserId": "",
  "type": 0,
  "name": "John",
  "surname": "Doe",
  "company": "Company Inc.",
  "country": "US",
  "state": "CA",
  "city": "San Francisco",
  "address": "123 Market St",
  "postalCode": "94103"
}

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Request Body

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/payee