Hercle
REST
POST/api/v1/simulate-payin

Simulate Pay-In

Simulate a pay-in transaction for testing purposes. This endpoint allows you to simulate incoming bank transfers to test your integration.

Auth:Bearer <api_key>
Tags:BankingSandbox

Request

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

Headers

NameTypeRequiredDescription
AuthorizationstringYesBearer token for authentication
Content-TypestringYesContent type of the request body

Request Body

Schema

object
amount*:number
// Amount to simulate for the pay-in transaction
toAddress*:string
// Destination address ID. Must be a valid fac_* (fiat account) or vac_* (virtual account) address
from*:object
// Sender information. For EUR pay-ins, use `iban`. For GBP pay-ins, use `accountNumber` and `routingCodes` instead.
accountHolderName:string
// Name of the account holder sending the funds
iban:string
// IBAN of the sender account (EUR)
accountNumber:string
// Account number of the sender (GBP)
routingCodes:array
// Routing codes for the sender account (GBP)
fromType*:string
// Type of sender. Only PERSON is supported
paymentScheme*:string
// Payment scheme. SCT for EUR, FPS or CHAPS for GBP
reference*:string
// Payment reference

Example

{
  "amount": 789.31,
  "toAddress": "fac_mv4j23183xpd7oaz56",
  "from": {
    "accountHolderName": "Franco Martinelli",
    "iban": "IT08L0300203280734472989658"
  },
  "fromType": "PERSON",
  "paymentScheme": "SCT",
  "reference": "deposit"
}

Response

Success Response Schema

FieldTypeDescription
amountnumberAmount of the simulated pay-in
depositAddressstringThe deposit address that received the funds

Responses

Pay-in simulation created successfully

200 application/json
{
  "amount": 123,
  "depositAddress": "vac_ong3zm73aerr0b2jkr"
}

API Tester

Test this endpoint directly against the sandbox environment

Get your API key from Hercle Sandbox

https://publicapi.sandbox.hercle.financial/api/v1/simulate-payin