Incremental Auth

​

Incremental Auth with breakdown support and proportional calculations

Path Parameters
  • transaction_id
    Type: string · Transaction Id
    required
Headers
  • Accept
    enum
    const:  
    application/json
    required

    Response format. Must be application/json.

    values
    • application/json
  • Content-Type
    enum
    const:  
    application/json
    required

    Request payload format. Must be application/json when a body is sent.

    values
    • application/json
Body·ProcessAuthRequestModel
required
application/json
  • amount
    Type: integer · Amount
    required

    Integer numbers.

  • breakdown
    Type: object · Breakdown nullable

    Payment amount breakdown. Splits the total into subtotal, tax, and tip components. All monetary amounts are in cents. For surcharge-aware breakdowns, use the enhanced breakdown with surcharge support.

  • event_id
    Type: string | null · Event Id
Responses
  • application/json
  • application/json
Request Example for post/v3/payments/{transaction_id}/auth
curl 'https://api.uat.koard.com/v3/payments/{transaction_id}/auth' \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN' \
  --data '{
  "amount": 1,
  "breakdown": {
    "subtotal": 1,
    "taxAmount": 1,
    "taxRate": 1,
    "tipAmount": 1,
    "tipRate": null,
    "tipType": ""
  },
  "event_id": null
}'

{
  "account_id": "string",
  "additional_details": {},
  "apple_transaction_id": "string",
  "batch_id": null,
  "card": "string",
  "card_brand": "string",
  "card_type": "string",
  "created_at": 1,
  "currency": "string",
  "device_id": null,
  "event_id": "string",
  "gateway": null,
  "gateway_transaction_id": null,
  "gateway_transaction_response": null,
  "history": [],
  "location_id": null,
  "merchant_name": "",
  "mid": "string",
  "owner_id": null,
  "parent_account_ids": [
    "string"
  ],
  "payment_method": "string",
  "processor": null,
  "processor_mid": "string",
  "processor_response_code": null,
  "processor_response_message": null,
  "processor_tid": "string",
  "reader_identifier": "string",
  "refunded": null,
  "reversed": null,
  "status": null,
  "status_reason": null,
  "subtotal": 1,
  "surcharge_amount": null,
  "surcharge_applied": false,
  "surcharge_rate": null,
  "tax_amount": null,
  "tax_rate": null,
  "tid": "string",
  "tip_amount": null,
  "tip_type": null,
  "total_amount": 1,
  "transaction_id": "string",
  "transaction_type": null
}

Successful Response