Getting Started API

API reference

Getting Started — API Reference

Base URL: https://api.goldrail.xyz

Auth: X-API-Key

OpenAPI operations are generated into this section (see npm run generate:openapi). Until then, use Cookbook + Official Postman.

Guides

Money

Money-moving responses use a money object (usd, display, settled, fx, optional equivalents). Flat amount / amount_usd are removed on that closed list. POST still sends amount + currency. Add ?currencies=XOF,EUR for snapshot equivalents. Gift cards expose money (remaining) and face_money (face).

On this page