Skip to main content
POST
billing.refund.create-configured

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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

Charge id in your connected merchant account.

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

Amount to refund; omit for the full remaining amount.

reason
string

Why this refund was requested.

Required string length: 1 - 1000
receipt
string

Your own unique refund reference.

Required string length: 1 - 128
speed
enum<string>
default:normal

Processing preference. Faster processing may have merchant fees and is not guaranteed.

Available options:
normal,
faster_preferred
reverseTransfers
boolean
default:false

Also reverse associated transfers, when supported.

notes
object

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

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.