tipConfiguration

Retrieve the Aeropay tipping configuration for the authenticated merchant.

Use this endpoint to render tip options in your own checkout flow instead of maintaining a duplicate copy of the merchant's tip settings. Tip settings are managed in the Aeropay Merchant Portal, and this response always reflects their current state.

The merchant is derived from the merchant-scoped token, so this endpoint takes no request parameters. Tipping is configured at the merchant level and cannot be configured per merchant location.

Check enabled first

The response has two shapes. When tipping is off, tipConfiguration contains enabled and nothing else:

{"tipConfiguration": {"enabled": false}}

options, defaultValue, and customTipEnabled are omitted entirely rather than returned empty, because they describe how to render a tip prompt that will never be shown. A merchant that configured tip options and later turned tipping off returns this same response - leftover options are not surfaced. Read enabled before reading any other field.

A merchant with no tipping configuration at all returns this same shape with 200. It is not an error condition.

Reading options

When enabled is true, each entry in options is discriminated by type, and the shape of value changes accordingly:

  • type: "percentage"value is the tip percentage as a number, for example 15 or 12.5. It is a percentage of the transaction amount, not a decimal multiplier.
  • type: "flat"value is a money object, {"amount": <integer cents>, "currency": "USD"}, matching the amount convention used elsewhere in the v2 API. An amount of 500 is $5.00.

A custom (user-entered) tip is reported by the customTipEnabled boolean and is never returned as an entry in options. A merchant whose only configured tip is a custom one returns enabled: true with an empty options array and customTipEnabled: true.

This endpoint is read-only and does not apply a tip. Once a tip is selected, send it as a tip attribute on POST /v2/transaction or PATCH /v2/preauthTransaction/{preauthTransactionId}.

Error Glossary (click to expand)
CodeHTTP StatusMessage
AP101401A merchant-scoped token is required
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Headers
string
required

Merchant token with Bearer prefix.

Responses

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