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

/bff/payment-gateway/add

Creates a new payment gateway instance. The provider must be one of the supported types. Credentials can be provided during creation or added later via the update endpoint.

Payment GatewaypostBffPayment-gatewayAdd

Parameters

JSON body

Request body

application/json

provider"gopay" | "comgate" | "stripe"Required

Payment provider type.

issuerContactExternalIdstringRequired

External id (shop__contact.external_id) of the contact that will be the invoice issuer for documents produced through this gateway. Required — the schema has a NOT NULL FK. The picker in the admin forces a selection and the create endpoint rejects a missing or cross-tenant contact.

ExampleaB3xKm9pQ2wLn4Yz

codestringOptional

Custom code/slug. Auto-generated if not provided.

Examplegopay-production

descriptionstringOptional

Human-readable description.

ExampleGoPay production gateway

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

Environment: "p" = Production, "s" = Sandbox (default), "t" = Test.

publicKeystringOptional

Public API key.

secretKeystringOptional

Secret API key.

merchantIdstringOptional

Merchant ID.

secureKeystringOptional

Additional secure key.

extraobjectOptional

Additional provider-specific settings.

Response schema

1 status code documented

200SuccessGateway created successfully.

successbooleanRequired

Default: true

codestringRequired

The code/slug assigned to the new gateway.

Response example

application/json

{
  "success": true,
  "code": "example_code"
}

Request example

POST /bff/payment-gateway/add

post

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

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key