Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.dollarpe.xyz/llms.txt

Use this file to discover all available pages before exploring further.

This section covers the essentials for building and testing with DollarPe: obtaining credentials, choosing an environment, setting up authentication, and configuring webhooks.

​
Prerequisites

1

Obtain API credentials

Contact our support team to receive your API Key and API Secret. These are unique to your organization and required for all API calls.
2

Choose your environment

Use Sandbox for all development and testing — no real funds are involved. Move to Production only after validating your integration end-to-end.
3

Set up authentication

All requests require three signed headers. See the Authentication guide for how to generate them.
4

Configure webhooks

Set up a publicly accessible HTTPS endpoint to receive real-time event notifications. See the Webhooks guide.

​
Environments

Use sandbox for all development and testing. No real funds are involved.
ServiceBase URL
Customer APIhttps://sandbox.dollarpe.xyz/cms/api/v1
Payout APIhttps://sandbox.dollarpe.xyz/pos/api/v1
Payin APIhttps://sandbox.dollarpe.xyz/pis/api/v1
Webhook APIhttps://sandbox.dollarpe.xyz/org/api/v1
Widget APIhttps://sandbox.dollarpe.xyz/widget/api/v1
Sandbox and Production credentials are separate and cannot be used interchangeably.

​
Testing in sandbox

All three integration paths work in sandbox:
Integration pathHow to test
API IntegrationUse sandbox base URLs and credentials. Use mock status endpoints to simulate transaction state changes.
Widget IntegrationCall the Widget Initialize API with sandbox credentials. The widget loads against sandbox data.
Client DashboardOpen https://app.dollarpe.xyz?app_id={sandbox_app_id} using your sandbox app_id.
See the Sandbox testing guide for step-by-step flows.

​
Response format

All API responses follow this structure: 
{
  "status": true,
  "message": "Success",
  "data": {}
}