Ecommerce Account Billing Remote API

This page documents the Account Billing Remote Api (accessing an application's data through an endpoint.) For information about the programmatic API please see /api/ecommerce/programmatic.

Remote Methods

/GetOnlinePaymentData

verb: get, post

authentication: Cookies. You must be authenticated to use this remote.

Description

Retrieve the online payment information required to populate a payment form This method is an alternative to the programatic call getOnlinePaymentFields. If this data will be used to create a form that will be processed with the 

Request

The request can be querystring key=value pairs, or posted in form sets

itemIdCommaList

type: string

description: Optional. A comma delimited list of integer item IDs that will be purchased. Use this list when an order has not been created before the payment form is presented

OrderIdCommaList

type: string

Optional. A comma delimited list of integer Order IDs. Use this list when an order or orders will be paid with the form to be presented

Response

error response: 

{"errorList":["You must login to access this data."]}

successful response:

{
  "SSLSeal": "",
  "payPal_paymentCancelLink": null,
  "allowEcheck": false,
  "payMethod": 2,
  "accountCreditLimit": 999999,
  "AccountId": 54,
  "orderTotal": 0,
  "payPalOrderDecription": "",
  "allowBill": false,
  "allowCredit": false,
  "allowNoCharge": false,
  "allowCreditCard": true,
  "allowNoPaymentRequired": false,
  "allowACH": false,
  "allowNoMethodMessage": false,
  "allowPayPalButton": false,
  "accountOk": true,
  "cardList": [
    {
      "name": "1234",
      "payOptionId": 59,
      "expirationDate": "2023-09-30T00:00:00"
    },
    {
      "name": "5678",
      "payOptionId": 60,
      "expirationDate": "2024-09-30T00:00:00"
    }
  ],
  "achList": [
    {
      "name": "abc",
      "payOptionId": 59
    },
    {
      "name": "def",
      "payOptionId": 60
    }],
  "ORDERALLOWDISCOVER": true,
  "ORDERALLOWMC": true,
  "ORDERALLOWVISA": true,
  "ORDERALLOWAMEX": true,
  "payPal_thankYouPageLink": null,
  "payPal_paymentConfirmLink": null,
  "payPalAction": null,
  "payPalTestMode": false,
  "payPal_Business": null,
  "payPalButtonLink": null,
  "payPal_itemName": null,
  "paypal_currency_code": null,
  "account_AutoPayId": 99,
  "account_SecondaryAutoPayId": 96,
  "errorList": null
}

SSLSeal

type: string

description: Optional. If provided, an image that can be displayed on the form

payPal_paymentCancelLink

Optional. If pay pal buttons are supported, this link should be provided in the button

allowEcheck

If true, this account and payment provider support ACH

payMethod

An integer that represents the accounts payment requirements

• House, NoPaymentNecessary = 1
• Cash, PayOnDemand = 2
• Billing, BillAndFulfillWhenPaid = 3
• Credit, BillAndFulfillImmediately = 4
  

accountCreditLimit

If the account has a Credit payment, this is the limit of the account balance that will be allowed

AccountId

The Id of the account

orderTotal

If the request includes an order order orders, this is the total of the purchase

payPalOrderDecription

Optional. If pay pal buttons are supported, this link should be provided in the button

allowBill

true if this purchase can be billed to the customer (billed and fulfilled with payment is received)

allowCredit

true if this purchase can be charged to the customer account (billed and fulfilled right away)

allowNoCharge

true if this order has to payment

allowCreditCard

true if the customer can enter a credit card

allowNoPaymentRequired

true if this customer does not need to pay

allowACH

true if the payment processor supports ACH

allowNoMethodMessage

true if no possible payment method is available.

allowPayPalButton

true if a paypal button can be presented for this order

accountOk

true if the account is in good standing

cardList

A list of credit cards that the account can use.

achList

A list of ACH payment options saved in the account

payPal_thankYouPageLink

PayPal button metadata

payPal_paymentConfirmLink

PayPal button metadata

payPalAction

• PayPal button metadata

payPalTestMode

• PayPal button metadata

payPal_Business

• PayPal button metadata

payPalButtonLink

• PayPal button metadata

payPal_itemName

• PayPal button metadata

paypal_currency_code

• PayPal button metadata
  

account_AutoPayId

• The ID of the element in the credit card list that should be used by default

account_SecondaryAutoPayId

• The ID of the element in the credit card list that should be used if the default payment fails