v1

latestOpenAPI 3.0.02026-07-263118119.8 KB

Create & Manage Transactions

preauthTransaction

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

Note: The updated transaction amount may not exceed the original amount that was preauthorized.

<details> <summary><strong>Error Glossary</strong> (click to expand)</summary>

Code	HTTP Status	Message
AP009	401	Unauthorized
AP101	401	No authenticated user
AP300	200	Unable to connect to bank
AP302	200	Insufficient funds
AP310	200	Credit transaction declined
AP312	200	Preauth already captured
AP313	200	Preauth ineligible for capture
AP315	200	Payment rejected - threshold or suspended bank
AP700	400	Missing or invalid required parameter
AP701	400	Improperly formatted parameter
AP1000	200	Invalid API

</details>

patch/v2/preauthTransaction/{preauthTransactionId}

Headers

Content-Typestring required

authorizationstring required

A merchant scoped token.

Request body

Example request

{
  "attributes": {
    "invoice": {
      "value": "Value",
      "description": "Description"
    },
    "tip": {
      "tipAmount": "1.00",
      "label": "$1.00",
      "totalAmount": "2.00"
    }
  }
}

Response

Success or Business Logic Error

Example response

{
  "error": {
    "help": "Contact support@aeropay.com for help.",
    "code": "AP700",
    "message": "Missing required Parameter: 'email'"
  }
}