Skip to main content
POST
payments.dispute.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
transactionId
string
required

Payment this dispute belongs to.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
disputeId
string
required

Dispute id from a dispute list.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

disputeId
string
required

Dispute id in your connected payment account.

transactionId
string
required

The payment this dispute concerns.

amount
object
required

Disputed amount, in minor units.

reasonCode
string

Dispute reason code.

reason
string

Reason given for the dispute.

createdAt
string

Creation time, ISO 8601.

reversedAt
string

Reversal time, ISO 8601, when reversed.