Swish

Введение

Swish — метод, позволяющий проводить платежи в шведских кронах с использованием банковских счетов в Швеции. Для этого метода в платёжной платформе ecommpay поддерживаются оплаты и возвраты.

В этой статье представлена информация о работе с методом Swish: обзорный раздел с общими сведениями и последующие разделы с информацией о действиях, необходимых со стороны мерчанта для решения разных задач.

Характеристика

Схема работы

В проведении отдельного платежа с использованием метода Swish задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также технические средства сервиса Swish.

Основные операции

Для проведения платежей и выполнения операций с использованием метода Swish могут применяться различные интерфейсы платёжной платформы. Так, оплаты могут проводиться через Payment Page, Gate и Dashboard (с применением платёжных ссылок), возвраты — через Gate и Dashboard. При этом, независимо от используемых интерфейсов, для этого метода характерны следующие свойства и ограничения.

При работе с методом Swish, независимо от используемых интерфейсов, актуальны следующие свойства и ограничения.

Сценарии использования

Проведение оплат с использованием метода Swish осуществляется с перенаправлением пользователей к сервису Swish, выполнение возвратов — с заявкой со стороны пользователя и уведомлением со стороны веб-сервиса.

Сценарии выполнения операций через основные интерфейсы платёжной платформы соответствуют представленным на схемах. При использовании дополнительных возможностей (таких как платёжные ссылки) сценарии выполнения операций методом Swish соответствуют специфике этих возможностей.

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

Для проведения оплаты через Payment Page с использованием метода Swish со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате. Полная схема проведения оплаты выглядит следующим образом.

Информация о форматах запросов и оповещений, используемых для проведения оплат методом Swish через Payment Page, приведена далее в этом разделе; общая информация о работе с Payment Page API — в отдельной статье Организация взаимодействия.

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

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

1. Должен использоваться базовый минимум параметров, обязательный для любого платежа:
   • project_id — идентификатор проекта, полученный от ecommpay при интеграции;
   • payment_id — идентификатор платежа, уникальный в рамках проекта;
   • payment_currency — буквенный код валюты платежа в формате ISO-4217 alpha-3;
   • payment_amount — сумма платежа в дробных единицах валюты;
   • customer_id — идентификатор пользователя в рамках проекта.
2. Должен использоваться базовый минимум параметров: project_id, payment_id, payment_currency, payment_amount, customer_id.
3. Дополнительно рекомендуется указывать имя и фамилию пользователя в параметрах customer_first_name и customer_last_name. Для предотвращения ошибок при проведении платежей рекомендуется указывать не менее 3 и не более 100 символов в значениях параметров customer_first_name и customer_last_name. Если эти параметры отсутствуют в запросе, в платёжной форме могу отобразиться поля для ввода пользователем недостающих значений (подробнее — в разделе Дополнение информации о платежах).
4. Для предварительного выбора метода Swish необходимо указывать код этого метода в параметре force_payment_method — swish.
5. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page (подробнее).
6. После указания всех целевых параметров необходимо составлять подпись (подробнее).

Таким образом, корректный запрос на открытие платёжной формы с применением метода Swish должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор, сумму и код валюты), информацию о пользователе и подпись, а также может содержать различные дополнительные параметры.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "SEK",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Johnson",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "SEK",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Johnson",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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

Для оповещений о результатах оплат с применением метода Swish используется типовой формат, описание которого представлено в статье Оповещения(подробнее).

В следующем примере оповещение свидетельствует о том, что в рамках проекта 59051 была проведена оплата в размере 10,00 SEK.

{
        "customer": {
            "id": "1",
            "phone": "1234"
        },
        "project_id": 59051,
        "payment": {
            "id": "TEST_PAYMENT_447283",
            "type": "purchase",
            "status": "success",
            "date": "2024-12-06T15:40:51+0000",
            "method": "Swish",
            "sum": {
                "amount": 1000,
                "currency": "SEK"
            },
            "description": "TEST_PAYMENT_447283"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "SEK"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "SEK"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 16931,
                "payment_id": "2362129393",
                "auth_code": ""
            },
            "id": 28609010168569,
            "type": "sale",
            "status": "success",
            "date": "2024-12-06T15:40:51+0000",
            "created_date": "2024-12-06T15:39:12+0000",
            "request_id": "06c9fb4304e1c040dd5ce2-00028610"
        },
        "signature": "x56Jsr28i7YAtTmFqFncv2bDuFgNjl37E7QHUZw=="
    }

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

{
        "customer": {
            "id": "1",
            "phone": "46701740615"
        },
        "project_id": 59051,
        "payment": {
            "id": "TEST_PAYMENT_272837",
            "type": "purchase",
            "status": "decline",
            "date": "2024-12-06T16:35:38+0000",
            "method": "Swish",
            "sum": {
                "amount": 1000,
                "currency": "SEK"
            },
            "description": "TEST_PAYMENT_272837"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "SEK"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "SEK"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 16931,
                "payment_id": "",
                "auth_code": ""
            },
            "id": 5035392010140299,
            "type": "sale",
            "status": "decline",
            "date": "2024-12-06T16:35:38+0000",
            "created_date": "2024-12-06T16:35:36+0000",
            "request_id": "925469eba84ce74b144777bd-05035393"
        },
        "signature": "CK1xUbJszoYlgc8WHo5TIAtu3RtA7U/aw=="
    }

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

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

• Организация взаимодействия — о том, как организовать взаимодействие веб-сервиса с платёжной платформой через Payment Page.
• Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
• Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
• Разовая оплата в одну стадию — о том, как проводить разовые оплаты с незамедлительным списанием средств через Payment Page.
• Информация о выполнении операций — о служебных кодах, которые используются в платёжной платформе, чтобы фиксировать информацию о выполнении операций.

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

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

1. Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
2. Принять промежуточное оповещение от платёжной платформы и осуществить перенаправление пользователя к сервису Swish.
3. Принять итоговое оповещение от платёжной платформы.

Полная схема проведения оплаты выглядит следующим образом.

Информация о форматах запросов и оповещений, используемых для проведения оплат методом Swish через Gate, приведена далее в этом разделе; общая информация о работе с Gate API — в отдельной статье Организация взаимодействия.

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

При работе с запросами на оплаты с применением метода Swish необходимо учитывать следующее:

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

   Если какие-либо из этих параметров отсутствуют в запросе, список с названиями недостающих параметров может отправляться в оповещении на уточнение (подробнее — в статье Дополнение информации о платеже).

4. Дополнительно могут использоваться любые другие параметры из числа указанных в спецификации.

Таким образом, корректный запрос на оплату с применением метода Swish должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор, сумму и код валюты), информацию о пользователе, подпись, а также может содержать различные дополнительные параметры.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "SEK"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
    "first_name": "John",
    "last_name": "Johnson"
  }
}

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "SEK"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
    "first_name": "John",
    "last_name": "Johnson"
  }
}

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

Для перенаправления пользователей от веб-сервиса мерчанта к сервису Swish при проведении каждого платежа с использованием метода Swish необходимо принять промежуточное оповещение от платёжной платформы и использовать информацию из него, включённую в объект redirect_data. Формат таких оповещений является типовым (подробнее), при этом в состав объекта redirect_data включаются следующие объекты и параметры:

• body — объект с данными для отправки в теле запроса;
• method — параметр с указанием HTTP-метода отправки запроса (GET или POST);
• url — параметр со ссылкой для перенаправления.

  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

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

Для итоговых оповещений об оплатах с применением метода Swish используется типовой формат, описание которого представлено в статье Оповещения(подробнее).

В следующем примере оповещение свидетельствует о том, что в рамках проекта 59051 была проведена оплата в размере 10,00 SEK.

{
        "customer": {
            "id": "1",
            "phone": "1234"
        },
        "project_id": 59051,
        "payment": {
            "id": "TEST_PAYMENT_447283",
            "type": "purchase",
            "status": "success",
            "date": "2024-12-06T15:40:51+0000",
            "method": "Swish",
            "sum": {
                "amount": 1000,
                "currency": "SEK"
            },
            "description": "TEST_PAYMENT_447283"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "SEK"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "SEK"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 16931,
                "payment_id": "2362129393",
                "auth_code": ""
            },
            "id": 28609010168569,
            "type": "sale",
            "status": "success",
            "date": "2024-12-06T15:40:51+0000",
            "created_date": "2024-12-06T15:39:12+0000",
            "request_id": "06c9fb4304e1c040dd5ce2-00028610"
        },
        "signature": "x56Jsr28i7YAtTmFqFncv2bDuFgNjl37E7QHUZw=="
    }

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

{
        "customer": {
            "id": "1",
            "phone": "46701740615"
        },
        "project_id": 59051,
        "payment": {
            "id": "TEST_PAYMENT_272837",
            "type": "purchase",
            "status": "decline",
            "date": "2024-12-06T16:35:38+0000",
            "method": "Swish",
            "sum": {
                "amount": 1000,
                "currency": "SEK"
            },
            "description": "TEST_PAYMENT_272837"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "SEK"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "SEK"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 16931,
                "payment_id": "",
                "auth_code": ""
            },
            "id": 5035392010140299,
            "type": "sale",
            "status": "decline",
            "date": "2024-12-06T16:35:38+0000",
            "created_date": "2024-12-06T16:35:36+0000",
            "request_id": "925469eba84ce74b144777bd-05035393"
        },
        "signature": "CK1xUbJszoYlgc8WHo5TIAtu3RtA7U/aw=="
    }

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

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

• Организация взаимодействия — о том, как организовать взаимодействие с платёжной платформой через Gate.
• Работа с подписью — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
• Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
• Разовая оплата в одну стадию — о том, как проводить разовые оплаты с незамедлительным списанием средств через Gate.
• Информация об операциях — о служебных кодах, используемых в платёжной платформе для фиксации информации о выполнении операций.

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

Для выполнения возврата через Gate с использованием метода Swish со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате. Полная схема выполнения возврата выглядит следующим образом.

Информация о форматах запросов и оповещений, используемых для выполнения возвратов методом Swish через Gate, приведена далее в этом разделе; общая информация о работе с Gate API — в отдельной статье Организация взаимодействия.

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

При работе с запросами на возвраты с применением метода Swish необходимо учитывать следующее:

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

Таким образом, корректный запрос на возврат с применением метода Swish должен содержать идентификаторы проекта и платежа, описание возврата, IP-адрес пользователя, подпись, а также, при необходимости, код валюты и сумму возврата.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "SEK"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "SEK"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

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

Для оповещений о результатах возвратов с применением метода Swish используется типовой формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 433772 для пользователя был выполнен частичный возврат в размере 5,00 SEK.

{
        "project_id": 433772,
        "payment": {
            "id": "TEST_PAYMENT_122468",
            "type": "purchase",
            "status": "partially refunded",
            "date": "2024-12-18T14:36:34+0000",
            "method": "swish",
            "sum": {
                "amount": 500,
                "currency": "SEK"
            },
            "description": "TEST_PAYMENT_122468"
        },
        "customer": {
            "id": "1",
            "phone": "*************"
        },
        "operation": {
            "id": 3997000012221,
            "type": "refund",
            "status": "success",
            "date": "2024-12-18T14:36:34+0000",
            "created_date": "2024-12-18T14:36:30+0000",
            "request_id": "de99efb8e28702b165b5f9f117-00003998",
            "sum_initial": {
                "amount": 500,
                "currency": "SEK"
            },
            "sum_converted": {
                "amount": 500,
                "currency": "SEK"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 21414,
                "payment_id": "1418092071",
                "auth_code": ""
            }
        },
        "signature": "rq3TC04YQt1WFgSociHhJyfvjIQsj7n67UQ=="
    }

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

 {
    "project_id": 433772,
    "payment": {
        "id": "TEST_PAYMENT_122468",
        "type": "purchase",
        "status": "partially refunded",
        "date": "2024-12-18T14:36:34+0000",
        "method": "Swish",
        "sum": {
            "amount": 500,
            "currency": "SEK"
        },
        "description": "TEST_PAYMENT_122468"
    },
    "customer": {
        "id": "1",
        "phone": "*************"
    },
    "operation": {
        "id": 3997000012956,
        "type": "refund",
        "status": "decline",
        "date": "2024-12-22T14:22:44+0000",
        "created_date": "2024-12-22T14:22:44+0000",
        "request_id": "b3de84c717d1ba574598a637f856a-00002267",
        "sum_initial": {
            "amount": 5000,
            "currency": "SEK"
        },
        "sum_converted": {
            "amount": 5000,
            "currency": "SEK"
        },
        "code": "3283",
        "message": "Refund amount more than init amount",
        "provider": {
            "id": 21414,
            "payment_id": "1418092071",
            "auth_code": ""
        }
    },
    "signature": "PWoXcLWZbWyySxLSpFq3TC04YQt1WFgSocteIUw=="
}

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

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

• Организация взаимодействия — о том, как взаимодействовать с платёжной платформой через Gate.
• Работа с подписью — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
• Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
• Возвраты средств после оплат — о том, как выполнять возвраты через Gate.
• Информация об операциях — о служебных кодах, используемых в платёжной платформе для фиксации информации о выполнении операций.