- @Pay 101
- Web Hooks
- RESTful API
- More API Wrappers
- Legacy Documentation
@Pay offers a suite of tools that developers can use to integrate our 2-click payment platform with any application. With the implementation of our v4 APIs, your organization can create offers, send invoices, register payment methods, receive transaction information & more!
Throughout the documentation there are references that are specific to the @Pay platform. Here are some brief descriptions:
@Pay 2-Click Enabled - A customer is 2-Click Enabled if they have registered their card with your organization to make payments. Any transaction request that is made with an @Pay Button or @Pay Mailto by a 2-Click Enabled customer will automatically process with your Gateway.
@Pay 2-Click Button - A mobile and platform optimized HTML button that is placed into an email campaign or mobile webpage. These link out to an @Pay Mailto or directly to a payment capture page. @Pay 2-Click Buttons are generally created and available when an offer is generated.
@Pay Hooks - We offer four types of hooks: 'Pre-Sale', 'Transaction', 'Error' & 'Further Action Required'. Depending on the hook type, these will send information to your application when specific events occur during a transaction.
@Pay Invoice - A special type of offer that is generated by the calculation of an itemized list.
@Pay Mailto - A mail-to link that contains specific tokenized details that are used to process a transaction when sent to the @Pay platform.
@Pay Offer - An offer can be generated manually from the Organization Dashboard or dynamically using one of our SDK's. Transactions are processed against offers. An offer can be tied to an @Pay 2-Click Button, a Payment Capture Page, an @Pay Invoice or even a QR code. When an offer is created, an @Pay Mailto is generated. When configuring an Offer you can set the price, expiration date, offer details, and a variety of additional options. A list of created Offers can be seen from within your Organization Dashboard.
Gateway - @Pay connects with a variety of different Gateways or payment processors. Every organization is provided with a "Test" gateway for development purposes. Gateways are added in the Organization Dashboard. An offer can be tied to a specific gateway when being created. If a specific gateway is not selected, the default gateway will be used. A list of compatibly gateways can be viewed here.
FAR (Further Action Required) - If a customer submits a transaction and @Pay needs further details, the transaction will be marked as FAR. By default @Pay will send an email specifying what is required. A customer will receive a FAR message if they are attempting to make a payment with your organization for the first time. On rare occasions, a FAR will also be generated to authenticate the transaction if certain security checks aren't met.