DocsAPI ReferencePayment Gateway/bff/payment-gateway/update
postPayment GatewayAdmin BFF

/bff/payment-gateway/update

Updates an existing payment gateway instance. Only provided fields will be updated. To clear a field, pass an empty string. To change credentials, provide new values.

Payment GatewaypostBffPayment-gatewayUpdate

Parameters

9 body

9 total
Body · 9
codestringRequired

Gateway code to update.

descriptionstring

New description.

environmentstring | string | string

New environment setting.

activeboolean

Enable or disable the gateway.

publicKeystring

New public API key.

secretKeystring

New secret API key.

merchantIdstring

New merchant ID.

secureKeystring

New secure key.

extraobject

New extra configuration.

Request

POST /bff/payment-gateway/update

post
curl -X POST "https://api.bizkithub.com/bff/payment-gateway/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "gopay-production",
  "description": "example_description",
  "active": false,
  "publicKey": "example_publicKey",
  "secretKey": "example_secretKey",
  "merchantId": "example_merchantId",
  "secureKey": "example_secureKey",
  "extra": {}
}'

Response

Gateway updated successfully.

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key