Merchant API
Merchant APIs let external platforms resolve users, fund external wallets, withdraw to EgaCard, create payment sessions, rotate credentials, manage apps, and reconcile webhook events.
Endpoints
| Endpoint | Method | Auth | Headers | Notes |
|---|---|---|---|---|
Register merchant/business/api/v1/merchant/register/Create a merchant profile and owner relationship. |
POST | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Merchant KYB/business/api/v1/merchant/{code}/kyb/Create, submit, and update a merchant KYB profile. |
GET/POST | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Resolve EgaCard user/business/api/v1/public/users/resolve/Resolve an EgaCard user for merchant-to-wallet withdrawal flows. |
POST | Merchant HMAC Authenticated caller |
X-EGACARD-API-KEY: <merchant-public-key>X-EGACARD-SIGNATURE: <hmac-signature>X-EGACARD-TIMESTAMP: <unix-timestamp>X-EGACARD-IDEMPOTENCY-KEY: <unique-request-key> |
Idempotency: Required Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Create payment session/business/api/v1/public/payment-sessions/Create an EgaCard payment session for hosted checkout or payment-link flows. |
POST | Merchant HMAC Authenticated caller |
X-EGACARD-API-KEY: <merchant-public-key>X-EGACARD-SIGNATURE: <hmac-signature>X-EGACARD-TIMESTAMP: <unix-timestamp>X-EGACARD-IDEMPOTENCY-KEY: <unique-request-key> |
Idempotency: Required Webhooks: payment.successful, payment.failed Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Verify transaction/business/api/v1/public/transactions/verify/Verify a merchant-linked EgaCard transaction by reference. |
POST | Merchant HMAC Authenticated caller |
X-EGACARD-API-KEY: <merchant-public-key>X-EGACARD-SIGNATURE: <hmac-signature>X-EGACARD-TIMESTAMP: <unix-timestamp>X-EGACARD-IDEMPOTENCY-KEY: <unique-request-key> |
Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Resolve external merchant user/business/api/v1/consumer/external-users/resolve/Consumer flow that resolves an external wallet recipient on a merchant platform. |
POST | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Fund external wallet/business/api/v1/consumer/external-wallets/fund/Debit an EgaCard wallet and fund an external merchant wallet. |
POST | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Webhooks: api.payment.successful, wallet.debited Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |