GET Consumer/{subscriberId}/PaymentMethods/GiftCard/{externalId}

Searches for a gift card payment method at the subscriber.

Request Information

URI Parameters

Name	Description	Type	Additional information
externalId		string	Required
subscriberId		string	None.

Body Parameters

None.

Response Information

Resource Description

HTTP status code 200 OK. HTTP status code 400 BadRequest. HTTP status code 404 NotFound.

PaymentMethod

Name	Type	Additional information
Name	string	None.
Description	string	None.
Type	string	None.
PaymentMethodTypeId	integer	None.
Templates	Collection of ItemMetadataTemplate	None.
Options	Collection of ItemOption	None.
Rules	Collection of ItemRule	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Type": "sample string 3",
  "PaymentMethodTypeId": 4,
  "Templates": [
    {
      "Name": "sample string 1",
      "TemplateType": "sample string 2",
      "Metadata": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "Label": "sample string 4",
          "Rules": [
            {
              "Rule": "sample string 1",
              "Value": "sample string 2"
            },
            {
              "Rule": "sample string 1",
              "Value": "sample string 2"
            }
          ]
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "Label": "sample string 4",
          "Rules": [
            {
              "Rule": "sample string 1",
              "Value": "sample string 2"
            },
            {
              "Rule": "sample string 1",
              "Value": "sample string 2"
            }
          ]
        }
      ]
    },
    {
      "Name": "sample string 1",
      "TemplateType": "sample string 2",
      "Metadata": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "Label": "sample string 4",
          "Rules": [
            {
              "Rule": "sample string 1",
              "Value": "sample string 2"
            },
            {
              "Rule": "sample string 1",
              "Value": "sample string 2"
            }
          ]
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "Label": "sample string 4",
          "Rules": [
            {
              "Rule": "sample string 1",
              "Value": "sample string 2"
            },
            {
              "Rule": "sample string 1",
              "Value": "sample string 2"
            }
          ]
        }
      ]
    }
  ],
  "Options": [
    {
      "MetadataType": "sample string 1",
      "Items": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "Properties": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          }
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "Properties": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          }
        }
      ]
    },
    {
      "MetadataType": "sample string 1",
      "Items": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "Properties": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          }
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "Properties": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          }
        }
      ]
    }
  ],
  "Rules": [
    {
      "Rule": "sample string 1",
      "Values": [
        "sample string 1",
        "sample string 2"
      ],
      "Key": "sample string 2",
      "Operation": "sample string 3"
    },
    {
      "Rule": "sample string 1",
      "Values": [
        "sample string 1",
        "sample string 2"
      ],
      "Key": "sample string 2",
      "Operation": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<PaymentMethod xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Payments">
  <Description>sample string 2</Description>
  <Name>sample string 1</Name>
  <Options xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item">
    <d2p1:ItemOption>
      <d2p1:Items>
        <d2p1:ItemOptionItem>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:Properties xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Properties>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ItemOptionItem>
        <d2p1:ItemOptionItem>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:Properties xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Properties>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ItemOptionItem>
      </d2p1:Items>
      <d2p1:MetadataType>sample string 1</d2p1:MetadataType>
    </d2p1:ItemOption>
    <d2p1:ItemOption>
      <d2p1:Items>
        <d2p1:ItemOptionItem>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:Properties xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Properties>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ItemOptionItem>
        <d2p1:ItemOptionItem>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:Properties xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Properties>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ItemOptionItem>
      </d2p1:Items>
      <d2p1:MetadataType>sample string 1</d2p1:MetadataType>
    </d2p1:ItemOption>
  </Options>
  <PaymentMethodTypeId>4</PaymentMethodTypeId>
  <Rules xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item">
    <d2p1:ItemRule>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Operation>sample string 3</d2p1:Operation>
      <d2p1:Rule>sample string 1</d2p1:Rule>
      <d2p1:Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Values>
    </d2p1:ItemRule>
    <d2p1:ItemRule>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Operation>sample string 3</d2p1:Operation>
      <d2p1:Rule>sample string 1</d2p1:Rule>
      <d2p1:Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Values>
    </d2p1:ItemRule>
  </Rules>
  <Templates xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item.Metadata">
    <d2p1:ItemMetadataTemplate>
      <d2p1:Metadata>
        <d2p1:ItemMetadata>
          <d2p1:Key>sample string 1</d2p1:Key>
          <d2p1:Label>sample string 4</d2p1:Label>
          <d2p1:Rules>
            <d2p1:ItemMetadataRule>
              <d2p1:Rule>sample string 1</d2p1:Rule>
              <d2p1:Value>sample string 2</d2p1:Value>
            </d2p1:ItemMetadataRule>
            <d2p1:ItemMetadataRule>
              <d2p1:Rule>sample string 1</d2p1:Rule>
              <d2p1:Value>sample string 2</d2p1:Value>
            </d2p1:ItemMetadataRule>
          </d2p1:Rules>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ItemMetadata>
        <d2p1:ItemMetadata>
          <d2p1:Key>sample string 1</d2p1:Key>
          <d2p1:Label>sample string 4</d2p1:Label>
          <d2p1:Rules>
            <d2p1:ItemMetadataRule>
              <d2p1:Rule>sample string 1</d2p1:Rule>
              <d2p1:Value>sample string 2</d2p1:Value>
            </d2p1:ItemMetadataRule>
            <d2p1:ItemMetadataRule>
              <d2p1:Rule>sample string 1</d2p1:Rule>
              <d2p1:Value>sample string 2</d2p1:Value>
            </d2p1:ItemMetadataRule>
          </d2p1:Rules>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ItemMetadata>
      </d2p1:Metadata>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:TemplateType>sample string 2</d2p1:TemplateType>
    </d2p1:ItemMetadataTemplate>
    <d2p1:ItemMetadataTemplate>
      <d2p1:Metadata>
        <d2p1:ItemMetadata>
          <d2p1:Key>sample string 1</d2p1:Key>
          <d2p1:Label>sample string 4</d2p1:Label>
          <d2p1:Rules>
            <d2p1:ItemMetadataRule>
              <d2p1:Rule>sample string 1</d2p1:Rule>
              <d2p1:Value>sample string 2</d2p1:Value>
            </d2p1:ItemMetadataRule>
            <d2p1:ItemMetadataRule>
              <d2p1:Rule>sample string 1</d2p1:Rule>
              <d2p1:Value>sample string 2</d2p1:Value>
            </d2p1:ItemMetadataRule>
          </d2p1:Rules>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ItemMetadata>
        <d2p1:ItemMetadata>
          <d2p1:Key>sample string 1</d2p1:Key>
          <d2p1:Label>sample string 4</d2p1:Label>
          <d2p1:Rules>
            <d2p1:ItemMetadataRule>
              <d2p1:Rule>sample string 1</d2p1:Rule>
              <d2p1:Value>sample string 2</d2p1:Value>
            </d2p1:ItemMetadataRule>
            <d2p1:ItemMetadataRule>
              <d2p1:Rule>sample string 1</d2p1:Rule>
              <d2p1:Value>sample string 2</d2p1:Value>
            </d2p1:ItemMetadataRule>
          </d2p1:Rules>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ItemMetadata>
      </d2p1:Metadata>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:TemplateType>sample string 2</d2p1:TemplateType>
    </d2p1:ItemMetadataTemplate>
  </Templates>
  <Type>sample string 3</Type>
</PaymentMethod>