Integrations

API Keys

There are two options for API Keys in PaidYET.

(Option 1) Partner Level API keys: These keys are used if you are integrating multiple merchants into the PaidYET system. You can use these keys by passing the same key in but then passing in the UUID of the merchant under your partner account that you want to process with. The benefit of this key is that you can rotate out just one key, if needed, instead of rotating out each key for every merchant under your partner account.

(Option 2) Merchant Level API keys: These keys are obtained in the merchant dashboard and can be used only for the merchant that they are associated with. Partners can use these keys if they would rather keep track of a key for each merchant instead of a UUID for each merchant. However, if you intend to rotate keys periodically, each of these keys would need to be rotated individually.

REST API

Our fast, secure REST API allows merchants to process transactions through their PaidYET merchant account. Our REST API uses our backend fraud protection to eliminate fraud and remove liability from the merchant.

See our API reference documentation for more information.

Sandbox

Sandbox is a risk-free environment that allows PaidYET service integrators to test their integrations without using real cards, which eliminates the risk of leaking sensitive card information while testing.

See the guide for more information.

Hosted Checkout

Hosted Checkout is our rapid-setup hosted payment page solution that sends a customer from the merchant's site to our secure payment page when it's time to make a payment. Once the customer completes the payment, it sends the customer back to the merchant's site. It can be integrated in minutes, and it relieves the merchant of PCI liabilities.

See the guide for more information.

POS Devices

Our state-of-the-art POS devices use an Android interface to integrate between cardholders and PaidYET secure payment processing infrastructure. They allow a merchant to process transactions through our gateway at a physical point of sale.

See the guide for more information.

Widget

Widget is our embeddable JavaScript plugin that allows the merchant to provide a seamless payment experience to a customer without taking the liability of handling or storing sensitive cardholder information. It can be added in a few simple lines of code.

See the guide for more information.

Get Token

Tokenization is the process of sending in sensitive credit card information and getting back a unique string of characters that identifies that credit card. The token can be used in place of the actual credit card number for all succeeding transactions.

Webhooks

With webhooks, our users may define an endpoint that will be called when an event occurs for a specific action, such as sending the results of a batch when the batch closes.

Events

Batch Closed

The "batch.closed" event is fired when a batch has successfully been sent to the settlement platform and PaidYET has received confirmation that it was received.

Batch Created

The "batch.created" event is fired any time a new batch is created.

Batch Failed

The "batch.failed" event is fired when a batch closure was attempted but there were errors. This could happen if the settlement platform does not receive the closure, or if there are errors that we receive back from the settlement platform.

Responses

For any of the batch-related webhooks, the webhook response will include the following as a JSON string:

{
  "event": "batch.closed",
  "data": [
    {
      "id": 22642,
      "status": "closed",
      "amount": "1.23",
      "merchant": {
        "name": "Acme Anvils"
      },
      "source": "tsys",
      "device": {
           "name": "Front Office Terminal",
           "sn": "123456789"
       },
      "number_transactions": 1,
      "date_opened": "2023-11-21 13:07:39",
      "date_closed": "2023-11-22 16:20:54"
    }
  ]
}

Note that the event property's value will change based on which event was fired.

Adding Webhooks to your PaidYET Account

Log into your PaidYET Dashboard.
Expand the Account tab on the left, then click Tools.
Click the Access Points tab.
Scroll to the bottom and find the Webhooks section.
Click the "+ ADD WEBHOOK" button.
Select the event you'd like to utilize, then fill out the webhook destination, which is the URL you'd like the event to be posted to.
Click Save, and notice the webhook appear in the table. You may pause or edit the destination of any webhook at any time.

SDK

Our .NET Software Development Kit can be used with backend implementations in a .NET context to simplify the coding process to our Advanced API.

Industry Specific Features

Lodging

We provide the tools to merchants that are enrolled for lodging-specific pricing to qualify for lower transaction rates, saving money on each transaction processed.

To run lodging transactions, a lodging object should be added to the transaction object when creating a transaction. Lodging transactions intended for check-in should use a type of "auth". The following is an example of a transaction object with an added lodging object:

{
    "type": "auth",
    "amount": 1.23,
    "credit_card": {
        "name": "John Doe",
        "exp": "12/34",
        "number": "4111111111111111",
    },
    "lodging": {
        "duration": 1,
        "check_in_date": "2024-01-01",
        "check_out_date": "2023-01-02",
        "room_rate": 12.34
    }
}

Optionally, to perform an incremental authorization after check-in, a PATCH should be sent to the original transaction where the type is set to "incremental", and the incremental amount is any additional amount that should be added to the "bill" for the stay:

{
  "type": "incremental",
  "amount": 1.23
}

For check-out, PATCH the original transaction with a type of "sale":

{
	"type": "sale" 
}

eCommerce

We provide the tools for to do recurring billing and card-on-file transactions when buying and selling goods through online media.

Retail (Devices)

We provide the gateway that integrates with our state-of-the-art POS devices for card present retail environments.

Collections

We are debt repayment certified, which allows us to help our debt repayment certified merchants get qualified at a lower transaction rate.

PayFac

A payment facilitator is a provider that allows its customers to accept payments using their merchant account. A PayFac handles the deposits, fees, and risk of all the customers that are boarded under the account.

ACH

Automated Clearing House, also known as Electronic Checking, allows our ACH-approved merchants to offer their customers the ability to pay by check instead of card.

Status	Definition
Processed	This status is for a newly accepted and successfully authenticated transaction.
Downloaded	This status is assigned after a transaction has been downloaded to our back-office system. This is a temporary status.
BO Exception	This statute is assigned if the transaction failed back office (BO) processes.
Originated	This status is assigned after a transaction has been successfully validated through our BO validation processes and has been successfully presented to the FED.
Funded	This status is assigned after a transaction has been paid to the merchant.
Refunded	This status is assigned when a transaction has been credited back to the consumer.
Invalid Return	This status is assigned when a transaction is returned with invalid account information.
NSF Return	This status is assigned when a transaction is returned for non-sufficient funds.
Chargeback Return	This status is assigned to a transaction that is returned unauthorized or authorization revoked.
Returned	This status is assigned to all other types of returns not defined above.
IsLateReturn Attribute	Although this is not a status this will help to understand the flow. A transaction is considered to be a Late Return when it has been Processed, Originated, and Funded but has returned after it has been funded.

Advanced Transactions

Dual Pricing / Surcharge

Our services allow the usage of Dual Pricing / Surcharge, which is the collection of fees that a merchant incurs at the time the transaction is performed. The merchant must disclose to the customer which fees are present at the time the transaction is performed.

Transaction Fees

Our services allow usage of transaction fees, which are any fees that a merchant has identified that they want to disclose to the customer.

Schedules

Our transaction scheduling allows transactions to be set to run on a future date.

Recurring

Our recurring transaction options allow transactions to be performed on a regular time interval.

Auth Only

An Authorization Only (Auth Only) transaction reserves funds from a customer's credit card without processing the payment. This verifies that the card is valid and has sufficient funds. The merchant can then submit a claim for the reserved funds, specific to the transaction. The transaction will not be finalized until it is captured. Auth Only transactions are valid for 25 days within PaidYET.