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

Params

Param name Description
retail_payment
required

Validations:

  • Must be a Hash
retail_payment[tenant_id]
optional

A tenant record to associate retail invoice with (optional)

Validations:

  • Must be a String
retail_payment[invoiceable_items]
optional

A collection of retail invoiceable item ids

Validations:

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

The retail invoiceable item id attempting to purchase

Validations:

  • Must be a String
retail_payment[invoiceable_items][quantity]
optional

Quantity of retail invoiceable item

Validations:

  • Must be a String
payment_method
required

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

Validations:

  • Must be a Hash
payment_method[payment_method_id]
optional

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

Validations:

  • Must be a String
payment_method[first_name]
optional

Required if not using an existing payment method

Validations:

  • Must be a String
payment_method[last_name]
optional

Required if not using an existing payment method

Validations:

  • Must be a String
payment_method[kind]
optional

Required if not using an existing payment method

Validations:

  • Must be one of: ach, creditcard, check, cash, cardswipe.
payment_method[reuseable]
optional

Validations:

  • Must be one of: true, false, 1, 0.
payment_method[magnetic_track]
optional

Required if using a card swipe

Validations:

  • Must be a String
payment_method[card_number]
optional

Required if using a credit card

Validations:

  • Must be a String
payment_method[card_type]
optional

Required if using a credit card

Validations:

  • Must be one of: visa, mastercard, american_express, diners, discover, jcb.
payment_method[security_code]
optional

Required if using a credit card

Validations:

  • Must be a String
payment_method[expiration_date]
optional

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

Validations:

  • Must be a String
payment_method[account_number]
optional

Required if using ACH

Validations:

  • Must be a String
payment_method[account_number_confirmation]
optional

Required if using ACH

Validations:

  • Must be a String
payment_method[account_type]
optional

Required if using ACH

Validations:

  • Must be a String
payment_method[bank_name]
optional

Required if using ACH

Validations:

  • Must be a String
payment_method[routing_number]
optional

Required if using ACH

Validations:

  • Must be a String
payment_method[billing_address_attributes]
optional

Required if not using an existing payment method

Validations:

  • Must be a Hash
payment_method[billing_address_attributes][company]
optional

Validations:

  • Must be a String
payment_method[billing_address_attributes][address1]
optional

Validations:

  • Must be a String
payment_method[billing_address_attributes][address2]
optional

Validations:

  • Must be a String
payment_method[billing_address_attributes][city]
optional

Validations:

  • Must be a String
payment_method[billing_address_attributes][postal]
optional

Validations:

  • Must be a String
payment_method[billing_address_attributes][state]
optional

Validations:

  • Must be a String
payment_method[check_number]
optional

Required if using Check

Validations:

  • Must be a String
payment_method[name_on_check]
optional

Required if using Check

Validations:

  • Must be a String
payment_method[check_amount]
optional

Required if using Check

Validations:

  • Must be a String
payment_method[reference_number]
optional

Required if using Money Order

Validations:

  • Must be a String
payment_method[money_order_amount]
optional

Required if using Money Order

Validations:

  • Must be a String
payment_method[amount_tendered]
optional

Required if using Cash

Validations:

  • Must be a String

Examples

POST /v1/89516dd8-55e9-47eb-a5e7-06c6ffb6ecfb/invoiceable_items/retail_payment
{
  "payment_method": {
    "kind": "credit_card",
    "first_name": "John",
    "last_name": "Doe",
    "card_type": "visa",
    "card_number": "00000000",
    "security_code": "123",
    "expiration_date": "10/24",
    "billing_postal": "12345"
  },
  "retail_payment": {
    "invoiceable_items": [
      {
        "invoiceable_item_id": "0584bce9-dcfb-4403-8a24-1405fb92c915",
        "quantity": 1
      },
      {
        "invoiceable_item_id": "3fa9c871-8756-4cbf-aac7-42816b797723",
        "quantity": 1
      }
    ]
  },
  "invoiceable_item": {}
}
200
{
  "successful_payment_event": {
    "id": "380cd10e-c2a1-4546-a66e-a505527a00ab",
    "amount": 78.05,
    "success": true,
    "date": "2023-09-15T04:38:22.790-10:00",
    "payment_method": {
      "id": "7f5e3cd4-20c8-4aa8-9d52-f25b01338b81",
      "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": {
        "kind": "credit_card",
        "first_name": "John",
        "last_name": "Doe",
        "card_type": "visa",
        "card_number": "[FILTERED]",
        "security_code": "[FILTERED]",
        "expiration_date": "10/24",
        "billing_postal": "12345"
      },
      "retail_payment": {
        "invoiceable_items": [
          {
            "invoiceable_item_id": "0584bce9-dcfb-4403-8a24-1405fb92c915",
            "quantity": 1
          },
          {
            "invoiceable_item_id": "3fa9c871-8756-4cbf-aac7-42816b797723",
            "quantity": 1
          }
        ]
      },
      "facility_id": "89516dd8-55e9-47eb-a5e7-06c6ffb6ecfb",
      "invoiceable_item": {}
    }
  }
}