API reference

The production API uses:

https://omnipay.page/api

Every endpoint below is generated from OmniPay's versioned OpenAPI 3.1 contract.

Download the OpenAPI document →

Deposits

• Create a deposit
• Get a deposit
• Submit an H2H payment transaction ID

Withdrawals

• Create a withdrawal
• Get a withdrawal

Authentication

All endpoints use Authorization: Bearer <api-key>. H2H creation, H2H status, and H2H verification additionally require X-Omni-Timestamp and X-Omni-Signature.

The interactive schema lists those headers, but the signature depends on the exact outgoing body. Generate it in your backend immediately before sending the request.

Read the signing guide →

Response conventions

Amounts are BDT decimal strings. Timestamps are UTC. Error responses use the stable error.code envelope, and every response includes X-Request-Id for support and debugging.

Read API conventions →