Build Version:

GET paymentoptions

Gets a list of payment options.

Request Information

» Expands

Name	Description	Usage
paymentGateway	This will retrieve the related payment gateway.	GET paymentoptions?expand=paymentgateway
paymentType	This will retrieve the related payment type.	GET paymentoptions?expand=paymenttype

» Filters

Name	Description	Usage
isActive	This will filter the request by the is active flag.	GET paymentoptions?filter=isactive~{operator}~{value}
partner	This will filter the request by partner.	GET paymentoptions?filter=partner~{operator}~{value}
paymentGatewayId	This will filter the request by payment gateway ID.	GET paymentoptions?filter=paymentgatewayid~{operator}~{value}
paymentTypeId	This will filter the request by payment type ID.	GET paymentoptions?filter=paymenttypeid~{operator}~{value}
profileId	This will filter the request by profile ID.	GET paymentoptions?filter=profileid~{operator}~{value}
vendor	This will filter the request by vendor.	GET paymentoptions?filter=vendor~{operator}~{value}

» Sorting

Name	Description	Usage
displayOrder	This will sort the response by display order.	GET paymentoptions?sort=displayorder
paymentOptionId	This will sort the response by payment option ID.	GET paymentoptions?sort=paymentoptionid

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET paymentoptions?page=index~{value}
size	The size of the page when retrieving paged results.	GET paymentoptions?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "PaymentOptions": [
    {
      "DisplayOrder": 1,
      "EnableAmericanExpress": true,
      "EnableDiscover": true,
      "EnableMasterCard": true,
      "EnableRecurringPayments": null,
      "EnableVault": null,
      "EnableVisa": true,
      "IsActive": true,
      "IsRmaCompatible": null,
      "Partner": null,
      "PaymentGateway": {
        "Name": "Authorize.Net",
        "PaymentGatewayId": 1,
        "Url": "http://www.authorize.net"
      },
      "PaymentGatewayId": 1,
      "PaymentGatewayPassword": "",
      "PaymentGatewayUsername": "73BPkIVFnu65hHKjxRDZ0lTxmyNsV9hT",
      "PaymentOptionId": 24,
      "PaymentType": {
        "Description": "Google Checkout",
        "IsActive": true,
        "Name": "Google Checkout",
        "PaymentTypeId": 3
      },
      "PaymentTypeId": 2,
      "PreAuthorize": false,
      "ProfileId": null,
      "ProfileName": null,
      "TestMode": true,
      "TransactionKey": "FguRet0ahGXzM5kICiVYqxQWLHiW+1T+",
      "Vendor": null,
      "IsExists": null,
      "AdditionalFee": null
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}