Create a Transaction

post

https://{environment}.{server}.com/v3/transaction

Create a new transaction. There are three ways to create a new transaction:

Credit Card Transactions

Created by passing a credit card object with the transaction. Can be of type 'sale' or 'auth'. Credit Card Transactions can also be scheduled using this endpoint by simply passing a schedule object with the transaction.

ACH Transactions

Created by passing a check object with the transaction.

EMV Transactions

Created by passing a BER-TLV compliant EMV data string with the transaction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Credit Card Transactions require a card and not a check.

For new Credit Card Transactions, the card may be either tokenized or non-tokenized. Any non-tokenized card will be tokenized automatically by the PaidYET API.

amount

number

required

Required amount in dollars. Must be 0 or greater. Excluding fees. Surcharge fees will automatically be added if surcharging is enabled on merchant's account. Do not include surcharge fees in this amount.

gratuity

number

Optional amount in dollars. Must be 0 or greater. To use at the time of sale, supply the gratuity with the sale. To use with tip-adjust, since the gratuity is known only after the original auth transaction, the gratuity is applied during the following capture of that auth at a later time.

estimate

boolean

Indicates the supplied amount is an estimate, required to be a value of true at the time of sale with an auth transaction when expecting a tip-adjustment to be performed later on the subsequent capture.

string

fees

array of objects

Array of fees associated with this transaction. These fees will be added to the total amount charged on the card. Do not add surcharge fees here.

fees

input_method

string

chip, swipe, keyed, etc.

type

string

Optional. If omitted and amount is '0', defaults to 'auth'. If Omitted and amount is greater than '0', defaults to 'sale'.

status

string

custom_fields

array of objects

custom_fields

source

string

api, etc.

avs_result

boolean

The AVS result.

string

billing_address

object

An Address represents a billing address that can be associated to a Card, Customer, or Transaction.

string

Customer's email address.

schedule

object

Allows the associated Transaction to be scheduled. Also allows the associated Transaction to recur according to the provided Repeat. If the recurring should end, a Repeat Cancel should be provided.

date_created

string

customer

object

Customers are stored in a merchant's customer database.

order_id

string

The Order ID.

invoice

string

Optional invoice number.

purchase_order_number

string

Optional PO number.

comments

string

Optional comments.

error

string

result

string

The result of the transaction.

lodging

object

Represents lodging information to be sent in with a Transaction object.

batch

object

A Batch is a grouping for any Transactions that took place within a certain timeframe. Batches do not directly contain a collection of Transactions. Instead, a Transaction is assocaited with a Batch automatically when the Transaction is created.

send_receipt

boolean

If this is set to true, a receipt will be sent to the customer's email address.

external_id

string | null

Unique identifier used to look up customer. This is not generated by PaidYET.

credit_card

required

Responses

200PaidYET API Response containing the payload and any messages. The payload's items array contains ONE Transaction.

400Authentication Token error

401Authentication required