Developers

Build on RETAILERWAY financial infrastructure

A REST API for creating users, reading wallets, cards and verification status, and selling with hosted checkout links. Authenticate with your project key and secret.

Open developer dashboardTalk to the team
01

Create a project

Open the developer dashboard in the RETAILERWAY app and create a project for your integration.

02

Get your keys

Each project receives an API key and secret. Sandbox keys start with rw_test_, production keys with rw_live_.

03

Build in sandbox

Develop and test against sandbox mode. Request production access when your integration is ready for review.

Authentication

Send your project key in the x-api-key header and your secret in x-api-secret. Keep the secret on your server — never ship it in a browser or mobile app.

Base URL: https://api.retailerwaywa.com/v1

curl https://api.retailerwaywa.com/v1/platform/users \
  -H "x-api-key: rw_test_..." \
  -H "x-api-secret: $RW_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "a-strong-password",
    "username": "jane"
  }'

Endpoints

Platform

Manage the end users of your project.

  • GET/platform/pingCheck that your credentials work
  • POST/platform/usersCreate a user in your project
  • GET/platform/usersList users in your project
  • GET/platform/users/:userIdRetrieve a user
  • POST/platform/users/:userId/tokenIssue a session token for a user
  • GET/platform/users/:userId/walletsList a user's wallets
  • GET/platform/users/:userId/cardsList a user's cards
  • GET/platform/users/:userId/kycRead a user's verification status

Commerce

Sell products with hosted checkout links.

  • GET/commerce/productsList products
  • POST/commerce/productsCreate a product
  • GET/commerce/products/:productIdRetrieve a product
  • POST/commerce/products/:productId/checkout-linksCreate a checkout link
  • GET/commerce/checkout-linksList checkout links