Skip to content
HitchPay API Docs

Simulator

Overview

Helpers for business developers to test their integration end-to-end. Available only in the sandbox/development environment — these endpoints return 403 on production.

/v1/sandbox

All Sandbox/Testing endpoints reside under this base path.

Use this section to

  • Finish provisioning a pending USD/EUR account so you have something fundable to test against
  • Simulate an inbound transfer into a virtual account (NGN, USD or EUR), to test your webhook handling and reconciliation
  • Test the BVN/NIN identity lookup request/response shape without spending a real lookup or touching your wallet

Authentication

Every request must include your public API access token:

Authorization: Bearer <access_token>

Response format

Same envelope as the rest of the public API.

Success

{
  "status": "success",
  "message": "...",
  "data": { }
}

Error

{
  "status": "error",
  "code": "ERROR_CODE",
  "message": "..."
}

Important: These endpoints are hard-disabled on production; calling any of them outside the sandbox/development environment returns NOT_ALLOWED (403).


Prerequisite: foreign-currency accounts require the customer to have an approved government ID and an approved proof of address — see the Customer Enrollment & KYC section.

Questions? Email [email protected]. Also on GitBook.