4.2. PAN Eligibility

Introduction

PAN Eligibility services allow Connecting Party to detect whether card is eligible for Money Transfer (either as sending or as receiving card) along with providing extended information about card issuer and card product before making a financial transaction request.

PAN Eligibility Direct Flow

skinparam roundcorner 20
skinparam sequenceArrowThickness 1
skinparam maxmessagesize 1200
skinparam sequenceParticipant underline
actor Payer
participant "Connecting Party" as A
participant Billblend 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) To implement PAN eligibility direct flow request see /api/v2/pan-eligibility/. PAN eligibility information can be requested for Payer card (also referred as Sender), Recipient card (also referred as Receiver) or both cards at once.

(5) To implement callback with final status handling see Connecting Party Callback.

(7) To implement order status request see /api/v2/status/. Status should be requested multiple times with 3-5 seconds interval until final status will be received in response.

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) To implement PAN eligibility form flow request see /api/v2/pan-eligibility-form/. PAN eligibility information can be requested for Payer card (also referred as Sender), Recipient card (also referred as Receiver) or both cards at once.

(5) To implement callback with final status handling see Connecting Party Callback.

(7) To implement order status request see /api/v2/status/. Status should be requested multiple times with 3-5 seconds interval until final status will be received in response.

PAN Eligibility Callback

Callback Parameters

Additional parameters are sent in callbacks for PAN Eligibility transactions. For more information see Connecting Party Callback Parameters.

Callback ParameterDescription
statusSee Status List for details.
serial-numberSerial number of the request.
client_orderidConnecting Party order identifier.
paynet-order-idOrder id set by Billblend.
processor-tx-idTransaction id set by processor.
typeTransaction type, sale reversal chargeback
sending-card-typeThe sending card type (VISAMASTERCARD).
sending-cardholderCardholder of the sending card.
sending-binThe sending card Bank identification number.
sending-last-four-digitsThe sending card last 4 digits.
sending-eligibleWhether the sending card is eligible for sending funds. Possible values: true/false/unknown.
sending-icaThe sending card ICA.
sending-bank-nameThe sending card Bank name.
sending-currency-codeThe sending card currency code.
sending-country-codeThe sending card country code.
sending-acceptance-brand-codeThe sending card Acceptance brand code.
sending-acceptance-brand-nameThe sending card Acceptance brand name.
sending-product-brand-codeThe sending card Product brand code.
sending-product-brand-nameThe sending card Product brand name.
receiving-card-typeThe receiving card type (VISAMASTERCARD).
receiving-binThe receiving card Bank identification number.
receiving-last-four-digitsThe receiving card last 4 digits.
receiving-eligibleWhether the receiving card is eligible for sending funds. Possible values: true/false/unknown.
receiving-icaThe receiving card ICA.
receiving-bank-nameThe receiving card Bank name.
receiving-currency-codeThe receiving card currency code.
receiving-country-codeThe receiving card country code.
receiving-acceptance-brand-codeThe receiving card Acceptance brand code.
receiving-acceptance-brand-nameThe receiving card Acceptance brand name.
receiving-product-brand-codeThe receiving card Product brand code.
receiving-product-brand-nameThe receiving card Product brand name.
error-codeError Code.
error-messageError Message.
controlChecksum generated by SHA-1. Control string is represented as concatenation of the following parameters:1. Callback parameter: status.2. Callback parameter: orderid.3. Callback parameter: merchant_order.4. merchant_control (Control key assigned to Merchant account in the Billblend Payment Gateway).

Callback Macros

Simple callback URL contains all parameters listed in Callback Parameters. Customizable URL allows Connecting Party to define own parameter names, whereas the actual parameters values are defined by use of macros with the following format ${parameter_name}. Available macros are listed in Callback Macros.

Field Name MacroField Value MacroDescription
${status}n/aTransaction status, approved declined processing.
${serial-number}n/aUnique number assigned by Billblend server to particular request from the Connecting Party.
${client-order-id}n/aUnique order identifier assigned by Connecting Party.
${paynet-order-id}n/aBillblend-generated order id.
${processor-tx-id}n/aProcessor-generated transaction id.
${type}n/aTransaction type, ex. salereturnchargeback, etc.
${sending-card-type}n/aThe sending card type (VISAMASTERCARD).
${sending-cardholder}n/aCardholder of the sending card.
${sending-bin}n/aThe sending card Bank identification number.
${sending-last-four-digits}n/aThe sending card last 4 digits.
${sending-eligible}n/aWhether the sending card is eligible for sending funds. Possible values: true/false/unknown.
${sending-ica}n/aThe sending card ICA.
${sending-bank-name}n/aThe sending card Bank name.
${sending-currency-code}n/aThe sending card currency code.
${sending-country-code}n/aThe sending card country code.
${sending-acceptance-brand-code}n/aThe sending card Acceptance brand code.
${sending-acceptance-brand-name}n/aThe sending card Acceptance brand name.
${sending-product-brand-code}n/aThe sending card Product brand code.
${sending-product-brand-name}n/aThe sending card Product brand name.
${receiving-card-type}n/aThe receiving card type (VISAMASTERCARD).
${receiving-bin}n/aThe receiving card Bank identification number.
${receiving-last-four-digits}n/aThe receiving card last 4 digits.
${receiving-eligible}n/aWhether the receiving card is eligible for sending funds. Possible values: true/false/unknown.
${receiving-ica}n/aThe receiving card ICA.
${receiving-bank-name}n/aThe receiving card Bank name.
${receiving-currency-code}n/aThe receiving card currency code.
${receiving-country-code}n/aThe receiving card country code.
${receiving-acceptance-brand-code}n/aThe receiving card Acceptance brand code.
${receiving-acceptance-brand-name}n/aThe receiving card Acceptance brand name.
${receiving-product-brand-code}n/aThe receiving card Product brand code.
${receiving-product-brand-name}n/aThe receiving card Product brand name.
${error-code}n/aError Code.
${error-message}n/aError Message.
${control}n/aChecksum generated by SHA-1. Control string is represented as concatenation of the following parameters:1. Callback parameter: status.2. Callback parameter: orderid.3. Callback parameter: merchant_order.4. merchant_control (Control key assigned to Merchant account in the Billblend Payment Gateway).

Contact us

By clicking on the button, you agree to the data protection policy

Complete the quiz

By clicking on the button, you agree to the data protection policy