Get Refund

GET

/api/:account_id/payments/refunds/:refund_id

GET

/api/:account_id/payments/refunds/:refund_id

$ curl https://app.paymentkit.com/api/account_id/payments/refunds/refund_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "ref_8a7b6c5d4e3f2a1b",
3   "account_id": "acc_1234567890abcdef",
4   "charge_id": "ch_0987654321fedcba",
5   "amount_atom": 250000,
6   "currency": "usd",
7   "status": "succeeded",
8   "created_at": "2024-04-20T14:30:00Z",
9   "updated_at": "2024-04-20T14:45:00Z",
10   "reason": "requested_by_customer",
11   "processor_refund_id": "re_1J2K3L4M5N6O7P8Q",
12   "failure_code": null,
13   "failure_message": null,
14   "processed_at": "2024-04-20T14:45:00Z",
15   "metadata": {
16     "order_id": "ord_20240420_001",
17     "customer_note": "Customer requested refund due to damaged item"
18   }
19 }

Get a refund by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

refund_idstringRequired

account_idstringRequired

Response

Successful Response

idstring

ID of the refund

account_idstring

ID of the account

charge_idstring

ID of the original charge

amount_atominteger

Refund amount in atoms

currencyenum

Currency code (e.g., USD)

statusenum

Status of a refund throughout its lifecycle.

created_atdatetime

updated_atdatetime

reasonenum or nullOptional

Reason for initiating a refund.

processor_refund_idstring or nullOptional

Processor’s refund ID (e.g., Stripe’s re_xxx)

failure_codestring or nullOptional

failure_messagestring or nullOptional

processed_atdatetime or nullOptional

metadatamap from strings to any or nullOptional

Errors

422

Unprocessable Entity Error