Integration Overview
Understanding the Yaspa-Merchant Integration
Integration with Yaspa is relatively straightforward, for clarity the diagram below covers all stages of a customer completing product journey. The merchant only needs to be concerned about the integrations to the merchant systems - the boxes on the left.
The Customer Journey
- The customer starts on the merchant website. They click a button to make a pay-in or payout, with an amount. We will use an Instant Payment - a pay-in - in this example.
- The merchant server sends the yaspa the pay-in instruction, including details of the amount, currency, reference, customerid, and redirect URL for after the journey is completed. Yaspa will return a URL for the customer journey.
- The merchant server returns the Yaspa customer journey url to their Merchant website
- The merchant website displays the Yaspa customer journey url either within an iframe or redirect or new tab. This will take the customer to the Yaspa Hosted Journey pages to make the payment.
- Yaspa Hosted Journey pages will ask the customer to choose a bank, and then redirect the customer to their bank app to complete the payment. If the customer is on desktop, the journey will detect this and show the customer a QR code they can use to move to their mobile and to their bank app.
- After the payment is successful (or fails) the customer will be redirected back to the merchant website via the redirect URL specified in stage 2.
- Meanwhile the Customer and Merchant banks will both send Yaspa updates on the status of the payment
- Yaspa will send the Webhook notifications on the payment status to the merchant Server as configured webhook notifications in the Admin Dashboard. Once the payment is successful the merchant should release goods and services to the customer.
Whilst there are quite a few stages in the Payment process the main integration points for the merchant are Stage 2 where the product instruction is sent to the Yaspa Server and Stage 8 where the webhook notifications are returned and the merchant releases goods and services.
Updated 12 months ago
