API Reference
Contact Us

Getting Started

Welcome to the ReadyRemit API specs. In this section of the documentation you'll find a description of every API endpoint offered by ReadyRemit including the request/URL parameters and the post/response body with examples.

📘

Guides

This section should be used as reference material for interacting with the ReadyRemit API. If you're looking for step-by-step integration guides, check out the Getting Started with the ReadyRemit API section.

Open API 3.0 Spec

https://raw.githubusercontent.com/BrightwellPayments/readyremit-api-docs/main/postman/schemas/transfer.yml

Postman

Follow these steps to view and explore the ReadyRemit API in Postman.

  1. Select APIs in the sidebar and press "Import"
  2. Select "Link" and paste in the URL from the "Open API 3.0 Spec" section above
  3. Press "Continue" and "Import"
  4. Once the import completes, the API will be available to explore.
  5. (Optional) To convert the API to a Collection in postman, press the "..." icon next to the "ReadyRemit Transfer API" node in the APIs section and select "Copy to Collections"