Skip to main content
POST
/
refund-transaction
/
{id}
Refund Transaction
curl --request POST \
  --url http://localhost:5001/refund-transaction/{id} \
  --header 'X-blnk-key: <api-key>'
{
  "id": "txn_043d4ac3-4caf-4149-9c0d-927ae637d83f",
  "tag": "Refund",
  "reference": "ref_70ffd90f-7bcf-43b8-90ba-70505c113b52",
  "amount": 300,
  "currency": "NGN",
  "payment_method": "",
  "description": "",
  "drcr": "Debit",
  "status": "APPLIED",
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0",
  "credit_balance_before": 600,
  "debit_balance_before": 0,
  "credit_balance_after": 600,
  "debit_balance_after": 300,
  "balance_before": 600,
  "balance_after": 300,
  "created_at": "2024-02-20T05:40:52.630481718Z",
  "scheduled_for": "0001-01-01T00:00:00Z",
  "risk_tolerance_threshold": 0,
  "risk_score": 0.03108,
  "meta_data": {
    "refunded_transaction_id": "txn_5bbbe4d3-2d82-4da1-8191-aaa491d025de"
  },
  "group_ids": null
}

Authorizations

​
X-blnk-key
string
header
required

Path Parameters

​
id
string
required
Example:

"txn_5bbbe4d3-2d82-4da1-8191-aaa491d025de"

Response

201 - application/json; charset=utf-8

Created

​
id
string
required
​
tag
string
required
​
reference
string
required
​
amount
integer<int32>
required
​
currency
string
required
​
payment_method
string
required
​
description
string
required
​
drcr
string
required
​
status
string
required
​
ledger_id
string
required
​
balance_id
string
required
​
credit_balance_before
integer<int32>
required
​
debit_balance_before
integer<int32>
required
​
credit_balance_after
integer<int32>
required
​
debit_balance_after
integer<int32>
required
​
balance_before
integer<int32>
required
​
balance_after
integer<int32>
required
​
created_at
string
required
​
scheduled_for
string
required
​
risk_tolerance_threshold
integer<int32>
required
​
risk_score
number
required
​
meta_data
MetaData1 · object
required
Example:
{
  "refunded_transaction_id": "txn_5bbbe4d3-2d82-4da1-8191-aaa491d025de"
}
​
group_ids
string | null
required