Interac

REST API

Please note that you can use the REST API documentation also for Wirecard Payment Page v1 LEGACY integration.

Interac is a type of Online Bank Transfer.

Countries and Currencies

Countries

CA

Currencies

CAD
Communication Formats

This table illustrates how Interac notifications are encoded and which formats and methods can be used for requests and responses.

Requests/Responses

Format

XML, NVP

Methods

POST, GET

IPN Encodement

Please follow the instructions given at Instant Payment Notification to set up IPN.
Transaction Types

For transaction type details which are not given here look at Transaction Types.

Transaction Type Description

check-signature

Validates digital signature for a Payment Page transaction.

debit

Moves funds from the consumer’s account to the merchant account. REST API debit samples, Wirecard Payment Page v1 debit samples

debit

Moves funds from the Consumer Account to the Merchant Account. Rest Api debit samples, Payment Page debit samples

refund-debit

Moves funds from the Merchant to the Consumer. It follows refund-request as a final step of the refund flow.
Test Credentials

URLs (Endpoints)

For transaction type debit

https://api-test.wirecard.com/engine/rest/paymentmethods/

For transaction type refund-debit

https://api-test.wirecard.com/engine/rest/payments/

Merchant Account ID (MAID)

92869f77-8a2c-49f6-8726-ef1b4d97ec9e

Username

16390-testing

Password

3!3013=D3fD8X7

Secret Key

adfce2f5-5659-4e91-bc19-9e6658b22a04
Workflow
InteracWorkflow

  1. The consumer adds items to the shopping cart.

  2. The merchant displays all available payment methods.

  3. The consumer selects Interac.

  4. The merchant initiates a debit transaction to WPG.

  5. WPG sends a redirection URL to the merchant.

  6. The merchant redirects the consumer to the Interac Financial Institution Selection Page.

  7. The consumer selects the financial institution and is redirected to the bank website.

  8. The consumer enters his account data and confirms the payment.

  9. Interac processes the transaction.

  10. WPG receives the transaction status.

  11. WPG sends the transaction status to the merchant and redirects the consumer back to the merchant’s website.

  12. The merchant receives the transaction status and displays the outcome to the consumer.

Fields

The fields used for Interac requests, responses and notifications are the same as the REST API Fields. Please refer to: REST API Fields.

Samples
REST API

For XML we do not list any notification samples. Go to Notification Examples, if you want to see corresponding notification samples.

debit
XML debit Request (Successful)
<?xml version="1.0" encoding="UTF-8"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>92869f77-8a2c-49f6-8726-ef1b4d97ec9e</merchant-account-id>
    <request-id>{{$guid}}</request-id>
    <transaction-type>debit</transaction-type>
    <requested-amount currency="CAD">1.01</requested-amount>
    <account-holder>
        <first-name>Jane</first-name>
        <last-name>Foster</last-name>
        <email>jane.foster@example.com</email>
    </account-holder>
    <payment-methods>
        <payment-method name="interac"/>
    </payment-methods>
    <custom-fields>
        <custom-field field-name="elastic-api.ee.test.result" field-value="A"/>
    </custom-fields>
    <ip-address>127.0.0.1</ip-address>
    <locale>en</locale>
</payment>
XML debit Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>92869f77-8a2c-49f6-8726-ef1b4d97ec9e</merchant-account-id>
    <transaction-id>8420d439-68f0-4836-a561-46cba3e00207</transaction-id>
    <request-id>e3fe1882-3d92-47b2-8eb2-b87967383430</request-id>
    <transaction-type>debit</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2019-07-19T12:13:35.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="CAD">1.01</requested-amount>
    <account-holder>
        <first-name>Jane</first-name>
        <last-name>Foster</last-name>
        <email>jane.foster@example.com</email>
    </account-holder>
    <ip-address>127.0.0.1</ip-address>
    <custom-fields>
        <custom-field field-name="elastic-api.ee.test.result" field-value="A"></custom-field>
    </custom-fields>
    <payment-methods>
        <payment-method url="https://stagingcheckout.psigate.com/HTMLPost/HTMLMessenger?ResponseFormat=HTML&amp;Email=jane.foster%40example.com&amp;NoThanksURL=https%3A%2F%2Fapi-test.wirecard.com%2Fengine%2Fnotification%2Fpsigate%2Fredirect%2F8420d439-68f0-4836-a561-46cba3e00207%2F&amp;TestResult=A&amp;OrderID=44307293835967428622&amp;StoreKey=merchantcardcapture200024&amp;SubTotal=1.01&amp;CustomerLanguage=EN_CA&amp;CustomerRefNo=e3fe1882-3d92-47b2-8eb2-b87967383430&amp;CardAction=0&amp;CustomerIP=127.0.0.1&amp;PaymentType=DB&amp;ThanksURL=https%3A%2F%2Fapi-test.wirecard.com%2Fengine%2Fnotification%2Fpsigate%2Fredirect%2F8420d439-68f0-4836-a561-46cba3e00207%2F" name="interac"/>
    </payment-methods>
    <locale>en</locale>
</payment>
XML debit Request (Failed)
<?xml version="1.0" encoding="UTF-8"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>92869f77-8a2c-49f6-8726-ef1b4d97ec9e</merchant-account-id>
    <request-id>{{$guid}}</request-id>
    <transaction-type>debit</transaction-type>
    <requested-amount currency="CAD">1.01</requested-amount>
    <account-holder>
        <first-name>Jane</first-name>
        <last-name>Foster</last-name>
        <email>jane.foster@example.com</email>
    </account-holder>
    <payment-methods>
        <payment-method name="interacT"/>
    </payment-methods>
    <ip-address>127.0.0.1</ip-address>
    <locale>en</locale>
</payment>
XML debit Response (Failed)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>92869f77-8a2c-49f6-8726-ef1b4d97ec9e</merchant-account-id>
    <request-id>2fe70db0-90e6-46d5-8560-4f99701ac95e</request-id>
    <transaction-type>debit</transaction-type>
    <transaction-state>failed</transaction-state>
    <statuses>
        <status code="400.1109" description="Invalid Payment Method  Please check your input and try again." severity="error"/>
    </statuses>
    <requested-amount currency="CAD">1.01</requested-amount>
    <account-holder>
        <first-name>Jane</first-name>
        <last-name>Foster</last-name>
        <email>jane.foster@example.com</email>
    </account-holder>
    <ip-address>127.0.0.1</ip-address>
    <payment-methods>
        <payment-method/>
    </payment-methods>
    <locale>en</locale>
</payment>
refund-debit
The refund-debit request cannot be tested and serves only as reference.
XML refund-debit Request
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
  <merchant-account-id>f24b91f5-ab66-4030-bcb6-acfa35d42068</merchant-account-id>
  <request-id>{{$not possible on test environment}}</request-id>
  <transaction-type>refund-debit</transaction-type>
  <requested-amount currency="CAD">1.01</requested-amount>
  <parent-transaction-id>f0af16f8-c454-4b7a-b582-0bbc38b9aba4</parent-transaction-id>
  <payment-methods>
    <payment-method name="interac"/>
  </payment-methods>
</payment>
Wirecard Payment Page v1
debit

To test succesful debit transactions, you must includefield_name_1=elastic-api.ee.test.result and field_value_1=A in the request.

This request opens the Wirecard Payment Page v1.

NVP debit Request (Successful)
requested_amount=1.01&requested_amount_currency=CAD&locale=en&order_number=123456&order_detail=1+widget&form_url=https%3A%2F%2Fdev.thesolution.com%2Fengine%2Fhpp%2F&secret_key=c50a8e09-0648-4d2c-b638-2c14fc7606bc&request_id=8adfa0d8-c4bc-2e1e-6644-7c078563c09f&request_time_stamp=20190318183534&merchant_account_id=11d7c6dc-4dd0-4304-aaeb-07fa87af98e9&payment_method=interac&transaction_type=debit&redirect_url=https%3A%2F%2Fdev.thesolution.com%2Fshop%2Fcomplete.jsp%3Fstate%3Dsuccess%26&ip_address=127.0.0.1&request_signature=0a80202e3719415e18060fc403a4587c26f913adf4b1077888c414a43853c1b0&psp_name=demo&attempt_three_d=false&success_redirect_url=https%3A%2F%2Fdev.thesolution.com%2Fshop%2Fcomplete.jsp%3Fstate%3Dsuccess%26&fail_redirect_url=https%3A%2F%2Fdev.thesolution.com%2Fshop%2Fcomplete.jsp%3Fstate%3Dfailed%26&cancel_redirect_url=https%3A%2F%2Fdev.thesolution.com%2Fshop%2Fcomplete.jsp%3Fstate%3Dcancel%26&processing_redirect_url=https%3A%2F%2Fdev.thesolution.com%2Fshop%2Fcomplete.jsp%3Fstate%3Dprocessing%26&first_name=John&last_name=Doe&email=john.doe%40example.com&phone=1+555+555+5555&street1=123+test&city=Toronto&state=ON&postal_code=M4P1E8&country=CA&field_name_1=elastic-api.ee.test.result&field_value_1=A

This response is sent back to merchant’s page.

NVP debit Response (Successful)
psp_name=demo&country=CA&custom_css_url=&merchant_account_resolver_category=&response_signature=6fa58158da8992c2be61f19a9d49d68830b2673532fe43e8933771536e2b753e&city=Toronto&group_transaction_id=&order_number=123456&provider_status_code_1=&response_signature_v2=SFMyNTYKdHJhbnNhY3Rpb25faWQ9MzYxYTNjY2UtMTQwMS00OGU3LTg4ZjgtNTI3NWQyMjA0ZTNlCmNvbXBsZXRpb25fdGltZXN0YW1wPTIwMTkwMzE4MTgzNjE5Cm1hc2tlZF9hY2NvdW50X251bWJlcj0KdG9rZW5faWQ9CmF1dGhvcml6YXRpb25fY29kZT0KbWVyY2hhbnRfYWNjb3VudF9pZD0xMWQ3YzZkYy00ZGQwLTQzMDQtYWFlYi0wN2ZhODdhZjk4ZTkKdHJhbnNhY3Rpb25fc3RhdGU9c3VjY2VzcwppcF9hZGRyZXNzPTEyNy4wLjAuMQp0cmFuc2FjdGlvbl90eXBlPWRlYml0CnJlcXVlc3RfaWQ9OGFkZmEwZDgtYzRiYy0yZTFlLTY2NDQtN2MwNzg1NjNjMDlmCg%3D%3D.drzTptrEV8FzLV1rzKiExL2SHaip9GfYLi2dGmspr84%3D&locale=en&requested_amount=1.010000&completion_time_stamp=20190318183619&provider_status_description_1=&authorization_code=&merchant_account_id=11d7c6dc-4dd0-4304-aaeb-07fa87af98e9&provider_transaction_reference_id=&street1=123+test&state=ON&first_name=John&email=john.doe%40example.com&payment_method=interac&transaction_id=361a3cce-1401-48e7-88f8-5275d2204e3e&provider_transaction_id_1=1084dc093387b0d9&status_severity_1=information&last_name=Doe&ip_address=127.0.0.1&transaction_type=debit&status_code_1=201.0000&field_name_1=elastic-api.ee.test.result&status_description_1=The+resource+was+successfully+created.&phone=1+555+555+5555&transaction_state=success&requested_amount_currency=CAD&postal_code=M4P1E8&request_id=8adfa0d8-c4bc-2e1e-6644-7c078563c09f&field_value_1=A
NVP debit Notification (Successful)
merchant_account_resolver_category=&response_signature=11b9a96e051a86fa5f62fa88165a2fcb4c05c1554c581034b3084517066fe2ac&group_transaction_id=&provider_status_code_1=&response_signature_v2=SFMyNTYKdHJhbnNhY3Rpb25faWQ9YmE2ODVlZTUtNzljYS00YTEzLWI0NDUtZmJhYjE4OTNmMzM2CmNvbXBsZXRpb25fdGltZXN0YW1wPTIwMTkwMzE4MTkwMDAxCm1hc2tlZF9hY2NvdW50X251bWJlcj0KdG9rZW5faWQ9CmF1dGhvcml6YXRpb25fY29kZT0KbWVyY2hhbnRfYWNjb3VudF9pZD1iMWNkOGY2MS1kMzFjLTRjOTQtOTcxYi1lM2NhMGU4NDA3ODQKdHJhbnNhY3Rpb25fc3RhdGU9c3VjY2VzcwppcF9hZGRyZXNzPTEyNy4wLjAuMQp0cmFuc2FjdGlvbl90eXBlPWRlYml0CnJlcXVlc3RfaWQ9NWE4ZDhiM2QtMmVkMC00YWIwLTgzYjEtMmE1MzA0YTJlODM5Cg%3D%3D.kmtN5ba7Nu5%2BeiMtrzwCPIVz9fvoj5D7J5pgl9Hljxw%3D&locale=&requested_amount=1.010000&completion_time_stamp=20190318190001&provider_status_description_1=&authorization_code=&merchant_account_id=b1cd8f61-d31c-4c94-971b-e3ca0e840784&provider_transaction_reference_id=&first_name=John&email=john.doe%40example.com&payment_method=interac&transaction_id=ba685ee5-79ca-4a13-b445-fbab1893f336&provider_transaction_id_1=1084dc09bf7b53e5&status_severity_1=information&last_name=Doe&ip_address=127.0.0.1&transaction_type=debit&status_code_1=201.0000&field_name_1=elastic-api.ee.test.result&status_description_1=acquirer%3AThe+resource+was+successfully+created.&transaction_state=success&requested_amount_currency=CAD&request_id=5a8d8b3d-2ed0-4ab0-83b1-2a5304a2e839&field_value_1=A

← iDEAL | Klarna →