Delete a payment provider
Deletes a payment provider; purchases it recorded keep their history.
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 DELETE "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/payment-providers/pp_conf_m2c8v5n1x7z4q9w3e6r0t8y2" \ -H "Authorization: Bearer vh_sk_..."Empty
{ "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": "conflict", "code": "payment_provider_in_use", "message": "Store products of this payment provider are mapped to products; delete those mappings first." }}{ "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 | — |
| 409 | conflict | payment_provider_in_use | While store products are mapped to products: delete those mappings first. |
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.