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

/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

9 body

9 total
Body · 9
providerstring | string | stringRequired

Payment provider type.

codestring

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

descriptionstring

Human-readable description.

environmentstring | string | string

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

publicKeystring

Public API key.

secretKeystring

Secret API key.

merchantIdstring

Merchant ID.

secureKeystring

Additional secure key.

extraobject

Additional provider-specific settings.

Request

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 '{
  "code": "gopay-production",
  "description": "GoPay production gateway",
  "publicKey": "example_publicKey",
  "secretKey": "example_secretKey",
  "merchantId": "example_merchantId",
  "secureKey": "example_secureKey",
  "extra": {}
}'

Response

Gateway created successfully.

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

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key