Atlas Knowledge Base
Dashboard
Payeezy

Payeezy


Bridge between SBN and the Payeezy (First Data) payment gateway. APIEngine signs HMAC-SHA256 requests to the Payeezy REST API to tokenize a credit card, then processes card or ACH payments. The gateway URL, keys and tokens come from SBN options.

Setup

Set these SBN options, then reload options in APIEngine. When an option is blank, tokenize/cc returns {error}SBN option <name> is blank. and the payment routes return an error response with the same text.


Option

Purpose

pay_url

Payeezy gateway base URL (sandbox or production)

pay_key

Payeezy API key

pay_sec

Payeezy API secret (HMAC key)

pay_tok

Merchant token

pay_tra

TransArmor token; used by tokenize/cc only

Auth

  1. The Payeezy routes take no APIEngine user token. Restrict access to them at the network level.
  2. Outbound calls to Payeezy carry the headers apikey, token (merchant token), nonce, timestamp (Unix milliseconds) and Authorization. The Authorization value is an HMAC-SHA256 over API key + nonce + timestamp + merchant token + body, keyed by pay_sec, hex-encoded and then base64-encoded, as Payeezy specifies.

Endpoints


Verb

Route

Purpose

POST

/api/v1/payeezy/tokenize/cc

Tokenizes a credit card through Payeezy transactions/tokens. Body: type, cardholder_name, card_number, exp_date, cvv. Returns {token}<value> on success or {error}<message> on failure.

POST

/api/v1/payeezy/tokenized/payment

Processes a card payment against a token through Payeezy transactions. Body: merchant_ref, transaction_type, method, amount, currency_code, token (token_type and token_data). Returns the Payeezy response.

POST

/api/v1/payeezy/tokenized/achpayment

Processes an ACH payment through Payeezy ach/transactions. The body is forwarded to Payeezy as received. Returns the Payeezy response.

Each route also answers under /payeezy/... and /payeezey/... without the /api/v1 prefix.

Version differences


Behavior

v95 and earlier

v96 and later

Outbound TLS to Payeezy

TLS 1.1 or 1.2

TLS 1.2, or TLS 1.3 where the operating system supports it

Logging

To keep Payeezy requests and responses out of the APIEngine log, use the exclude settings described in Settings - Logging.



Was this helpful?