Refund (v2)

​

Refund a captured transaction. The current refund endpoint. Omit amount for a full refund, or supply it to refund part of the transaction. Card-present refunds may include card_reader_data or the raw emv_card_data / emv_general_data captured at the tap.

Path Parameters
  • transaction_id
    Type: string · Transaction Id
    required

    ID of the transaction to refund.

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·
required
application/json

Refund request model. Supports card-present refunds with reader data.

  • amount
    Type: integer | null · Amount

    Refund amount in cents. If omitted, the full original transaction amount is refunded.

  • card_reader_data
    Type: object · nullable

    Optional card reader data for card-present refunds.

  • emv_card_data
    Type: string | null · Emv Card Data

    Raw EMV card data captured at the tap, for card-present refunds.

  • emv_general_data
    Type: string | null · Emv General Data

    Raw EMV general data captured at the tap, for card-present refunds.

  • event_id
    Type: string | null · Event Id

    Idempotency key. Auto-generated if omitted.

  • transaction_id
    Type: string | null · Transaction Id

    ID of the original transaction to refund.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v2/payments/{transaction_id}/refund
curl 'https://api.uat.koard.com/v2/payments/{transaction_id}/refund' \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN' \
  --data '{
  "transaction_id": null,
  "amount": null,
  "card_reader_data": {
    "id": "",
    "paymentCardData": "",
    "generalCardData": "",
    "outcome": 1,
    "pinBypassed": false,
    "isPINFallback": false
  },
  "event_id": null,
  "emv_card_data": null,
  "emv_general_data": 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": "approved",
  "subtotal": 1,
  "surcharge_amount": null,
  "surcharge_applied": false,
  "surcharge_rate": null,
  "tax_amount": null,
  "tax_rate": null,
  "tid": "string",
  "tip_amount": null,
  "tip_type": "fixed",
  "total_amount": 1,
  "transaction_id": "string",
  "transaction_type": null,
  "surcharge_basis": "total",
  "surcharge_confirmation_required": null,
  "tax_basis": "total",
  "device_type": null,
  "psp": null,
  "surcharge_source": "transaction",
  "tax_source": "transaction",
  "terminal_details": null,
  "tip_capture_mode": "tip_at_sale"
}

Successful Response