Callback URL Parameters for Hosted Payments Page

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

Merchant data

Parameter	Description
seller.companyURL	Company name
seller.email	Merchant's email
seller.id	Merchant's ID
seller.imageDirectoryPath	Path to the directory that contains the merchant's images (`https://[host_name]/developers/[seller_id]`)
seller.softDescriptor	Merchant's soft descriptor

Shopper data

Parameter	Description
shopper.account.number	Shopper's account number • For credit cards: last four digits of the card number • For ACH: last four digits of the account number
shopper.address1	Shopper's address line 1
shopper.address2	Shopper's address line 2
shopper.city	Shopper's city
shopper.companyName	Shopper's company name
shopper.country	Shopper's country
shopper.email	Shopper's email address
shopper.fax	Shopper's fax number
shopper.firstName	Shopper's first name
shopper.iban.first.four	First four characters of shopper's IBAN
shopper.iban.last.four	Last four characters of shopper's IBAN
shopper.id	Shopper's ID
shopper.lastName	Shopper's last name
shopper.payment.method	Shopper's payment method
shopper.phone	Shopper's phone number
shopper.state	Shopper's state
shopper.title	Shopper's title
shopper.userName	Shopper's username
shopper.zipCode	Shopper's ZIP code

Shipping data

Parameter	Description
shipping.address1	Shipping address line 1
shipping.address2	Shipping address line 2
shipping.city	Shipping city
shipping.country	Shipping country
shipping.firstName	Shipping first name
shipping.lastName	Shipping last name
shipping.state	Shipping state
shipping.zipCode	Shipping ZIP code

Invoice data

Parameter	Description
invoice.currency	Currency 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.id	Invoice ID
merchant.transaction.id	A Unique ID assigned by the merchant to the transaction/order
invoice.status	Status 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.tax	Tax amount on the invoice
invoice.total	Total amount on the invoice

Alternative Payment Methods data

Parameter	Description
wire.swift.code	Swift code used for wire transfer
wire.bank.account	Bank account number used for wire transfer
wire.bank.address	Bank address used for wire transfer
wire.bank.name	Bank name used for wire transfer
wire.ach.aba	ACH ABA used for wire transfer
wire.aba	ABA used for wire transfer
bs.order.id	BlueSnap order ID (only for off-line payments)
selected.payment.method	Payment method shopper used
bt.account.number	Bank account number used for bank transfer
bt.bank.name	Bank name used for bank transfer
bt.bank.country	Bank country used for bank transfer
bt.bank.city	Bank city used for bank transfer
bt.bank.code	Bank code used for bank transfer
bt.bank.swift.code	Bank swift code used for bank transfer
bt.payment.reference	Bank payment reference used for bank transfer
amount	Total the shopper paid

Updated 5 months ago