Create Transfer

Create a new transfer.

Auth:Bearer <api_key>

Tags:BankingIdempotent

Request

cURL

curl -X POST https://publicapi.sandbox.hercle.financial/api/v1/transfer \
  -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
Client-Id	string	No	⚠️ Sandbox only. Unique idempotency key for the request. If a request with the same Client-Id is received within 6 hours, the original response is returned.

Request Body

Schema

object

asset*:string

// Asset code (e.g., USD, EUR) - Must exist in the configured network

amount*:number

// Amount to transfer

internalAddressId*:string

// ID of the internal address to transfer to

payeeAddressId*:string

// ID of the payee address to transfer to

description*:string

// Description of the transfer. Must not exceed 250 characters.

Example

{
  "asset": "USD",
  "amount": 1000.5,
  "internalAddressId": "123e4567-e89b-12d3-a456-426614174000",
  "payeeAddressId": "987e6543-e21b-12d3-a456-426614174000",
  "description": "Payment for services"
}

Response

Success Response Schema

Transfer created successfully

Field	Type	Description
`id`	string	Unique identifier for the transfer
`asset`	string	Asset code (e.g., USD, EUR)
`amount`	number	Transfer amount
`internalAddressId`	string	ID of the internal address
`payeeAddressId`	string	ID of the payee address
`description`	string \| null	Description of the transfer

Responses

Transfer created successfully

201 application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174999",
  "asset": "USD",
  "amount": 1000.5,
  "internalAddressId": "123e4567-e89b-12d3-a456-426614174000",
  "payeeAddressId": "987e6543-e21b-12d3-a456-426614174000",
  "description": "Payment for services"
}

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/transfer