GET
Get a chargeback

Authorizations

Authorization
string
header
default:sk_test_docs_246e232c64ccc7a001bf61ec0f2e6ab0
required

Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown once when created in the dashboard, and are scoped (see x-required-scope on each operation). Keep them on your server. Live keys are issued after your business is verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.

Path Parameters

id
string<uuid>
required

Response

The chargeback

id
string<uuid>
required
object
string
required
Allowed value: "chargeback"
livemode
boolean
required
escrow_id
string<uuid>
required
milestone_ids
string<uuid>[]
required

The milestones the reversed card payment covered

amount
integer
required

Amount in kobo

Required range: x >= 0
Example:

45000000

reason
enum<string>
required

The reason the card bank gave

Available options:
fraudulent,
not_received,
not_as_described,
duplicate,
other
status
enum<string>
required

needs_response: KetaPay is gathering evidence (the seller can add some until respond_by). under_review: with the card bank. won: reversed in KetaPay's favour, nothing changes. lost: the bank took the money back.

Available options:
needs_response,
under_review,
won,
lost
respond_by
string<date-time> | null
required
recovered_from_seller
integer
required

For lost, how much has been recovered from the seller's balance and payouts so far

Required range: x >= 0
Example:

45000000

commission_reversed
integer
required

For lost after release, your commission taken back from your commission balance

Required range: x >= 0
Example:

45000000

opened_at
string<date-time>
required
closed_at
string<date-time> | null
required