How It Works

During checkout, the customer selects "MyBank" as their payment method.
They are then redirected to their online banking environment within the secure MyBank platform.
Using their existing online banking credentials, they authenticate the payment.
Funds are transferred directly from their account to the merchant in real-time.

Integrating on your website / application

Step 1: Create a payin

Tazapay uses a payin object to represent your intent to collect a payment from your customer. The payin object tracks state changes from Mybank transaction creation to payment completion.
Create a payin on your server with an amount, invoice_currency EUR and a transaction_description using the create payin API

A payin is created with the status requires_payment_method.

Sample cURL

curl --request POST \
     --url https://service-sandbox.tazapay.com/v3/payin \
     --header 'accept: application/json' \
     --header 'authorization: Basic xxxxxxxXXXXxxxxxxxxxxxxxxxxx' \
     --header 'content-type: application/json' \
     --data '
{
  "invoice_currency": "EUR",
  "amount": 10000,
  "transaction_description": "test"
}
'

Step 2: Confirm a payin

Confirm the payin created in step 1 using the confirm payin API. Upon confirmation of the payin, a redirect URL is generated to redirect the customer. The status of the payin moves to requires_action

Refer the below for the fields to be passed in payment_method_details

Sample cURL

curl --request POST \
     --url https://service-sandbox.tazapay.com/v3/payin/pay_cttqsgs2ukmk385scqt0/confirm \
     --header 'accept: application/json' \
     --header 'authorization: Basic xxxxxxxXXXXxxxxxxxxxxxxxxxxx' \
     --header 'content-type: application/json' \
     --data '
{
  "customer_details": {
    "name": "Andrea Lark",
    "email": "[email protected]",
    "country": "IT"
  },
  "payment_method_details": {
    "type": "mybank_eur"
  }
}
'

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 and set the confirm field to true

Field	type	Mandatory (Y/N)	Description
confirm	boolean	Y	To confirm the payin along with creation

Sample cURL

curl --request POST \
     --url https://service-sandbox.tazapay.com/v3/payin \
     --header 'accept: application/json' \
     --header 'authorization: Basic xxxxxxxXXXXxxxxxxxxxxxxxxxxx' \
     --header 'content-type: application/json' \
     --data '
{
  "customer_details": {
    "name": "Andrea Lark",
    "email": "[email protected]",
    "country": "IT"
  },
  "confirm": true,
  "invoice_currency": "EUR",
  "amount": 10000,
  "transaction_description": "test",
  "payment_method_details": {
    "type": "mybank_eur"
  }
}
'

Step 3: Redirect the customer to their bank payment URL

After confirming the payin, you will receive the following response

{
  "status": "success",
  "message": "",
  "data": {
    "amount": 10000,
    "amount_paid": 0,
    "billing_details": null,
    "cancel_url": "",
    "cancelled_at": null,
    "client_token": "KSy7FtQS0ljGdeg0_KN-aro6cyLAe3m3G1ATSP4YU7U=",
    "confirm": true,
    "created_at": "2025-01-06T10:47:47.332279410Z",
    "customer": "cus_cttr9kh70g0h95qquv00",
    "customer_details": {
      "country": "IT",
      "email": "[email protected]",
      "name": "Andrea Lark",
      "phone": null
    },
    "holding_currency": "EUR",
    "id": "pay_cttr9kk2ukmk385sde3g",
    "invoice_currency": "EUR",
    "items": [],
    "latest_payment_attempt": "pat_cttr9ks2ukmk385sde60",
    "latest_payment_attempt_data": {
      "expires_at": "2025-01-06T10:52:47Z",
	      "redirect_url": "https://checkout-sandbox.tazapay.com/single-payment.html?tzid=KSy7FtQS0ljGdeg0_KN-aro6cyLAe3m3G1ATSP4YU7U=&spid=aHR0cHM6Ly9jaGVja291dC1zYW5kYm94LnRhemFwYXkuY29tL3NpbXVsYXRlL0tTeTdGdFFTMGxqR2RlZzBfS04tYXJvNmN5TEFlM20zRzFBVFNQNFlVN1U9L3BheV9jdHRyOWtrMnVrbWszODVzZGUzZy9teWJhbmtfZXVy"
    },
    "metadata": null,
    "object": "payin",
    "paid_in_excess": false,
    "partially_paid": false,
    "payment_attempts": [],
    "payment_method_details": {
      "type": "mybank_eur"
    },
    "reference_id": "",
    "shipping_details": null,
    "statement_descriptor": "",
    "status": "requires_action",
    "status_description": "",
    "success_url": "",
    "transaction_data": [],
    "transaction_description": "test",
    "transaction_documents": [],
    "webhook_url": ""
  }
}

You must redirect the customer to latest_payment_attempt_data.redirect_url in order to enable them to complete the payment.

Step 4: Handle post-payment events

Tazapay sends a payin.succeeded event as soon as the funds are received from the customer. Tazapay sends these events to the endpoint configured from your dashboard. You can 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 30 minutes and the URL expires, Tazapay sends a payment_attempt.failed event. To generate a new URL, confirm the payin again using Step 2.

Event	Description	Next Steps
payin.succeeded	The customer paid before the expiration of the URL	Fulfill the goods or services that the customer purchased
payment_attempt.failed	The customer did not pay, and the URL expired	Allow the customer to generate a new URL or complete the payment via another payment method

Test the Integration

Simulating success

Click on Simulate Success CTA on the redirect_url. You will receive a payin.succeeded event.

Simulating Failure / Expiry

Click on Simulate Failure CTA on the redirect_url. You will receive a payment_attempt.failed event.

Integrating Refunds

You can refund a transaction in two ways - using the dashboard or using Refund API.

Mybank also 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-dashboard

Refund using API

Sample cURL

curl --request POST \
     --url https://service-sandbox.tazapay.com/v3/refund \
     --header 'accept: application/json' \
     --header 'authorization: Basic xxxxxxxXXXXxxxxxxxxxxxxxxxxx' \
     --header 'content-type: application/json' \
     --data '
{
  "payin": "pay_cmiiaamaq0pbt3fkadm0",
  "amount": 5000,
  "currency": "EUR",
  "reason": "Customer Return",
  }
'

For full refund, specifying the amount and currency is not required to initiate a refund.