Callback URL Parameters for Hosted Payments Page

Below are the parameters you can include in Hosted Payment Page solution's Callback URL.


    Merchant Data | Shopper Data | Shipping Data | Invoice Data | Alternative Payment Methods Data

Merchant Data

seller.companyURLCompany name
seller.emailMerchant's email
seller.idMerchant's ID
seller.imageDirectoryPathPath to the directory that contains the merchant's images (https://[host_name]/developers/[seller_id])
seller.softDescriptorMerchant's soft descriptor

Shopper Data

shopper.account.numberShopper's account number
• For credit cards, last four digits of the card number
• For ACH, last four digits of the account number
shopper.address1Shopper's address line 1
shopper.address2Shopper's address line 2
shopper.cityShopper's city
shopper.companyNameShopper's company name
shopper.countryShopper's country
shopper.emailShopper's email address
shopper.faxShopper's fax number
shopper.firstNameShopper's first name
shopper.iban.first.fourFirst four characters of shopper's IBAN
shopper.iban.last.fourLast four characters of shopper's IBAN
shopper.idShopper's ID
shopper.lastNameShopper's last name
shopper.payment.methodShopper's payment method
shopper.phoneShopper's phone number
shopper.stateShopper's state
shopper.titleShopper's title
shopper.userNameShopper's username
shopper.zipCodeShopper's ZIP code

Shipping Data

shipping.address1Shipping address line 1
shipping.address2Shipping address line 2
shipping.cityShipping city
shipping.countryShipping country
shipping.firstNameShipping first name
shipping.lastNameShipping last name
shipping.stateShipping state
shipping.zipCodeShipping ZIP code

Invoice Data

invoice.currencyCurrency on the invoice
Note: We recommend using a name such as chargeCurrency for this parameter. You should avoid using currency as a parameter name, as it may fail.
invoice.idInvoice ID
merchant.transaction.idA Unique ID assigned by the merchant to the transaction/order
invoice.statusStatus of the invoice Values include:
• Approved: Order has been approved
• Canceled: Order has been cancelled
• Declined: Order has been declined
• Error: Order has been cancelled due to an error
• Pending: Order has not been processed yet
• Pending Vendor Review: Order is pending vendor review
invoice.taxTax amount on the invoice
invoice.totalTotal amount on the invoice

Alternative Payment Methods Data

wire.swift.codeswift code used for wire transfer account number used for wire transfer address used for wire transfer name used for wire transfer
wire.ach.abaACH ABA used for wire transfer
wire.abaABA used for wire transfer
bs.order.idBlueSnap order ID (only for off-line payments)
selected.payment.methodpayment method shopper used
bt.account.numberbank account number used for bank transfer name used for bank transfer country used for bank transfer city used for bank transfer code used for bank transfer swift code used for bank transfer
bt.payment.referencebank payment reference used for bank transfer
amounttotal the shopper paid