Routes

API endpoints for managing Routes in the PayID platform.

Routes define how incoming payments are handled, including which networks and tokens are accepted, optional token swaps, and the destination wallet for final transfers.

When creating a route, consider these important factors:

• Each route must have a unique combination of incoming networks and tokens per user.

• Certain network-token combinations are not supported (see Unsupported Combinations section).

• Users can have multiple routes with different configurations.

Create a new route

post

https://api.reveel.id/v1https://staging-api.reveel.id/v1

/routes

Create a new route for a specific user. A route defines how incoming payments should be processed. Routes must have a unique combination of incoming networks and tokens per user. Certain network-token combinations are not supported (see API description for details).

Authorizations

bearerAuth

AuthorizationstringRequired

API keys are provided when a partner account is created and can be regenerated if needed. To authenticate requests, include your API key in the request headers using the Bearer token format: Authorization: Bearer your-api-key

Required Permissions

The following permissions are required for the Routes endpoints:

• route:create - Create new routes for users associated with your partner account
• route:read - View routes for users associated with your partner account
• route:update - Modify route information for users associated with your partner account
• route:delete - Delete routes for users associated with your partner account

Body

application/json

userIdstring · uuidRequired

ID of the user this route belongs to

Example: 38acfa0a-74a6-4e37-9168-eeddacc36444

namestringRequired

Name of the route. Minimum length: 1 character.

Example: my first route ever

incomingWalletsstring[]Optional

List of incoming wallet addresses that can use this route. The system performs minimal validation - verify addresses are valid for the corresponding blockchain.

Example: ["0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0","0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"]

swapNetworkstring · enum · nullableOptional

Network to swap on (optional). If provided, swapToken must also be specified.

Possible values:

swapTokenstring · enum · nullableOptional

Token to swap to (optional). If provided, swapNetwork must also be specified.

Possible values:

outgoingWalletstringRequired

Destination wallet address where funds will be sent. The system performs minimal validation - ensure you're providing a valid blockchain address for the corresponding network.

Example: 0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0

Responses

201

Route created successfully

application/json

400

Invalid input data

application/json

401

Unauthorized

application/json

404

User not found

application/json

500

Server error

application/json

post

/routes

HTTPcURLJavaScriptPython

POST /v1/routes HTTP/1.1
Host: api.reveel.id
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 339

{
  "userId": "38acfa0a-74a6-4e37-9168-eeddacc36444",
  "name": "my first route ever",
  "incomingWallets": [
    "0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0",
    "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
  ],
  "incomingNetworks": [
    "ETH"
  ],
  "incomingTokens": [
    "USDT"
  ],
  "swapNetwork": null,
  "swapToken": null,
  "outgoingWallet": "0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0"
}

{
  "success": true,
  "data": {
    "route": {
      "id": "fbb5564f-7184-4e51-a434-e2cf3e45d3d1",
      "name": "my first route ever",
      "incomingWallets": [
        "0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0",
        "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      ],
      "incomingNetworks": [
        "ETH"
      ],
      "incomingTokens": [
        "USDT"
      ],
      "swapNetwork": null,
      "swapToken": null,
      "outgoingWallet": "0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0",
      "userId": "38acfa0a-74a6-4e37-9168-eeddacc36444",
      "createdAt": "2025-04-14T03:39:12.630Z",
      "updatedAt": "2025-04-14T03:39:12.630Z"
    }
  },
  "meta": {
    "message": "Route created successfully"
  }
}

Unsupported Combinations

The following network - token combinations are not supported:

Network	Token
OP	POL
OP	BNB
BASE	USDT
BASE	BNB
BASE	POL

Get all routes for a user

get

https://api.reveel.id/v1https://staging-api.reveel.id/v1

/routes/{userId}

Retrieve all routes for a specific user.

Authorizations

bearerAuth

AuthorizationstringRequired

API keys are provided when a partner account is created and can be regenerated if needed. To authenticate requests, include your API key in the request headers using the Bearer token format: Authorization: Bearer your-api-key

Required Permissions

The following permissions are required for the Routes endpoints:

• route:create - Create new routes for users associated with your partner account
• route:read - View routes for users associated with your partner account
• route:update - Modify route information for users associated with your partner account
• route:delete - Delete routes for users associated with your partner account

Path parameters

userIdstring · uuidRequired

ID of the user to get routes for

Responses

200

Routes retrieved successfully

application/json

400

Invalid input

application/json

401

Unauthorized

application/json

404

User not found

application/json

500

Server error

application/json

get

/routes/{userId}

HTTPcURLJavaScriptPython

GET /v1/routes/{userId} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": {
    "routes": [
      {
        "id": "fbb5564f-7184-4e51-a434-e2cf3e45d3d1",
        "name": "my first route ever",
        "incomingWallets": [
          "0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0",
          "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
        ],
        "incomingNetworks": [
          "ETH"
        ],
        "incomingTokens": [
          "USDT"
        ],
        "swapNetwork": null,
        "swapToken": null,
        "outgoingWallet": "0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0",
        "userId": "38acfa0a-74a6-4e37-9168-eeddacc36444",
        "createdAt": "2025-04-14T03:39:12.630Z",
        "updatedAt": "2025-04-14T03:39:12.630Z"
      }
    ],
    "count": 2
  },
  "meta": {
    "message": "Found 2 route(s)"
  }
}

Update an existing route

put

https://api.reveel.id/v1https://staging-api.reveel.id/v1

/routes/{id}

Update an existing route by ID. Supports partial updates.

Authorizations

bearerAuth

AuthorizationstringRequired

API keys are provided when a partner account is created and can be regenerated if needed. To authenticate requests, include your API key in the request headers using the Bearer token format: Authorization: Bearer your-api-key

Required Permissions

The following permissions are required for the Routes endpoints:

• route:create - Create new routes for users associated with your partner account
• route:read - View routes for users associated with your partner account
• route:update - Modify route information for users associated with your partner account
• route:delete - Delete routes for users associated with your partner account

Path parameters

idstring · uuidRequired

ID of the route to update

Body

application/json

userIdstring · uuidRequired

ID of the user this route belongs to. This is required as an authorization check, not as a field to update.

Example: 38acfa0a-74a6-4e37-9168-eeddacc36444

namestringOptional

Name of the route. Minimum length: 1 character.

Example: my first route ever

incomingWalletsstring[]Optional

List of incoming wallet addresses

Example: ["0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0","0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"]

swapNetworkstring · enum · nullableOptional

Network to swap on (optional)

Possible values:

swapTokenstring · enumOptional

Token to swap to (optional)

Example: ETHPossible values:

outgoingWalletstringOptional

Destination wallet address. Minimal validation is performed - ensure it's a valid address for the network.

Example: 0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0

Responses

200

Route updated successfully

application/json

400

Invalid input data

application/json

401

Unauthorized

application/json

403

Forbidden - User does not have access to this route

application/json

404

Route or user not found

application/json

500

Server error

application/json

put

/routes/{id}

HTTPcURLJavaScriptPython

PUT /v1/routes/{id} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 340

{
  "userId": "38acfa0a-74a6-4e37-9168-eeddacc36444",
  "name": "my first route ever",
  "incomingWallets": [
    "0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0",
    "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
  ],
  "incomingNetworks": [
    "ETH"
  ],
  "incomingTokens": [
    "USDT"
  ],
  "swapNetwork": null,
  "swapToken": "ETH",
  "outgoingWallet": "0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0"
}

{
  "success": true,
  "data": {
    "route": {
      "id": "fbb5564f-7184-4e51-a434-e2cf3e45d3d1",
      "name": "my first route ever",
      "incomingWallets": [
        "0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0",
        "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      ],
      "incomingNetworks": [
        "ETH"
      ],
      "incomingTokens": [
        "USDT"
      ],
      "swapNetwork": null,
      "swapToken": null,
      "outgoingWallet": "0x9c02cBF68E61591A2d8f05dF3318e244768f7ec0",
      "userId": "38acfa0a-74a6-4e37-9168-eeddacc36444",
      "createdAt": "2025-04-14T03:39:12.630Z",
      "updatedAt": "2025-04-14T03:39:12.630Z"
    }
  },
  "meta": {
    "message": "Route updated successfully"
  }
}

Delete a route

delete

https://api.reveel.id/v1https://staging-api.reveel.id/v1

/routes/{id}

Delete a route by ID.

Authorizations

bearerAuth

AuthorizationstringRequired

API keys are provided when a partner account is created and can be regenerated if needed. To authenticate requests, include your API key in the request headers using the Bearer token format: Authorization: Bearer your-api-key

Required Permissions

The following permissions are required for the Routes endpoints:

• route:create - Create new routes for users associated with your partner account
• route:read - View routes for users associated with your partner account
• route:update - Modify route information for users associated with your partner account
• route:delete - Delete routes for users associated with your partner account

Path parameters

idstring · uuidRequired

ID of the route to delete

Body

application/json

userIdstring · uuidRequired

ID of the user this route belongs to

Example: 38acfa0a-74a6-4e37-9168-eeddacc36444

Responses

200

Route deleted successfully

application/json

400

Invalid input data

application/json

401

Unauthorized

application/json

403

Forbidden - User does not have access to this route

application/json

404

Route or user not found

application/json

500

Server error

application/json

delete

/routes/{id}

HTTPcURLJavaScriptPython

DELETE /v1/routes/{id} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "userId": "38acfa0a-74a6-4e37-9168-eeddacc36444"
}

{
  "success": true,
  "data": {},
  "meta": {
    "message": "Route deleted successfully"
  }
}