Rotate the signing secret of an endpoint

POST

/webhook-endpoints/{endpoint_id}/rotate-secret

const url = 'https://api.pachapay.io/v1/webhook-endpoints/example/rotate-secret';
const options = {
  method: 'POST',
  headers: {'Idempotency-Key': 'example', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.pachapay.io/v1/webhook-endpoints/example/rotate-secret \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: example'

The old secret stays valid for 24 hours. During that time each delivery carries two v1 signatures.

Authorizations

ApiKey

Parameters

Path Parameters

endpoint_id

required

string

/^whk_/

Header Parameters

Idempotency-Key

required

string

<= 255 characters

Unique key per logical operation, up to 255 characters. Keys are kept for 24 hours. Same key with a different body returns 409 idempotency_conflict, and the same key while the first request is still running returns 409 idempotency_in_progress.

Responses

200

Endpoint with the new secret, shown once.

application/json

object

required

string

url

required

string format: uri

/^https:///

events

required

Array<string>

Allowed values: payment.created payment.requires_action payment.succeeded payment.failed payment.expired payment.canceled payment.partially_paid payment.overpaid payment.chargeback payout.created payout.succeeded payout.failed payout.canceled payout.returned refund.succeeded refund.failed payment.processing payment.on_hold payout.processing payout.on_hold payout.delayed refund.created refund.processing refund.returned balance.updated

status

required

string

Allowed values: active disabled

created_at

string format: date-time

secret

required

Signing secret, shown only once.

string

Example

{
  "id": "whk_0192f3f0",
  "events": [
    "payment.created"
  ],
  "status": "active"
}

4XX

Error. See error.code.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error invalid_state_error idempotency_error rate_limit_error api_error

code

required

Stable machine-readable code that does not change within a major version. Examples are parameter_invalid, parameter_missing, amount_out_of_range, api_key_invalid, api_key_revoked, merchant_not_active, method_not_allowed, country_not_allowed, resource_not_found, idempotency_conflict, idempotency_in_progress, invalid_state, insufficient_balance, method_not_available, blocked_payer, limit_exceeded, rate_limited, internal_error, provider_unavailable, service_unavailable.

string

message

required

string

param

Name of the offending parameter, if any.

string

request_id

required

string

Examples

Merchant not approved

{
  "error": {
    "type": "permission_error",
    "code": "merchant_not_active",
    "message": "KYB is not approved for this merchant.",
    "request_id": "req_01"
  }
}

Not enough balance

{
  "error": {
    "type": "invalid_state_error",
    "code": "insufficient_balance",
    "message": "Available balance is lower than the amount plus fee.",
    "param": "amount",
    "request_id": "req_02"
  }
}

5XX

Error. See error.code.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error invalid_state_error idempotency_error rate_limit_error api_error

code

required

string

message

required

string

param

Name of the offending parameter, if any.

string

request_id

required

string

Examples

Merchant not approved

{
  "error": {
    "type": "permission_error",
    "code": "merchant_not_active",
    "message": "KYB is not approved for this merchant.",
    "request_id": "req_01"
  }
}

Not enough balance

{
  "error": {
    "type": "invalid_state_error",
    "code": "insufficient_balance",
    "message": "Available balance is lower than the amount plus fee.",
    "param": "amount",
    "request_id": "req_02"
  }
}