preauthTransaction

Update the specified preauthorized transaction. Preauthorized transaction amounts can be increased or decreased. Attributes can also be added for tipping purposes.

Error Glossary (click to expand)
CodeHTTP StatusMessage
AP009401Unauthorized
AP101401No authenticated user
AP300200Unable to connect to bank
AP302200Insufficient funds
AP310200Credit transaction declined
AP312200Preauth already captured
AP313200Preauth ineligible for capture
AP315200Payment rejected - threshold or suspended bank
AP700400Missing or invalid required parameter
AP701400Improperly formatted parameter
AP1000200Invalid API
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Id of preauthorized transaction to query by

Body Params

Body of preauthtransaction patch call

amount
object

Dictionary with currency and amount in pennies. Only USD supported at this time

attributes
object

Dictionary with attributes. Tip and invoice are standard formats. Custom attributes must follow value/description dictionary formatting.

Headers
string
required

A merchant scoped token.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json