Payments

Introduction

The subscriber payments API allows a subscriber user to manage and view payment methods

How It Works

The system revovles around the PaymentMethod model for working with all payments.

How To Use Payments

  • Rules

    Payment Rules contain information and settings about forms of payments a studio accepts (credit cards, gift cards etc) and validation rules for those payment methods. See the following endpoint: GET Subscriber/{subscriberId}/Rules/Shopping

    Issue a get request to fetch the API to return the appropriate settings as a PaymentRules object reflecting information and settings for the available forms of payment.

  • Shopping

    • Getting Payment Methods

      To find payment methods that can be used for a consumer's shopping session use the following endpoint: GET Subscriber/{subscriberId}/Consumer/{consumerId}/PaymentMethods/Shopping?locationId={locationId}

    • Storing Payment Methods

      To store payment methods at the client, you can use the following endpoints:

      Payments will be validated on several criteria when stored:

      • Bank Accounts
        • The user sending the request, must have permission to modify secure payment methods.
        • The subscriber must allow storing bank accounts / ACH payment methods
        • The account number and routing number must fall within the payment processor that has been setup at the subscriber's rules (no more than 50 characters, numeric only, etc.).
        • If the payment is being stored permanently (i.e., not a temporary stored payment method), it cannot already exist at the subscriber. That is, a bank account with the same account number and routing number cannot already have been stored at the subscriber.
      • Credit Cards
        • The user sending the request, must have permission to modify secure payment methods.
        • The credit card number must match the submitted card type (Must start with 4 for a Visa card, 2 or 5 for MasterCard / Maestro UK, etc.)
        • The credit card number must be valid.
        • The credit card must not be expired.
        • The subscriber must accept the credit card type.
        • The subscriber address requirements will be checked (Postal code and/or address required).
        • If the payment is being stored permanently (i.e., not a temporary stored payment method), it cannot already exist at the subscriber. That is, a credit card with the same card number, card type (Visa, MasterCard, etc.), and expiration date cannot already have been stored at the subscriber.

Current Limitations

  • 5/6/2015

    • Only Credit Cards, Account Payments, Prepaid Gift Cards, Cash, Check, and Bank Accounts are supported.
    • Exchange cards must start with "4036".
    • When persistently storing Credit Cards, the CountryCode will not be taken into account due to system limitations when merging credit card storage.

Miscellaneous

PaymentMethod

The PaymentMethod object outlines details for a specific payment method (Credit Card, Cash, Bank Account, Gift Card, etc.). This includes, but is not limited to, the Payment Method Type, rules, options, and any details related to the payment method.