POST /v1/:facility_id/invoiceable_items/retail_payment
Make a payment on a retail item

Examples

POST /v1/23585444-8520-43c1-957e-848b71056ea3/invoiceable_items/retail_payment
{
  "payment_method": {
    "billing_postal": "12345",
    "card_number": "00000000",
    "card_type": "visa",
    "expiration_date": "10/24",
    "first_name": "John",
    "kind": "credit_card",
    "last_name": "Doe",
    "security_code": "123"
  },
  "retail_payment": {
    "invoiceable_items": [
      {
        "invoiceable_item_id": "00575d8b-1ef0-458a-b2d4-ed2569ab5038",
        "quantity": "1"
      },
      {
        "invoiceable_item_id": "30f70bc6-d09d-4a84-a521-8e4d80a182f5",
        "quantity": "1"
      }
    ]
  }
}
200
{
  "successful_payment_event": {
    "id": "6ddf63fb-8ffd-443b-a794-42c60e26b119",
    "amount": 48.76,
    "success": true,
    "date": "2022-09-12T22:37:19.574-10:00",
    "payment_method": {
      "id": "4ba5cf1a-1ee1-4f80-8945-12d9b97527cc",
      "kind": "credit_card",
      "first_name": "John",
      "last_name": "Doe",
      "reuseable": false,
      "card_number": "****0000",
      "card_type": "visa",
      "expiration_date": "10/24",
      "billing_address": null
    }
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "payment_method": {
        "billing_postal": "12345",
        "card_number": "[FILTERED]",
        "card_type": "visa",
        "expiration_date": "10/24",
        "first_name": "John",
        "kind": "credit_card",
        "last_name": "Doe",
        "security_code": "[FILTERED]"
      },
      "retail_payment": {
        "invoiceable_items": [
          {
            "invoiceable_item_id": "00575d8b-1ef0-458a-b2d4-ed2569ab5038",
            "quantity": "1"
          },
          {
            "invoiceable_item_id": "30f70bc6-d09d-4a84-a521-8e4d80a182f5",
            "quantity": "1"
          }
        ]
      },
      "facility_id": "23585444-8520-43c1-957e-848b71056ea3"
    }
  }
}

Params

Param name Description
retail_payment
required
Value: Must be a Hash
retail_payment[tenant_id]
optional

A tenant record to associate retail invoice with (optional)


Value: Must be a String
retail_payment[invoiceable_items]
optional

A collection of retail invoiceable item ids


Value: Must be an Array of nested elements
retail_payment[invoiceable_items][invoiceable_item_id]
optional

The retail invoiceable item id attempting to purchase


Value: Must be a String
retail_payment[invoiceable_items][quantity]
optional

Quantity of retail invoiceable item


Value: Must be a String
payment_method
required

Can accept a paymentmethodid, or fields for CC or ACH payments


Value: Must be a Hash
payment_method[payment_method_id]
optional

If you want to use an existing payment method, pass in the id


Value: Must be a String
payment_method[first_name]
optional

Required if not using an existing payment method


Value: Must be a String
payment_method[last_name]
optional

Required if not using an existing payment method


Value: Must be a String
payment_method[kind]
optional

Required if not using an existing payment method


Value: Must be one of: <code>ach</code>, <code>credit_card</code>, <code>check</code>, <code>cash</code>, <code>card_swipe</code>.
payment_method[reuseable]
optional
Value: Must be one of: <code>true</code>, <code>false</code>.
payment_method[magnetic_track]
optional

Required if using a card swipe


Value: Must be a String
payment_method[card_number]
optional

Required if using a credit card


Value: Must be a String
payment_method[card_type]
optional

Required if using a credit card


Value: Must be one of: <code>visa</code>, <code>mastercard</code>, <code>american_express</code>, <code>diners</code>, <code>discover</code>, <code>jcb</code>.
payment_method[security_code]
optional

Required if using a credit card


Value: Must be a String
payment_method[expiration_date]
optional

Required if using a credit card. Format: MM/YY


Value: Must be a String
payment_method[account_number]
optional

Required if using ACH


Value: Must be a String
payment_method[account_number_confirmation]
optional

Required if using ACH


Value: Must be a String
payment_method[account_type]
optional

Required if using ACH


Value: Must be a String
payment_method[bank_name]
optional

Required if using ACH


Value: Must be a String
payment_method[routing_number]
optional

Required if using ACH


Value: Must be a String
payment_method[billing_address_attributes]
optional

Required if not using an existing payment method


Value: Must be a Hash
payment_method[billing_address_attributes][company]
optional
Value: Must be a String
payment_method[billing_address_attributes][address1]
optional
Value: Must be a String
payment_method[billing_address_attributes][address2]
optional
Value: Must be a String
payment_method[billing_address_attributes][city]
optional
Value: Must be a String
payment_method[billing_address_attributes][postal]
optional
Value: Must be a String
payment_method[billing_address_attributes][state]
optional
Value: Must be a String
payment_method[check_number]
optional

Required if using Check


Value: Must be a String
payment_method[name_on_check]
optional

Required if using Check


Value: Must be a String
payment_method[check_amount]
optional

Required if using Check


Value: Must be a String
payment_method[reference_number]
optional

Required if using Money Order


Value: Must be a String
payment_method[money_order_amount]
optional

Required if using Money Order


Value: Must be a String
payment_method[amount_tendered]
optional

Required if using Cash


Value: Must be a String