CollectPaymentsPayment Initiation

Adjust Authorized Amount

Modify the authorized amount for a payment. This action is feasible only if the authorizationType was initially set to ESTIMATED during the payment creation, and the payment method supports this feature.

Path parameters

idstringRequiredformat: "uuid"

Identifier of the payment to adjust. (In the transaction-based model, this is the transactionId.)

Request

This endpoint expects an object.
amountintegerRequired
The final amount you would like to charge the customer, in minor units.

Response

Authorization adjusted successfully.
statusstring
Current transaction status.
transactionIdstring
Unique identifier for the transaction.
messagestring

Human-readable status message.

authStateobjectOptional

Indicates additional steps required to complete a transaction. The shape varies by payment method and processor. Use type to determine which fields are present.

sessionIdstringOptionalformat: "uuid"
Session the transaction belongs to.
merchantReferencestringOptional
Merchant reference from the original session.
processorNamestringOptional

Name of the payment processor (if assigned).

processorReferencestringOptional

Processor reference (if available).

paymentAttributesmap from strings to stringsOptional
Attributes associated with the payment.
batchPayoutIdstringOptional
Batch payout identifier, present when the transaction is part of a batch payout.
collectionobjectOptional

Amount the customer paid in the collection currency. Present only on transactions converted by Adaptive Currency Conversion — per-session rate or rate lock.

fxMidRatestringOptional

Spot mid-market rate at the time the FX quote was committed for this attempt (decimal string, 8 decimal places). Present only on FX-converted transactions.

fxAllInRatestringOptional

Mid rate + markup — the rate this attempt was actually converted at (decimal string, 8 decimal places). Present only on FX-converted transactions.

fxMarkupBpsintegerOptional>=0

Markup applied to this attempt in basis points (100 bps = 1%). Present only on FX-converted transactions.

fxFeeobjectOptional

Conversion fee, denominated in the collection currency. Present only on FX-converted transactions.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error