Skip to main content
Create a refund

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

1 to 255 printable ASCII characters with no spaces, quotes or backslashes, in double quotes as the IETF draft defines, or without them. We recommend a UUID. Make one for each thing you mean to happen once and store it before you send the request, so a retry after a crash sends the same key. Keys are scoped to your account and the endpoint, not to a token, so a new token or a rotated secret doesn't affect a retry. A partner and its merchant are separate accounts, so the same key sent with each credential starts two requests. Keys are kept for at least 7 days. After that, the same key starts a new request.

Required string length: 1 - 257
Pattern: ^(?:([\x21\x23-\x5B\x5D-\x7E]{1,255})|"([\x21\x23-\x5B\x5D-\x7E]{1,255})")$

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
amount
object
required

What the customer gets back, in the payment transaction's currency. Decimals are refused, and more than the refundable amount answers REFUND_AMOUNT_EXCEEDED.

execution
enum<string>
required

Whether the refund moves money by itself. There is no default.

  • automatic: Quidkey moves the money as soon as it can, with no further call.
  • manual: The refund is held until :executeRefund, and a held refund blocks further refunds of that payment transaction until it is executed, or cancelled by Quidkey support.
Available options:
automatic,
manual
reason
string
Maximum string length: 255

Response

The transaction, in the full view.

result
object
required
entities
object
required

Nothing can be included here.

not_included
object[]
required