Getting Started for eComm
An overview of the minimum requirements for eCommerce merchants to successfully integrate with ChargeAfter.
To get started with ChargeAfter functionality, this is what you minimally need for a basic integration:
Application Process
- Integrate the ChargeAfter SDK via NPM to enable modal functionality.
See SDK Integration. - Integrate the Apply flow with the SDK.
See Apply. - Integrate the Apply Completion Callback to know when a consumer has completed an Apply flow.
See Events (callbacks). - Integrate the Checkout flow with the SDK.
See Checkout. - Integrate the Checkout Completion Callback to know when a consumer has completed a Checkout flow.
See Events (callbacks). - Integrate Promotional Widgets to embed ChargeAfter functionality on your website.
See Widget Structure & Implementation.
Post-Sale Process
- Get your API keys and be prepared to use the following endpoints:
POST .../v2/post-sale/charges
See Create a new Charge.POST .../v2/post-sale/charges/{chargeid}/voids
See Void a Charge.POST .../v2/post-sale/charges/{chargeid}/settles
See Settle a Charge.POST .../v2/post-sale/charges/{chargeid}/refunds
See Refund a Charge.
- Set up Merchants Notifications to listen to consumer actions via webhooks.
See Merchants Notifications.
Reconciliation Process
- Call the
GET ....../v2/post-sale/fundings/report
to return themerchantTransactionId
and themerchantOrderId
to confirm that funds were transferred.
Note: This call potentially returns a very large payload. You can use theoffset
andlimit
parameters to paginate results. To ensure that all results from the paginated payload are received, keep calling the API with the nextoffset
until no new results are received.
See GET funding report.
Note: Custom integrations are also possible.
Updated 5 days ago