Skip to main content
POST
payments.payment.update-amount

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
paymentId
string
required

Authorised, uncaptured payment ID in your own connected account.

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

New total authorised amount, not a delta, in the original currency’s minor units.

industryUse
enum<string>

Reason for the adjustment, when needed.

Available options:
delayed-charge,
installment,
no-show
lineItems
object[]

Updated item prices and quantities, when the payment method requires them.

Required array length: 1 - 100 elements

Response

The result

status
enum<string>
required

Pending means received; final approval comes separately.

Available options:
pending,
unknown
amount
object

The requested new total.