TransactionsTransaction details

Get refunds recorded against a transaction

get/v1/transactions/refund-details

Returns the refunds (amount and time) recorded against one payment, newest first. For source=payments (the default for any value other than card_payment) the lookup is keyed on orderRef. For source=card_payment it is keyed on pspReference (the legacy CrossReference), or on orderId when isLiable is true. For API key callers the merchant that owns the record must belong to the key's reseller; otherwise, or when no such record exists, the response is 404. This route is registered before GET /v1/transactions/{orderRef}, so the literal path /v1/transactions/refund-details always reaches this handler, never the transaction detail lookup.

Endpoint destination URL

https://sandbox-portal.datmanlabs.com/api/v1/transactions/refund-details

Authorization

ApiKeyAuth
headerapi_key<token>

Partner API key issued by Datman.

Request Parameters

Query Parameters

source*string

Which table the payment lives in. card_payment is the legacy table; any other non-empty value is treated as payments.

orderRef?string

Datman order reference. Required when source is payments. The snake_case alias order_ref is also accepted.

pspReference?string

Legacy card_payment CrossReference. Required when source is card_payment and isLiable is not true. The snake_case alias psp_reference is also accepted.

orderId?string

card_payment order ID. Required when source is card_payment and isLiable is true.

isLiable?string

Only the exact string true enables liable-account lookup; any other value means false.

Default"false"
Value in"true""false"
timezone?string

IANA timezone to render refund times in. Not validated; an unknown name results in a 500. When omitted, times are Europe/London.

Response parameters & Errors

Response Body

The refunds for the transaction (an empty array when there are none). The timezone the times are expressed in is returned in meta.timezone.

application/json
  1. response
data*array<>
meta*