Extras

Mock Payment Processing

Your account is currently hooked up to the mock processor, meaning transactions will not move real money. To process a transaction, you should issue a POST against the /txns endpoint. Click here for a sample.

The best way to handle the transaction processing is to process the transaction and check the status field of the response. If the status is Pending or Settled, that means the transaction was successful.

Test Credit Cards

Use any expiration date in the future! Use any 4-digit security code for American Express and any 3-digit security code for all others.

Trigger Amounts

To trigger declines, we use a value look up table. Simply process a transaction for these dollar amounts, and you will get the response you desire. Please note that partial authorizations, while simulated by the API, are disabled at our live processor and cannot happen in the real world. Also note that in the real world, transactions will go into Pending until they’re batched out at midnight, however, the default behavior is to move straight to Settled, so that programmers reporting tools will usually work without the developer having to wait a day.

If you need to do end-to-end reconciling, You will schedule a daily call to a report process that loops through the transactions for the day and matches them up with your system.

Test Magnetic Stripes

Copy the below stripe. Click “Swipe Card”. CTRL+V to paste in the stripe.

%B4111111111111111^JONES/NANCY^00000000000000000000000?;4111111111111111=150151465116111?

%B55454545454545454^JONES/NANCY^00000000000000000000000?;5454545454545454=150151465116111?

%B378282246310005^JONES/NANCY^00000000000000000000000?;378282246310005=150151465116111?

ACH Testing

Routing Number: 111111118

Account Number: any integer longer than 5 digits

HTTP API Notes

UTF-8 Encoding

Every string passed to and from the API needs to be UTF­8 encoded. For maximum compatibility, normalize to Unicode Normalization Form C (NFC) before UTF-­8 encoding.

Date Format

SchoolPay’s API’s use two date formats, we apologize in advance for the confusion, we are upgrading our standards over time!

When no time zone identifier is attached (naive, old format) the date’s time zone is America/Chicago.

Error Handling

Errors are returned using standard HTTP error code syntax. Any additional info is included in the body of the return call, JSON­-formatted. Error codes not listed here are in the REST API methods listed below.

Remove non-ASCII characters from JSON

SchoolPay utilizes a framework that cannot handle extended characters in JSON. While this is annoying, it is easy enough to fix by preconditioning your API. You must escape all non-ascii characters in your JSON payloads or you will receive a 500 error.

asciiJSON.escapeNonAsciis = function(text) {
  var chars, code, i;

  chars = [];
  i = 0;
  while (i < text.length) {
    code = text.charCodeAt(i);
    if (code < 128) {
      chars.push(text[i]);
    } else {
      if (code < 256) {
        chars.push('\\u00');
      } else if (code < 4096) {
        chars.push('\\u0');
      } else {
        chars.push('\\u');
      }
      chars.push(code.toString(16));
    }
    i++;
  }
  return chars.join('');
};

Standard API Errors

HMACSHA1

function hmac_sha1(string $key, string $string) {
    $data = utf8_encode($string);
    $blocksize = 64;
    $hashfunc = 'sha1';
    if (strlen($key) > $blocksize) {
        $key = pack('H*', $hashfunc($key));
    }
    $key = str_pad($key, $blocksize, chr(0x00));
    $ipad = str_repeat(chr(0x36), $blocksize);
    $opad = str_repeat(chr(0x5c), $blocksize);
    $hmac = pack('H*', $hashfunc(($key^$opad) . pack('H*', $hashfunc( ($key^$ipad) . $data))));
    $hexData = bin2hex($hmac);

    $raw = '';
    for ( $i = 0; $i < strlen($hexData); $i += 2) {
        $raw .= chr(hexdec(substr($hexData, $i, 2)));
    }
    return base64_encode($raw);
}

Data Dictionaries

Item Object

Bank Account Object

The bank account information can be validated by using an object of type

Batch Object

Credit Card Object

ErrorBody Object

GLAccount Object

GLBatch Object

PagedList of T

Payee

Payer

Transactions

Transaction Status Details

Item/Change

Item/ItemModel

Student

PurchasedItem