v1

latestOpenAPI 3.0.02026-07-24440173.4 KB

Payments

Update Payment (Capture or Release)

Used in the Auth & Capture flow to capture full/partial amount or release the authorized amount back to the customer. Only one Capture or Release operation is allowed for each invoice.

put/v3/payments/{paymentId}

Path parameters

paymentIdstring required

Request body

OperationType'CAPTURE' | 'RELEASE' required

Operation type to execute. Use CAPTURE to capture the authorized amount (fully or partially) or RELEASE to return the full amount to the customer.

Amountnumber

Amount to be captured. Required only when OperationType is CAPTURE.

Response

IsSuccessboolean

Indicates if the request was successful.

Messagestring

Response message associated with the request.

ValidationErrorsobject[]

A model that contains two keys "Name" and "Error". This is used to indicate the validation result for all parameters you have sent in your request. This can have one or more items based on the invalid parameter count.