BizKitHub
DocsAPI ReferenceOrder/api/v1/shop/order/record-in-app-payment
postOrderPublic API v1

/api/v1/shop/order/record-in-app-payment

Records a payment the shop collected through App Store or Google Play (payment kind in_app). Call it from your server after verifying the purchase with the store; never from a client app. When the recorded payments cover the order price, the order is marked as paid with the standard workflow (e-mails, reservations, lock codes).

orderpostApiV1ShopOrderRecord-in-app-payment

Parameters

1 query · JSON body

Query parameters

· 1
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json
orderIdstringRequired

Order hash.

Length: 32–32
ExamplesSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S
identityIdstringOptional

Customer identity (/customer/login). When set, the order must belong to this customer.

store"app_store" | "google_play"Required

Store that collected the money.

Exampleapp_store
transactionIdstringRequired

Store transaction id (App Store transactionId, Google Play orderId). Unique: a retry with the same id returns the first result, the same id on another order is refused with 409.

Length: 1–64
Examples2000000812345678GPA.3312-4580-1234-56789
pricenumberRequired

Amount in the order currency.

Example290
notestringOptional

Free text stored with the payment row.

Length: 0–500

Response schema

1 status code documented

200Success
success"true"Required
paymentIdstringRequired
Example184233
alreadyRecordedbooleanRequired

True when this transaction id was already recorded on the order.

triggeredMarkAsPaidbooleanRequired

True when this call marked the order as paid.

totalReceivedAfternumberRequired
Example290
orderPricenumberRequired
Example290

Response example

application/json
{
  "success": true,
  "paymentId": "184233",
  "alreadyRecorded": false,
  "triggeredMarkAsPaid": false,
  "totalReceivedAfter": 290,
  "orderPrice": 290
}

Request example

POST /api/v1/shop/order/record-in-app-payment

post
curl -X POST "https://api.bizkithub.com/api/v1/shop/order/record-in-app-payment?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "orderId": "sSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S",
  "identityId": "example_identityId",
  "store": "app_store",
  "transactionId": "2000000812345678",
  "price": 290,
  "note": "example_note"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key