Integrating on your website / application
Step 1: Create a payin
Tazapay uses apayin object to represent your intent to collect a payment from your customer. The payin object tracks state changes from paynow qr creation to payment completion.Create a payin on your server with an amount, invoice_currency
SGD and a transaction_description using the create payin API
A payin is created with the status requires_payment_method.
Sample cURL
Step 2: Confirm a payin
Confirm the payin created in step 1 using the confirm payin API. Upon confirmation of the payin, a QR code is generated to display to your customer. The status of the payin moves torequires_action
The following sub-fields can be passed in payment_method_details
Sample cURL
Combining Steps 1 and 2 into a single step
Instead of making 2 API calls, you can also combine steps 1 and 2 into a single API call. To do so, pass the parameters in both the create payin and confirm payin endpoints to the create payin API. Also, pass the following field| Field | type | Mandatory (Y/N) | Description |
|---|---|---|---|
| confirm | boolean | Y | To confirm the payin along with creation |
Sample cURL
Step 3: Display the QR code on your screen
After confirming the payin, you will receive the following responseYou can use this library to convert the QR string to an image to display to your customers.
Step 4: Handle post-payment events
Tazapay sends apayin.succeeded event as soon as the funds are received from the customer. Use the webhook_url field in the payin API to receive these events and run actions (for example, sending an order confirmation email to your customers, logging the sale in a database, starting a shipping workflow, etc.)
If the payment is not made by the customer within the stipulated active time of the QR and the QR expires, Tazapay sends a payment_attempt.failed event. Display a CTA on your screen beside the QR to allow the customer to generate a new QR. To generate a new QR, confirm the payin again using Step 2.
| Event | Description | Next Steps |
|---|---|---|
| payin.succeeded | The customer paid before the expiration of the QR | Fulfill the goods or services that the customer purchased |
| payment_attempt.failed | The customer did not pay and the QR expired | Allow the customer to generate a new QR or complete the payment via another payment method |
Test the Integration
In test mode (sandbox),- All the paynow_sgd payment attempts will succeed 3 minutes after creation by default. You will receive a
payin.succeededevent. - All the paynow_sgd payment attempts created with value 100 SGD (invoice_currency - SGD, amount - 10000) will fail 3 minutes after creation by default. You will receive a
payment_attempt.failedevent and the status of the payin will move torequires_payment_method.
Integrating Refunds
You can refund a transaction in two ways - using the dashboard or using Refund API. Paynow supports partial refunds. Specify the amount (lesser than the invoice amount of the payin) for the refund before initiating.Refunding using dashboard.
Refer to this guide: https://support.tazapay.com/how-do-i-request-a-refund-from-my-dashboardRefund using API
Sample cURLNOTE: For full refund, specifying the amount and currency is not required to initiate a refund.
