neo-pays

Disputes

Generated page, from the OpenAPI specification the gateway serves (GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.

Method Path Description
GET /v1/disputes List disputes
GET /v1/disputes/{id} Retrieve a dispute
POST /v1/disputes/{id}/response Respond to a dispute

GET /v1/disputes

List disputes

The disputes opened against your payments, with their response deadline.

Parameters

Name In Required Description
page query no
per_page query no
status query no

Responses

  • 200 — OK
  • 401 — API key missing or rejected (Error)
  • 403 — The key does not carry the required scope, or the account is not active (Error)
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)

GET /v1/disputes/{id}

Retrieve a dispute

The dispute, its reason and its state.

Parameters

Name In Required Description
id path yes The dispute's identifier or reference.

Responses

  • 200 — OK
  • 401 — API key missing or rejected (Error)
  • 403 — The key does not carry the required scope, or the account is not active (Error)
  • 404 — No dispute with that identifier (Error)
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)

POST /v1/disputes/{id}/response

Respond to a dispute

Your defence: a text and the evidence supporting it.

⚠️ THIS TEXT GOES THROUGH NEITHER THE EVENT STREAM NOR THE READ MODEL ([DB-13]) — so it is never returned by the reads above. This call's response is the authoritative snapshot, and the only place you will see it again.

A dispute already past open, or whose response window has closed, refuses with 422: no retry will get it through.

Parameters

Name In Required Description
id path yes The dispute's identifier or reference.
Idempotency-Key header no An idempotency key specific to THIS operation.

Request body

Field Type Required Description
merchant_response string no Your argument.
evidence string[] no The attachments, by their document reference.

Responses

  • 200 — Response recorded
  • 401 — API key missing or rejected (Error)
  • 403 — The key does not carry the required scope, or the account is not active (Error)
  • 404 — No dispute with that identifier (Error)
  • 422 — The dispute can no longer receive a response (Error)
  • 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)
  • 503 — The asset's scale is momentarily unreadable — the amount would be wrong, so it is not returned (Error)

Schemas

The shapes the operations above return.

Error

Field Type Description
error object
error.code string
error.message string