Payment methods
Payment methods for a tenant

Discussion

Payment methods that are reuseable.

>>>

GET /v1/:facility_id/payment_methods/credit_card_types
Types of credit cards accepted by the facility

Examples

GET /v1/aa5365e6-e8f4-4490-8316-fe21a46d31ea/payment_methods/credit_card_types
200
{
  "payment_methods": [
    "visa",
    "mastercard",
    "american_express",
    "diners",
    "discover",
    "jcb"
  ],
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "aa5365e6-e8f4-4490-8316-fe21a46d31ea"
    }
  }
}
>>>

GET /v1/:facility_id/tenants/:tenant_id/payment_methods
Shows all payment methods for a tenant

Examples

GET /v1/77c3ad42-162e-4b80-952b-e71c00acf890/tenants/c0ba5d24-c819-4995-9902-607f7c44fae6/payment_methods
200
{
  "payment_methods": [
    {
      "id": "559be8aa-ff12-4b66-8bdb-f0940397f87a",
      "kind": "ach",
      "first_name": "Sample",
      "last_name": "Name",
      "reuseable": true,
      "account_number": "XXXX4321",
      "account_type": "C",
      "bank_name": "Bank of Test",
      "routing_number": "XXXX1234",
      "billing_address": {
        "id": "451c12f4-41a8-441f-b2e9-1f89b09a7dbb",
        "address1": "72643 Chung Locks",
        "address2": null,
        "city": "North Daciastad",
        "state": "NV",
        "postal": "88999-8719",
        "country": "US",
        "full_address": "72643 Chung Locks, North Daciastad, NV 88999-8719",
        "latitude": 39.114844,
        "longitude": -94.630169,
        "time_zone_id": "America/Los_Angeles",
        "time_zone_offset": "-07:00",
        "invalid_data": false,
        "label": "Home"
      }
    },
    {
      "id": "48a7066b-2a28-4ca6-aadb-b10f16c6ae79",
      "kind": "credit_card",
      "first_name": "Ceola",
      "last_name": "Stehr",
      "reuseable": true,
      "card_number": "XXXX1234",
      "card_type": "mastercard",
      "expiration_date": "11/22",
      "billing_address": {
        "id": "0089800e-f87f-42ee-8c1f-430ff2c880a8",
        "address1": "67148 Schmitt Coves",
        "address2": null,
        "city": "North Daciastad",
        "state": "NV",
        "postal": "88999-8719",
        "country": "US",
        "full_address": "67148 Schmitt Coves, North Daciastad, NV 88999-8719",
        "latitude": 39.114844,
        "longitude": -94.630169,
        "time_zone_id": "America/Los_Angeles",
        "time_zone_offset": "-07:00",
        "invalid_data": false,
        "label": "Home"
      }
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 2,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "77c3ad42-162e-4b80-952b-e71c00acf890",
      "tenant_id": "c0ba5d24-c819-4995-9902-607f7c44fae6"
    }
  }
}

Params

Param name Description
tenant_id
required
Value: Must be a String
>>>

GET /v1/:facility_id/tenants/:tenant_id/payment_methods/:id
Shows a specific payment method for a tenant

Examples

GET /v1/7e7eb9d5-79af-4f12-bc7e-11e415601572/tenants/1a509dd1-4daf-455a-8cab-c3f9dfc6ef4e/payment_methods/d112c0de-157b-48db-9543-9395c10466b1
200
{
  "credit_card_payment_method": {
    "id": "d112c0de-157b-48db-9543-9395c10466b1",
    "kind": "credit_card",
    "first_name": "Gerald",
    "last_name": "Stamm",
    "reuseable": true,
    "card_number": "XXXX1234",
    "card_type": "mastercard",
    "expiration_date": "11/22",
    "billing_address": {
      "id": "e4be4a81-bcec-4673-b21f-217de21cdcdd",
      "address1": "848122 Denny Summit",
      "address2": null,
      "city": "North Daciastad",
      "state": "NV",
      "postal": "88999-8719",
      "country": "US",
      "full_address": "848122 Denny Summit, North Daciastad, NV 88999-8719",
      "latitude": 39.114844,
      "longitude": -94.630169,
      "time_zone_id": "America/Los_Angeles",
      "time_zone_offset": "-07:00",
      "invalid_data": false,
      "label": "Home"
    }
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "7e7eb9d5-79af-4f12-bc7e-11e415601572",
      "tenant_id": "1a509dd1-4daf-455a-8cab-c3f9dfc6ef4e",
      "id": "d112c0de-157b-48db-9543-9395c10466b1"
    }
  }
}

Params

Param name Description
tenant_id
required
Value: Must be a String
id
required
Value: Must be a String