5.2. PAN Eligibility

Введение

Сервисы проверки PAN позволяют Присоединяющейся стороне определить, подходит ли карта для Money Transfer (как отправляющая или получающая), и получить расширенную информацию об эмитенте и продукте карты до отправки финансового запроса.

PAN Eligibility Direct Flow

skinparam roundcorner 20
skinparam sequenceArrowThickness 1
skinparam maxmessagesize 1200
skinparam sequenceParticipant underline
actor Payer
participant "Connecting Party" as A
participant SBC as B
autonumber
Payer -> A: Checkout
activate A
A -> B: /api/v2/pan-eligibility/send/
activate B
A -> B: /api/v2/pan-eligibility/receive/
A -> B: /api/v2/pan-eligibility/both/
B --> A: Order ID
B -> B: Process\npan-eligibility
group Get Final Status
== Receive Connecting Party Callback ==
A <- B: Callback with Final Status
A --> B: HTTP 200
deactivate B
== Order Status Request ==
A -> B: Get Status by Order ID
activate B
B --> A: Final Status
deactivate B
end
A --> Payer: Show result
deactivate Payer
deactivate A

(2,3,4) О реализации запроса прямого процесса проверки PAN см. /api/v2/pan-eligibility/. Информацию о проверке PAN можно запросить для карты Плательщика (Отправителя), карты Получателя или обеих карт сразу.
(5) Для реализации обратного вызова с обработкой финального статуса см. Обратный вызов Присоединяющейся Стороны.
(7) Для реализации запроса статуса заказа см. /api/v2/status/. Статус следует запрашивать несколько раз с интервалом 3-5 секунд, пока в ответе не будет получен финальный статус.

PAN Eligibility Form Flow

  skinparam roundcorner 20
  skinparam sequenceArrowThickness 2
  skinparam ParticipantPadding 30
  actor Payer as Customer
  participant "Connecting Party\nwebsite" as Merchant
  participant "Payment Gateway" as g
  autonumber
  Customer -> Merchant: Checkout
  activate Merchant
  == Purchase payment request ==
  Merchant -> g: api/v2/pan-eligibility/send-form
  activate g
  Merchant -> g: api/v2/pan-eligibility/receive-form
  Merchant -> g: api/v2/pan-eligibility/both-form
  g --> Merchant: Redirect-url, orderId
  deactivate g
  Merchant -> Customer: Provide redirect-url \nto payer’s browser
  deactivate Merchant
  activate Customer
  Customer -> g: GET redirect-url
  deactivate Customer
  activate g
  g --> Customer: Payment Form
  deactivate g
  activate Customer
  Customer -> g: Submit form
  deactivate Customer
  activate g
  g --> g: Process PAN Eligibility
  == Final redirect of customer ==
  g -> Customer: Connecting Party website redirect_url
  activate Customer
  Customer -> Merchant: POST redirect_url\nstatus, orderid
  deactivate Customer
  activate Merchant
  group Get Final Status
  == Receive Connecting Party Callback ==
  Merchant <- g: Сallback with final status
  g <-- Merchant: HTTP 200
  deactivate g
  == Order Status Request ==
  Merchant -> g: api/v2/status
  activate g
  g --> Merchant: Response \nstatus, order-stage
  deactivate g
  end
  Merchant --> Customer: Show result
  deactivate Merchant

(2,3,4) О реализации запроса процесса проверки PAN через форму см. /api/v2/pan-eligibility-form/. Информацию о проверке PAN можно запросить для карты Плательщика (Отправителя), карты Получателя или обеих карт сразу.
(5) Для реализации обратного вызова с обработкой финального статуса см. Обратный вызов Присоединяющейся Стороны.
(7) Для реализации запроса статуса заказа см. /api/v2/status/. Статус следует запрашивать несколько раз с интервалом 3-5 секунд, пока в ответе не будет получен финальный статус.

PAN Eligibility Callback

Параметры обратного вызова

Дополнительные параметры отправляются в callback-уведомлениях для транзакций PAN Eligibility. Подробнее см. Параметры callback Присоединяющейся стороны.

Параметр

Описание

status

Подробности см. в Список статусов.

serial-number

Серийный номер запроса.

client_orderid

Идентификационный номер транзакции, присовенный Присоединяющейся Стороной.

paynet-order-id

Идентификатор заказа, заданный SBC.

processor-tx-id

Идентификатор транзакции, присвоенный процессором.

type

Тип транзакции, например sale, reversal, chargeback.

sending-card-type

Тип отправляющей карты (VISA, MASTERCARD).

sending-cardholder

Держатель отправляющей карты.

sending-bin

Идентификационный номер банка отправляющей карты.

sending-last-four-digits

Последние 4 цифры отправляющей карты.

sending-eligible

Подходит ли отправляющая карта для отправки средств. Возможные значения: true/false/unknown.

sending-ica

Описание: The sending card ICA.

sending-bank-name

Название банка отправляющей карты.

sending-currency-code

Код валюты отправляющей карты.

sending-country-code

Код страны отправляющей карты.

sending-acceptance-brand-code

Код бренда принятия отправляющей карты.

sending-acceptance-brand-name

Название бренда принятия отправляющей карты.

sending-product-brand-code

Код бренда продукта отправляющей карты.

sending-product-brand-name

Название бренда продукта отправляющей карты.

receiving-card-type

Тип получающей карты (VISA, MASTERCARD).

receiving-bin

Идентификационный номер банка получающей карты.

receiving-last-four-digits

Последние 4 цифры получающей карты.

receiving-eligible

Подходит ли получающая карта для отправки средств. Возможные значения: true/false/unknown.

receiving-ica

ICA получающей карты.

receiving-bank-name

Название банка получающей карты.

receiving-currency-code

Код валюты получающей карты.

receiving-country-code

Код страны получающей карты.

receiving-acceptance-brand-code

Код бренда принятия получающей карты.

receiving-acceptance-brand-name

Название бренда принятия получающей карты.

receiving-product-brand-code

Код бренда продукта получающей карты.

receiving-product-brand-name

Название бренда продукта получающей карты.

error-code

Код ошибки.

error-message

Error Message.

control

Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров:
1. Параметр обратного вызова: status.
2. Параметр обратного вызова: orderid.
3. Параметр обратного вызова: merchant_order.
4. merchant_control (Контрольный ключ, присвоенный аккаунту Торговца в Платёжном Шлюзе SBC).

Callback Macros

Простой URL callback содержит все параметры, перечисленные в Параметры обратного вызова. Настраиваемый URL позволяет Присоединяющейся стороне определять собственные имена параметров, тогда как фактические значения параметров задаются с помощью макросов в формате ${parameter_name}. Доступные макросы перечислены в Callback Macros.

Макрос имени поля

Field Value Macro

Описание

${status}

n/a

Статус транзакции: одобрена, отклонена, обрабатывается.

${serial-number}

n/a

Уникальный номер, присваиваемый сервером SBC конкретному запросу от Присоединяющейся стороны.

${client-order-id}

n/a

Уникальный идентификатор заказа, присвоенный Присоединяющейся Стороной.

${paynet-order-id}

n/a

Идентификатор заказа, созданный SBC.

${processor-tx-id}

n/a

Идентификатор транзакции, сгенерированный Процессором.

${type}

n/a

Тип транзакции, например sale, return, chargeback и т.д.

${sending-card-type}

n/a

Тип отправляющей карты (VISA, MASTERCARD).

${sending-cardholder}

n/a

Держатель отправляющей карты.

${sending-bin}

n/a

Идентификационный номер банка отправляющей карты.

${sending-last-four-digits}

n/a

Последние 4 цифры отправляющей карты.

${sending-eligible}

n/a

Подходит ли отправляющая карта для отправки средств. Возможные значения: true/false/unknown.

${sending-ica}

n/a

Описание: The sending card ICA.

${sending-bank-name}

n/a

Название банка отправляющей карты.

${sending-currency-code}

n/a

Код валюты отправляющей карты.

${sending-country-code}

n/a

Код страны отправляющей карты.

${sending-acceptance-brand-code}

n/a

Код бренда принятия отправляющей карты.

${sending-acceptance-brand-name}

n/a

Название бренда принятия отправляющей карты.

${sending-product-brand-code}

n/a

Код бренда продукта отправляющей карты.

${sending-product-brand-name}

n/a

Название бренда продукта отправляющей карты.

${receiving-card-type}

n/a

Тип получающей карты (VISA, MASTERCARD).

${receiving-bin}

n/a

Идентификационный номер банка получающей карты.

${receiving-last-four-digits}

n/a

Последние 4 цифры получающей карты.

${receiving-eligible}

n/a

Подходит ли получающая карта для отправки средств. Возможные значения: true/false/unknown.

${receiving-ica}

n/a

ICA получающей карты.

${receiving-bank-name}

n/a

Название банка получающей карты.

${receiving-currency-code}

n/a

Код валюты получающей карты.

${receiving-country-code}

n/a

Код страны получающей карты.

${receiving-acceptance-brand-code}

n/a

Код бренда принятия получающей карты.

${receiving-acceptance-brand-name}

n/a

Название бренда принятия получающей карты.

${receiving-product-brand-code}

n/a

Код бренда продукта получающей карты.

${receiving-product-brand-name}

n/a

Название бренда продукта получающей карты.

${error-code}

n/a

Код ошибки.

${error-message}

n/a

Error Message.

${control}

n/a

Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров:
1. Параметр обратного вызова: status.
2. Параметр обратного вызова: orderid.
3. Параметр обратного вызова: merchant_order.
4. merchant_control (Контрольный ключ, присвоенный аккаунту Торговца в Платёжном Шлюзе SBC).