GET paymentoptions/{paymentOptionId}

Gets a payment option.

Request Information

» Parameters

Name Description Additional information
paymentOptionId The ID of the payment option.

Define this parameter in the request URI.

» Expands

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

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.

  "PaymentOption": {
    "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
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false