Add a payment provider
Adds a payment provider.
A store starts disabled; save its settings and credentials with an update that enables it. A payment source is created with configuration: { slug }, which it keeps, and is enabled at once. A project has one provider per store and one payment source per slug.
Guide: Payment providers
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
Where the project takes payments: app_store, google_play or stripe, or a payment_source that reports its own purchases through the API, such as bank transfers or vouchers.
Value in
- "app_store"
- "google_play"
- "stripe"
- "payment_source"
A payment source's display name, its slug by default. A store is named after the store.
A payment source's { "slug": ... }, which it keeps, optionally with its endpoint and testEndpoint, each { "url", "signingSecret" }. A store takes its settings in a later update.
Examples
curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/payment-providers" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "type": "payment_source", "name": "Bank transfer", "configuration": { "slug": "bank-transfer" } }'{ "id": "pp_conf_m2c8v5n1x7z4q9w3e6r0t8y2", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "type": "payment_source", "name": "Bank transfer", "key": "bank-transfer", "isEnabled": true, "configuration": { "slug": "bank-transfer" }, "createdAt": "2026-03-01T10:15:00.000Z", "updatedAt": "2026-03-01T10:15:00.000Z"}{ "error": { "type": "invalid_request", "code": "invalid_payment_provider_configuration", "message": "Live Stripe API key must start with sk_live_ or rk_live_", "param": "configuration" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "conflict", "code": "payment_provider_exists", "message": "Provider stripe can only have one configuration" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | invalid_payment_provider_configuration | For invalid settings. |
| 409 | conflict | payment_provider_exists | For another. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Payment providers
Something wrong or missing on this page? Tell us by email or on Discord.