Retrieve a payment provider
Reads one payment provider.
Stored credentials read as <stored secret>.
Guide: Payment providers
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.
paymentProviderId*string
The id of the project's payment provider connection, pp_conf_....
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/payment-providers/pp_conf_k2v8d4m1x7c9b3n6q0w5e2r8" \ -H "Authorization: Bearer vh_sk_..."{ "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"}{ "error": { "type": "invalid_request", "code": "string", "message": "string", "param": "string" }}{ "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": "payment_provider_not_found", "message": "This project has no payment provider pp_conf_k2v8d4m1x7c9b3n6q0w5e2r8.", "param": "paymentProviderId" }}{ "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
| Status | type | code | When |
|---|---|---|---|
| 404 | not_found | payment_provider_not_found | — |
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.