GET api/v1/{facilityId}/tenants/{tenantId}/payment_methods

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId		globally unique identifier	Required
tenantId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

PaymentMethodsResponseModel

Name	Description	Type	Additional information
payment_methods		Collection of PaymentMethodDataModel	None.
meta		ApiResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "payment_methods": [
    {
      "id": "70cc349a-e761-419a-bb06-3b6c1d558fb2",
      "kind": "sample string 2",
      "first_name": "sample string 3",
      "last_name": "sample string 4",
      "reuseable": true,
      "billing_address": {
        "id": "e31d78ec-5a37-4f7f-ba5f-af0ba3e13021",
        "address1": "sample string 2",
        "address2": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "postal": "sample string 6",
        "country": "sample string 7",
        "full_address": "sample string 2 sample string 3, sample string 4, sample string 5 sample string 6",
        "latitude": 1.0,
        "longitude": 1.0,
        "time_zone_id": "sample string 8",
        "time_zone_offset": "sample string 9",
        "invalid_data": true,
        "label": "sample string 11"
      },
      "card_number": "sample string 6",
      "card_type": "sample string 7",
      "expiration_date": "sample string 8",
      "account_number": "sample string 9",
      "account_type": "sample string 10",
      "bank_name": "sample string 11",
      "routing_number": "sample string 12"
    },
    {
      "id": "70cc349a-e761-419a-bb06-3b6c1d558fb2",
      "kind": "sample string 2",
      "first_name": "sample string 3",
      "last_name": "sample string 4",
      "reuseable": true,
      "billing_address": {
        "id": "e31d78ec-5a37-4f7f-ba5f-af0ba3e13021",
        "address1": "sample string 2",
        "address2": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "postal": "sample string 6",
        "country": "sample string 7",
        "full_address": "sample string 2 sample string 3, sample string 4, sample string 5 sample string 6",
        "latitude": 1.0,
        "longitude": 1.0,
        "time_zone_id": "sample string 8",
        "time_zone_offset": "sample string 9",
        "invalid_data": true,
        "label": "sample string 11"
      },
      "card_number": "sample string 6",
      "card_type": "sample string 7",
      "expiration_date": "sample string 8",
      "account_number": "sample string 9",
      "account_type": "sample string 10",
      "bank_name": "sample string 11",
      "routing_number": "sample string 12"
    }
  ],
  "meta": {
    "message": "sample string 1",
    "status_code": 2,
    "request_id": "c0c013c7-2710-4345-8939-e756478120c3",
    "error_code": 1,
    "status_message": "sample string 3",
    "status_cat": "http://httpcats.herokuapp.com/2",
    "request_method": "sample string 4",
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 1,
      "total_entries": 1,
      "previous_page": 1,
      "next_page": 1
    },
    "parameters": {}
  }
}

application/xml, text/xml

Sample:

<PaymentMethodsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Payments.ShieldApiResponseBaseChildren">
  <Meta xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase">
    <ErrorCode>1</ErrorCode>
    <HttpStatusCode>2</HttpStatusCode>
    <HttpStatusMessage>sample string 3</HttpStatusMessage>
    <Message>sample string 1</Message>
    <PaginationData>
      <CurrentPage>1</CurrentPage>
      <NextPage>1</NextPage>
      <PerPage>1</PerPage>
      <PreviousPage>1</PreviousPage>
      <TotalEntries>1</TotalEntries>
      <TotalPages>1</TotalPages>
    </PaginationData>
    <Parameters xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase.ParameterClasses" />
    <RequestId>c0c013c7-2710-4345-8939-e756478120c3</RequestId>
    <RequestMethod>sample string 4</RequestMethod>
  </Meta>
  <PaymentMethods>
    <PaymentMethodDataModel>
      <AccountNumber>sample string 9</AccountNumber>
      <AccountType>sample string 10</AccountType>
      <BankName>sample string 11</BankName>
      <BillingAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Address">
        <d4p1:Address1>sample string 2</d4p1:Address1>
        <d4p1:Address2>sample string 3</d4p1:Address2>
        <d4p1:AddressId>e31d78ec-5a37-4f7f-ba5f-af0ba3e13021</d4p1:AddressId>
        <d4p1:City>sample string 4</d4p1:City>
        <d4p1:Country>sample string 7</d4p1:Country>
        <d4p1:InvalidData>true</d4p1:InvalidData>
        <d4p1:Label>sample string 11</d4p1:Label>
        <d4p1:Latitude>1</d4p1:Latitude>
        <d4p1:Longitude>1</d4p1:Longitude>
        <d4p1:Postal>sample string 6</d4p1:Postal>
        <d4p1:State>sample string 5</d4p1:State>
        <d4p1:TimeZoneId>sample string 8</d4p1:TimeZoneId>
        <d4p1:TimeZoneOffset>sample string 9</d4p1:TimeZoneOffset>
      </BillingAddress>
      <CardNumber>sample string 6</CardNumber>
      <CardType>sample string 7</CardType>
      <ExpirationDate>sample string 8</ExpirationDate>
      <FirstName>sample string 3</FirstName>
      <Id>70cc349a-e761-419a-bb06-3b6c1d558fb2</Id>
      <LastName>sample string 4</LastName>
      <PaymentMethodKind>sample string 2</PaymentMethodKind>
      <Reuseable>true</Reuseable>
      <RoutingNumber>sample string 12</RoutingNumber>
    </PaymentMethodDataModel>
    <PaymentMethodDataModel>
      <AccountNumber>sample string 9</AccountNumber>
      <AccountType>sample string 10</AccountType>
      <BankName>sample string 11</BankName>
      <BillingAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Address">
        <d4p1:Address1>sample string 2</d4p1:Address1>
        <d4p1:Address2>sample string 3</d4p1:Address2>
        <d4p1:AddressId>e31d78ec-5a37-4f7f-ba5f-af0ba3e13021</d4p1:AddressId>
        <d4p1:City>sample string 4</d4p1:City>
        <d4p1:Country>sample string 7</d4p1:Country>
        <d4p1:InvalidData>true</d4p1:InvalidData>
        <d4p1:Label>sample string 11</d4p1:Label>
        <d4p1:Latitude>1</d4p1:Latitude>
        <d4p1:Longitude>1</d4p1:Longitude>
        <d4p1:Postal>sample string 6</d4p1:Postal>
        <d4p1:State>sample string 5</d4p1:State>
        <d4p1:TimeZoneId>sample string 8</d4p1:TimeZoneId>
        <d4p1:TimeZoneOffset>sample string 9</d4p1:TimeZoneOffset>
      </BillingAddress>
      <CardNumber>sample string 6</CardNumber>
      <CardType>sample string 7</CardType>
      <ExpirationDate>sample string 8</ExpirationDate>
      <FirstName>sample string 3</FirstName>
      <Id>70cc349a-e761-419a-bb06-3b6c1d558fb2</Id>
      <LastName>sample string 4</LastName>
      <PaymentMethodKind>sample string 2</PaymentMethodKind>
      <Reuseable>true</Reuseable>
      <RoutingNumber>sample string 12</RoutingNumber>
    </PaymentMethodDataModel>
  </PaymentMethods>
</PaymentMethodsResponseModel>