VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List payment providers
Add a payment provider
Retrieve a payment provider
Update a payment provider
Delete a payment provider
Test a payment provider
List a provider's catalog
List unmapped store products

List payment providers

Lists the project's payment providers, optionally only one type.

Stored credentials read as <stored secret>.

Guide: Payment providers

GET
/api/v1/projects/{projectId}/payment-providers

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

Query parameters

cursor?string

Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.

limit?integer

How many items to return, from 1 to 100. Defaults to 50.

Range1 <= value <= 100
type?string

Only providers of this type: app_store, google_play, stripe or payment_source.

Value in

  • "app_store"
  • "google_play"
  • "stripe"
  • "payment_source"

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/payment-providers" \  -H "Authorization: Bearer vh_sk_..."
{  "data": [    {      "id": "pp_conf_k2v8d4m1x7c9b3n6q0w5e2r8",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "type": "app_store",      "name": "App Store",      "key": "com.example.app",      "isEnabled": true,      "configuration": {        "appAppleId": "6448311234",        "bundleId": "com.example.app",        "inAppPurchaseKeyIssuerId": "57246542-96fe-1a63-e053-0824d011072a",        "inAppPurchaseKeyId": "2X9R4HXF34",        "inAppPurchasePrivateKey": "<stored secret>",        "appStoreConnectApiIssuerId": "57246542-96fe-1a63-e053-0824d011072a",        "appStoreConnectApiKeyId": "D8T2M6Q4ZL",        "appStoreConnectApiPrivateKey": "<stored secret>",        "appStoreConnectApiVendorNumber": "87654321",        "appleServerNotificationForwardingUrl": "",        "appleSmallBusinessProgramHasEndDate": false,        "trackNewPurchasesFromAppleServerNotifications": true      },      "createdAt": "2026-02-01T08:30:00.000Z",      "updatedAt": "2026-02-01T08:42:17.000Z"    },    {      "id": "pp_conf_m2c8v5n1x7z4q9w3e6r0t8y2",      "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",      "type": "payment_source",      "name": "Bank transfer",      "key": "bank-transfer",      "isEnabled": true,      "configuration": {        "slug": "bank-transfer",        "endpoint": {          "url": "https://example.com/voidhash/payment-source",          "signingSecret": "<stored secret>"        }      },      "createdAt": "2026-03-01T10:15:00.000Z",      "updatedAt": "2026-03-01T10:15:00.000Z"    }  ],  "pageInfo": {    "endCursor": null,    "hasNextPage": false  }}
{  "error": {    "type": "invalid_request",    "code": "invalid_query",    "message": "The request query is invalid: Expected a finite number\n  at [\"limit\"]"  }}
{  "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": "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

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Payment providers

  • Add a payment provider POST
  • Retrieve a payment provider GET
  • Update a payment provider PATCH
  • Delete a payment provider DELETE
  • Test a payment provider POST
  • List a provider's catalog GET
  • List unmapped store products GET

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousUpdate Meta measurement settingsNextAdd a payment provider

On this page

AuthorizationPath parametersQuery parametersExamplesResponse bodyErrorsMore in Payment providers