Interac E-Transfer Pay-in

Общая информация

Для оплаты через Payment Page с использованием метода Interac E-Transfer Pay-in со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод Interac E-Transfer Pay-in можно сделать предварительно выбранным на Payment Page (подробнее — в разделе Предварительный выбор платёжного метода). Полная схема проведения оплаты представлена далее.

Информация о формате запросов и параметрах вызова Payment Page при работе с Interac E-Transfer Pay-in, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.

Формат запросов

При формировании запросов на открытие платёжной формы с применением метода Interac E-Transfer Pay-in необходимо учитывать следующее:

1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
   • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
   • payment_id — идентификатор платежа, уникальный в рамках проекта;
   • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
   • payment_amount — сумма платежа в минорных единицах.
2. Валютой платежа может быть только CAD.
3. Обязательно указывается параметр customer_id — идентификатор пользователя в рамках проекта.
4. Для предварительного выбора метода Interac E-Transfer Pay-in необходимо указывать код платёжного метода в параметре force_payment_method — interac-etransfer.
5. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
6. После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.

Таким образом, корректный запрос на открытие платёжной формы с применением метода Interac E-Transfer Pay-in должен содержать идентификаторы проекта, платежа и пользователя, а также валюту и сумму платежа и подпись:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'CAD', 
      project_id: 35, 
      customer_id: 'u_customer',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52hgxHASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Формат оповещений

Для оповещений о результатах оплат с применением метода Interac E-Transfer Pay-in используется стандартный формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 3955 от пользователя u_customer была успешно проведена оплата в размере 100,00 CAD.

{  
{
        "project_id": 3955,
        "customer": {
            "id": "u_customer"
        },
        "payment": {
            "id": "EP9b34-a402",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-23T13:39:57+0000",
            "method": "BankTransferViaInterac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "operation": {
            "id": 2000000035,
            "type": "sale",
            "status": "success",
            "date": "2019-04-23T13:39:57+0000",
            "created_date": "2019-04-23T13:39:31+0000",
            "request_id": "60c673c94434ae",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39552,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "OwrbC2qrL/4aHWaM97A4vZO5tt3K1G7kZy2uUaCaqMmUc1LLQrEDZVqE2nFuoQoenRSlc7jg=="
    }
}

В следующем примере оплата была отклонена.

{  
{
        "project_id": 3955,
        "customer": {
            "id": "u_customer"
        },
        "payment": {
            "id": "EP9b34-a402",
            "type": "purchase",
            "status": "decline",
            "date": "2019-04-23T13:39:57+0000",
            "method": "BankTransferViaInterac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "operation": {
            "id": 2000000035,
            "type": "sale",
            "status": "decline",
            "date": "2019-04-23T13:39:57+0000",
            "created_date": "2019-04-23T13:39:31+0000",
            "request_id": "60c673c94434ae",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39552,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "100",
            "message": "General decline"
            },
        "signature": "OwrbC2qrL/4aHWaM97A4vZO5tt3K1G7kZy2uUaCaqMmUc1LLQrEDZVqE2nFuoQoenRSlc7jg=="
    }
} 

Дополнительные материалы

Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация о выполнении операций

Общая информация

Для оплаты через Gate с использованием метода Interac E-Transfer Pay-in со стороны веб-сервиса необходимо:

1. Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
2. Осуществить перенаправление пользователя в сервис Interac E-Transfer Pay-in.
3. Принять оповещение о результате оплаты.

Полная схема проведения оплаты представлена далее.

Необходимо использовать внутренний гид по стилю Interac E-Transfer Pay-in при разработке отображаемой пользователю платежной страницы. На странице оплаты необходимо обеспечить отображение логотипа или товарного знака (например, текст “INTERAC eTransfer”). При первом использовании слова INTERAC необходимо использовать обозначение ® в надстрочном тексте рядом со словом «INTERAC». Также на этой странице необходимо отобразить строку “® Trade-mark of Interac Corp. Used under license”. Логотипы и гид по стилю можно запросить у вашего курирующего менеджера ECommPay.

Информация о формате запросов и параметрах инициализации оплат методом Interac E-Transfer Pay-in через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.

Формат запросов

При работе с запросами на оплаты с применением метода Interac E-Transfer Pay-in необходимо учитывать следующее:

1. Должен использоваться запрос /v2/payment/bank-transfer/interac/sale, отправляемый методом POST. Этот запрос относится к группе запросов проведения платежей через банковский перевод /v2/payment/bank-transfer/{payment_method}/sale.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные сведения:
     • project_id — идентификатор проекта,
     • payment_id — идентификатор платежа,
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • ip_address — используемый IP-адрес,
     • id — идентификатор в проекте,
     • first_name — имя,
     • last_name — фамилия,
     • email — адрес электронной почты,
     • phone — номер телефона;
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма,
     • currency — валюта платежа в формате ISO-4217 alpha-3.
3. Валютой платежа может быть только CAD.
4. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на оплату с применением метода Interac E-Transfer Pay-in должен содержать идентификаторы проекта и платежа, подпись, IP-адрес и логин пользователя, валюту и сумму платежа:

{
    "general": {
        "project_id": 35,
        "payment_id": "Payment 12",
        "signature": "2tlMuYxLW9Yu6RETr8pdCfmi0UPE8euD+o4EVPjLyfbOQ+9ajAteg5lPk96Q=="
  },
    "customer": {
        "id": "u_customer",
        "ip_address": "1.1.1.1",
        "first_name": "John",
        "last_name": "Johnson",      
        "email": "johnson@mail.com",  
        "phone": "16132354341"
  },
    "payment": {
        "amount": 10000,
        "currency": "CAD"
  }
}

Форматы данных для перенаправления пользователей

Для перенаправления пользователя от веб-сервиса на сайт банка необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре return_url.url и данные для отправки в теле запроса return_url.body, и использовать эти параметры при открытии HTML-страницы банка методом, указанным в return_url.method.

Далее приведён фрагмент оповещения, содержащего токен на оплату.

"body": {
                        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
                        "transaction": 49269000010181
                    },
                    "method": "GET",
                    "url": "https://interac.express-connect.com/webflow?"
                },

Формат оповещений

Для оповещений о результатах оплат с применением метода Interac E-Transfer Pay-in используется стандартный формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 3955 от пользователя u_customer была успешно проведена оплата в размере 100,00 CAD.

{  
{
        "project_id": 3955,
        "customer": {
            "id": "u_customer"
        },
        "payment": {
            "id": "EP9b34-a402",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-23T13:39:57+0000",
            "method": "BankTransferViaInterac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "operation": {
            "id": 2000000035,
            "type": "sale",
            "status": "success",
            "date": "2019-04-23T13:39:57+0000",
            "created_date": "2019-04-23T13:39:31+0000",
            "request_id": "60c673c94434ae",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39552,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "OwrbC2qrL/4aHWaM97A4vZO5tt3K1G7kZy2uUaCaqMmUc1LLQrEDZVqE2nFuoQoenRSlc7jg=="
    }
}

В следующем примере оплата была отклонена.

{  
{
        "project_id": 3955,
        "customer": {
            "id": "u_customer"
        },
        "payment": {
            "id": "EP9b34-a402",
            "type": "purchase",
            "status": "decline",
            "date": "2019-04-23T13:39:57+0000",
            "method": "BankTransferViaInterac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "operation": {
            "id": 2000000035,
            "type": "sale",
            "status": "decline",
            "date": "2019-04-23T13:39:57+0000",
            "created_date": "2019-04-23T13:39:31+0000",
            "request_id": "60c673c94434ae",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39552,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "100",
            "message": "General decline"
            },
        "signature": "OwrbC2qrL/4aHWaM97A4vZO5tt3K1G7kZy2uUaCaqMmUc1LLQrEDZVqE2nFuoQoenRSlc7jg=="
    }
} 

Дополнительные материалы

Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация об операциях

Общая информация

Interac E-Transfer Pay-in поддерживает проведение полных и частичных возвратов. Для проведения возврата через Gate с использованием метода Interac E-Transfer Pay-in со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате. Полная схема проведения возврата представлена далее.

Информация о формате запросов и параметрах инициирования возвратов методом Interac E-Transfer Pay-in через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API см. в разделе Работа с API.

Формат запросов

При работе с запросами на возврат с применением метода Interac E-Transfer Pay-in необходимо учитывать следующее:

1. Должен использоваться запрос /v2/payment/bank-transfer/interac/refund, отправляемый методом POST. Этот запрос относится к группе запросов для проведения платежей через банковский перевод /v2/payment/bank-transfer/{payment_method}/refund.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения о запросе:
     • project_id — идентификатор проекта;
     • payment_id — идентификатор платежа;
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • ip_address — используемый IP-адрес;
   • payment — объект, содержащий сведения о возврате :
     • description — комментарий или описание возврата,
     • amount — сумма возврата в минорных единицах валюты (обязательный при частичном возврате),
     • currency — валюта возврата в формате ISO-4217 alpha-3 (обязательный при частичном возврате).
3. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на возврат с применением метода Interac E-Transfer Pay-in должен содержать идентификаторы проекта и платежа, подпись и IP-адрес пользователя:

{
   "general": {    
    "project_id": 239,    
    "payment_id": "refund_01",   
    "signature": "of8k9xerKSK4XL1QFaDH3p9Mh0CIcjmOwSwKJ7Kdfgds/\dsf3fbsa3LTZYO56lCv+f1M0Sf/7eg=="
  },  
   "customer": {    
     "ip_address": "1.2.3.4" 
  },  
   "payment": {    
     "amount": 10000,    
     "currency": "CAD",
     "description": "refund"
 }
}

Формат оповещений

Для оповещений о результатах возврата с применением метода Interac E-Transfer Pay-in используется стандартный формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 3955 для пользователя был успешно проведён частичный возврат в размере 10,00 CAD на счёт пользователя.

{
{
        "project_id": 3955,
        "customer": {
            "id": "22007b"
        },
        "payment": {
            "id": "EP9b34-a402",
            "type": "purchase",
            "status": "partially refunded",
            "date": "2019-04-23T13:45:03+0000",
            "method": "BankTransferViaInterac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "operation": {
            "id": 2000000036,
            "type": "refund",
            "status": "success",
            "date": "2019-04-23T13:45:03+0000",
            "created_date": "2019-04-23T13:44:58+0000",
            "request_id": "17cffbc5fa8e",
            "sum_initial": {
                "amount": 1000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39552,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "3iDuT6GnO3arf9Nbd2oj41DWY0ciw7Rop8+pv3gdSnu79cvsn9AsA23iSYwJBu23o2rya3vw=="
    }
}

В следующем примере возврат был отклонён.

{
 {
        "project_id": 3955,
        "customer": {
            "id": "22007b"
        },
        "payment": {
            "id": "EPd4b6-9544",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-23T13:37:58+0000",
            "method": "BankTransferViaInterac",
            "sum": {
                "amount": 1000,
                "currency": "CAD"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "first_name": "Aleksandrs",
            "last_name": "Ralovecs",
            "phone": "3712946371",
            "email": "a@mail.com",
            "ip_address": "192.168.15.1"
        },
        "fee": {
            "amount": 0,
            "currency": "CAD"
        },
        "operation": {
            "id": 31,
            "type": "refund",
            "status": "decline",
            "date": "2019-04-23T13:37:58+0000",
            "created_date": "2019-04-23T13:37:53+0000",
            "request_id": "e209a32a666c2f322dd7ca7f2",
            "sum_initial": {
                "amount": 2000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 2000,
                "currency": "CAD"
            },
            "provider": {
                "id": 39551,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "100",
            "message": "General decline"
        },
        "signature": "jxpv2GmZmQi2W6cEy3m9IyjfAAXNByn6RxpHOY7Je0A8rN7FfEvsDs4HC9X0Im3vQ61xJ0Ag=="
    }
}

Дополнительные материалы

Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация об операциях

Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода Interac E-Transfer Pay-in доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.

Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.

Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:

• Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
• Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.

С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.