Docs API Reference Payment Gateway/bff/payment-gateway/update

/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

JSON body

Request body

application/json

codestringRequired

Gateway code to update.

Examplegopay-production

descriptionstringOptional

New description.

environment"p" | "s" | "t"Optional

New environment setting.

activebooleanOptional

Enable or disable the gateway.

publicKeystringOptional

New public API key.

secretKeystringOptional

New secret API key.

merchantIdstringOptional

New merchant ID.

secureKeystringOptional

New secure key.

extraobjectOptional

New extra configuration.

issuerContactExternalIdstringOptional

New invoice-issuer contact (shop__contact.external_id). When provided, every shop__order_group currently bound to this gateway has its invoice_issuer_id realigned in the same transaction — the app-level invariant is "as long as a group has a payment gateway, its issuer must equal the gateway's issuer".

ExampleaB3xKm9pQ2wLn4Yz

Response schema

1 status code documented

200SuccessGateway updated successfully.

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

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": {},
  "issuerContactExternalId": "aB3xKm9pQ2wLn4Yz"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key