Skip to main content

​
Base URLs

OpenAPI lists servers for tooling and the interactive playground. Paths in this spec already include the /v1 prefix (for example POST /v1/request-money), so the server URL is the host base only—do not append /v1 to the OpenAPI server value.
EnvironmentHost base URL (BASE_URL in samples)Versioned API root
Sandbox (Banrural)https://banrural-request-api-sandbox.up.railway.apphttps://banrural-request-api-sandbox.up.railway.app/v1
ProductionProvided by your integration contact{production-host}/v1
Example create URL for Banrural sandbox: https://banrural-request-api-sandbox.up.railway.app/v1/request-money. You can regenerate the exported spec from the API repo with OPENAPI_SERVER_URL set so servers reflects another deployment.

​
Common headers

HeaderRequiredPurpose
Content-Type: application/jsonOn POSTRequest body is JSON.
X-API-KeyOn POST and GET under /v1/request-moneyIntegrator authentication.

​
Response format

  • Success responses return JSON bodies defined in OpenAPI (RequestMoneyResponse, status payloads, etc.).
  • Error responses use the shapes in OpenAPI for each status code. For example, 404 on GET /v1/request-money/{referenceId} returns error (stable machine-readable code such as not_found) and message (human-readable text you can surface in support tooling or UX). 401 and 422 use their own DTOs (message, and for 422 a details object).

​
HTTP status codes (surface summary)

CodeTypical use
201 CreatedSuccessful POST /v1/request-money.
200 OKSuccessful GET /v1/request-money/{referenceId}.
401 UnauthorizedInvalid or missing API key.
403 ForbiddenPOST blocked by screening (for example OFAC).
404 Not FoundUnknown referenceId for GET.
422 Unprocessable EntityValidation or semantic errors on create.

​
Rate limits and pagination

This specification does not define global rate limits or cursor pagination for the current two-endpoint surface. If your deployment adds limits, your integration contact will document them.

​
Where to go next

Use the Endpoints group in the API Reference tab for createRequest and getByReferenceId, including schemas, examples, and the interactive playground.