Update a payment provider

A credential sent as <stored secret> keeps the stored one. Enabling validates the settings and credentials with the store, while a disabled provider saves incomplete settings. A payment source keeps its slug. The last update wins.

Guide: 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.

paymentProviderId*string

The id of the project's payment provider connection, pp_conf_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

name?|

The new display name.

isEnabled?|

Whether the provider's purchases are processed. Enabling validates the settings and credentials with the store.

configuration?|

Replaces the stored settings. A credential sent as "<stored secret>" keeps the stored one.

Examples

curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/payment-providers/pp_conf_m2c8v5n1x7z4q9w3e6r0t8y2" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "configuration": {      "slug": "bank-transfer",      "endpoint": {        "url": "https://example.com/voidhash/payment-source",        "signingSecret": "whsec_..."      }    }  }'

{  "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"}

{  "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_key_taken",    "message": "Another payment provider of this project is already set up for this app or account.",    "param": "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`

Errors

Status	`type`	`code`	When
400	`invalid_request`	`invalid_payment_provider_configuration`	When enabling a provider whose settings or credentials the store refuses.
409	`conflict`	`payment_provider_key_taken`	When another provider of the project is set up for the same app or account.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Payment providers

Guide: 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.

paymentProviderId*string

The id of the project's payment provider connection, pp_conf_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

name?|

The new display name.

isEnabled?|

Whether the provider's purchases are processed. Enabling validates the settings and credentials with the store.

configuration?|

Replaces the stored settings. A credential sent as "<stored secret>" keeps the stored one.

Examples

curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/payment-providers/pp_conf_m2c8v5n1x7z4q9w3e6r0t8y2" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "configuration": {      "slug": "bank-transfer",      "endpoint": {        "url": "https://example.com/voidhash/payment-source",        "signingSecret": "whsec_..."      }    }  }'

{  "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"}

{  "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_key_taken",    "message": "Another payment provider of this project is already set up for this app or account.",    "param": "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`

Errors

Status	`type`	`code`	When
400	`invalid_request`	`invalid_payment_provider_configuration`	When enabling a provider whose settings or credentials the store refuses.
409	`conflict`	`payment_provider_key_taken`	When another provider of the project is set up for the same app or account.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

Update a payment provider

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

Update a payment provider

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`