Payment Methods (Facility Level)
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/d054d5e7-98ba-4c54-9843-f37089af2094/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": "d054d5e7-98ba-4c54-9843-f37089af2094",
      "payment_method": {}
    }
  }
}
>>>

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

Params

Param name Description
tenant_id
required

Validations:

  • Must be a String

Examples

GET /v1/0c3d8bad-1796-42fe-8dad-f4ca07f153df/tenants/1e9ca5d5-a94b-4a5b-b7a5-0f27f8174ceb/payment_methods
200
{
  "payment_methods": [
    {
      "id": "165fe054-960e-4e73-8b1e-abb4adbea89b",
      "kind": "ach",
      "first_name": "Sample",
      "last_name": "Name",
      "reuseable": true,
      "account_number": "XXXX4321",
      "account_type": "checking",
      "bank_name": "Bank of Test",
      "routing_number": "XXXX1234",
      "billing_address": {
        "id": "faba619b-5c3b-4138-8e38-c983b7c86a99",
        "address1": "688257 Nedra Haven",
        "address2": null,
        "city": "Tiffanishire",
        "state": "AR",
        "postal": "09024",
        "country": "US",
        "full_address": "688257 Nedra Haven, Tiffanishire, AR 09024",
        "latitude": 39.114844,
        "longitude": -94.630169,
        "time_zone_id": "America/Chicago",
        "time_zone_offset": "-05:00",
        "invalid_data": false,
        "label": "Home"
      }
    },
    {
      "id": "8afca522-b289-4c98-b53f-717aa20190ad",
      "kind": "credit_card",
      "first_name": "Sharyl",
      "last_name": "Waelchi",
      "reuseable": true,
      "card_number": "XXXX1234",
      "card_type": "mastercard",
      "expiration_date": "11/23",
      "billing_address": {
        "id": "dbef133f-c197-453b-a8fe-8e0dcf541bd0",
        "address1": "575666 Morris Fall",
        "address2": null,
        "city": "Tiffanishire",
        "state": "AR",
        "postal": "09024",
        "country": "US",
        "full_address": "575666 Morris Fall, Tiffanishire, AR 09024",
        "latitude": 39.114844,
        "longitude": -94.630169,
        "time_zone_id": "America/Chicago",
        "time_zone_offset": "-05: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": "0c3d8bad-1796-42fe-8dad-f4ca07f153df",
      "tenant_id": "1e9ca5d5-a94b-4a5b-b7a5-0f27f8174ceb",
      "payment_method": {}
    }
  }
}
>>>

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

Params

Param name Description
tenant_id
required

Validations:

  • Must be a String
id
required

Validations:

  • Must be a String

Examples

GET /v1/fbac50eb-b3ac-47b6-8651-f2722dd3d14f/tenants/7d33dcc5-c757-475b-986d-50ae5c97aa1a/payment_methods/3561d1c0-f58d-49f9-af29-9c4eaa8a9ec3
200
{
  "credit_card_payment_method": {
    "id": "3561d1c0-f58d-49f9-af29-9c4eaa8a9ec3",
    "kind": "credit_card",
    "first_name": "Belva",
    "last_name": "O'Conner",
    "reuseable": true,
    "card_number": "XXXX1234",
    "card_type": "mastercard",
    "expiration_date": "11/23",
    "billing_address": {
      "id": "0740f0b8-29f1-4194-977f-998facd0dafd",
      "address1": "76902 Graham Wall",
      "address2": null,
      "city": "Tiffanishire",
      "state": "AR",
      "postal": "09024",
      "country": "US",
      "full_address": "76902 Graham Wall, Tiffanishire, AR 09024",
      "latitude": 39.114844,
      "longitude": -94.630169,
      "time_zone_id": "America/Chicago",
      "time_zone_offset": "-05: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": "fbac50eb-b3ac-47b6-8651-f2722dd3d14f",
      "tenant_id": "7d33dcc5-c757-475b-986d-50ae5c97aa1a",
      "id": "3561d1c0-f58d-49f9-af29-9c4eaa8a9ec3",
      "payment_method": {}
    }
  }
}