Skip to main content
POST
payments.refund.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
refundId
string
required

refundId in your connected merchant account.

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

Response

The result

refundId
string
required

Refund id in your connected merchant account.

status
enum<string>
required

Succeeded only after confirmed processing.

Available options:
pending,
succeeded,
failed,
unknown
amount
object
required

Refund amount in minor units.

paymentId
string

Payment being refunded.

receipt
string

Your own receipt or reference.

speedRequested
enum<string>

Requested processing preference; faster processing is not guaranteed.

Available options:
normal,
faster_preferred,
unknown
speedProcessed
enum<string>

Actual processing speed when known.

Available options:
normal,
instant,
unknown
notes
object

Your own reference notes, at most 15 entries of 256 characters each.

createdAt
string

When the refund was created, ISO 8601.