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

/bff/payment-gateway/sync-payment

Fetches the current payment status from the payment provider and updates the local record. Useful for checking if a payment has been completed or for troubleshooting.

Payment GatewaypostBffPayment-gatewaySync-payment

Parameters

JSON body

Request body

application/json

idstringOptional

Payment ID to sync.

Examplepay_12345

orderHashstringOptional

Order hash - syncs all payments for this order.

Exampleabc123def

Response schema

1 status code documented

200SuccessSync result.

successbooleanRequired

Default: true

messagestringOptional

Error message if sync failed.

Response example

application/json

{
  "success": true,
  "message": "example_message"
}

Request example

POST /bff/payment-gateway/sync-payment

post

curl -X POST "https://api.bizkithub.com/bff/payment-gateway/sync-payment" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "pay_12345",
  "orderHash": "abc123def"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key