Guides

SDK & Payment Links

This checklist applies to integrations using Aeropay's Payment SDK or payment links. Make sure you've completed the universal production setup items before working through this page.

Payments

  • Run a successful test of a full end-to-end payment flow using the Payment SDK or payment link

  • Ensure you are able to

    void, partially refund, and fully refund, a transaction from the Aeropay merchant portal or via your back office - POST /reverseTransaction.

  • If your integration supports preauthorized transactions, ensure you can successfully

    • create - POST /preauthTransaction,
    • capture - POST /capturePreauthTransaction,
    • update - PATCH /preauthTransaction, and
    • cancel - DELETE /preauthTransaction from your back office.

Fraud Prevention

  • If applicable: your POS system must display the customer's Aeropay first and last name after payment so that staff can verify the name against the customer's ID. Failing to implement this check exposes your business to fraud risk.

Webhooks

General Webhook Requirements

  • Webhook subscriptions are required for all SDK & payment link integrations.
  • Ensure your system can receive webhooks from Aeropay's IP range (if applicable)
  • Optional: implement webhook signature validation to verify the authenticity of incoming payloads.
  • Webhooks in sandbox are a separate subscription from webhooks in prod. Subscribe to prod webhooks when you receive prod credentials.

Required

WebhookAction Required
preauthorized_transaction_created (if applicable)Confirm transaction pre-authorized in your back office.
transaction_completedConfirm transaction completion in your back office.
transaction_voidedPay-ins: Do not deliver product or credit the user's wallet/balance.

Testing: void any transaction via the sandbox merchant portal. Ensure correct logic is in place in response to a void.
transaction_refunded (if applicable)Confirm transaction refunded in your back office.

Recommended

You can optionally subscribe to the following webhooks depending on your use case. If you choose not to, be prepared to discuss your reasoning during integration review.

WebhookAction Required
transaction_declinedNo action needed — Aeropay handles recovery of funds. This webhook is informational and helps you stay aware of disputes and declined charges.
user_suspendedPrevent the user from initiating further Aeropay transactions. Suspend the user's activity on your platform until the suspension is resolved.

Testing: this will fire when a payment for a user is declined on any Aeropay network merchant. See decline testing in section above.
user_activeRe-enable the user's ability to transact on your platform.

Testing: on the declined transaction in the sandbox merchant portal, select "Resolve."

Error Handling

  • Ensure your integration has graceful error-handling in place. See the full Error Glossary.

Integration Approval

Once you've worked through the checklist above, submit the following to your Aeropay Solutions Engineer to complete your integration review.

Payment Flow Deliverables

  • Payment experience — Share a screen recording of the full end-to-end user experience of a payment flow using the Aeropay Payment SDK or payment link.
  • Name verification (if applicable) — Show that the customer's Aeropay first and last name is displayed on the POS or cashier-facing screen after payment, enabling ID verification.
  • Back office experience — Show/describe how your back office responds to a completed payment.
  • Preauth back office experience (if applicable) — Show how your back office
    • captures,
    • updates (PATCH), and
    • cancels preauth payments.

Integration Questions

Provide answers or confirmation for each item:

Updated 1 day ago