Getting Started

Using This Documentation

OBJECTS

Address
Batch
Check
Contact Media
Credit Card
Customer
Custom Field
Device
Device Transaction
Lodging
Schedule
Repeat
Repeat Cancel
Transaction
Transaction Fee

Endpoints

Authentication
- Obtain a bearer tokenpost
Payment Methods
Customers
Devices
Transactions

Getting Started

Using This Documentation

OBJECTS

Address
Batch
Check
Contact Media
Credit Card
Customer
Custom Field
Device
Device Transaction
Lodging
Schedule
Repeat
Repeat Cancel
Transaction
Transaction Fee

Endpoints

Authentication
- Obtain a bearer tokenpost
Payment Methods
Customers
Devices
Transactions

Create a Transaction

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

Create a new transaction. There are two 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 schedue object with the transaction.

ACH Transactions

Created by passing a check object with the transaction.

URL Expired

The URL for this request expired after 30 days.

Body Params

Responses

Response body

object

messages

object

notice

array of objects

length ≥ 0

Any notice messages.

notice

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

success

array of objects

length ≥ 0

Any success messages.

success

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

warning

array of objects

length ≥ 0

Any warning messages.

warning

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

error

array of objects

length ≥ 0

Any error messages.

error

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

payload

object

The API Payload provides a standard payload format for consumers. It wraps any returned items into the 'items' array and describes the type of those items. It also describes how they have been paginated by the PaidYET API server.

If the called endpoint returns a single item, it will appear as the only object in the 'items' array. Otherwise, the 'items' array will contain all items that resulted from the request.

type

string

The type of data being returned in the payload.

items

array of objects

The Transaction result.

items

count

integer

The total number of items that could have been returned matching the request criteria.

pages

integer

The total number of pages.

page

integer

The number of the page of items returned.

per_page

integer

The number of items per page of this payload.

Response body

object

messages

object

notice

array of objects

length ≥ 0

Any notice messages.

notice

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

success

array of objects

length ≥ 0

Any success messages.

success

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

warning

array of objects

length ≥ 0

Any warning messages.

warning

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

error

array of objects

length ≥ 0

Any error messages.

error

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

payload

object

type

string

The type of data being returned in the payload.

items

array of objects

Empty Array

items

object

count

integer

The total number of items that could have been returned matching the request criteria.

pages

integer

The total number of pages.

page

integer

The number of the page of items returned.

per_page

integer

The number of items per page of this payload.

Response body

object

messages

object

notice

array of objects

length ≥ 0

Any notice messages.

notice

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

success

array of objects

length ≥ 0

Any success messages.

success

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

warning

array of objects

length ≥ 0

Any warning messages.

warning

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

error

array of objects

length ≥ 0

Any error messages.

error

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

payload

object

type

string

The type of data being returned in the payload.

items

array of objects

Empty Array

items

object

count

integer

The total number of items that could have been returned matching the request criteria.

pages

integer

The total number of pages.

page

integer

The number of the page of items returned.

per_page

integer

The number of items per page of this payload.

Updated 20 days ago

What’s Next

Send a Device Transaction request
Void a Transaction

Did this page help you?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.sandbox-paidyet.com/v3/transaction \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 20 days ago

What’s Next

Send a Device Transaction request
Void a Transaction

Did this page help you?

Getting Started
Using This Documentation

OBJECTS
Address
Batch
Check
Contact Media
Credit Card
Customer
Custom Field
Device
Device Transaction
Lodging
Schedule
Repeat
Repeat Cancel
Transaction
Transaction Fee

Endpoints
Authentication
Obtain a bearer tokenpost
Payment Methods
Retrieve a Payment Method by Tokenget
Retrieve a Payment Method by External IDget
Create a Payment Methodpost
Customers
Search for Customersget
List all Customer Transactionsget
Retrieve a Customer by External IDget
Update a Customerput
Retrieve a Customer by IDget
Create a Customerpost
List all Customersget
Devices
Send a Device Transaction requestpost
Cancel a Device Transaction requestpatch
Cancel a Device Transaction requestput
Retrieve a Device Transactionget
List Active Devicesget
Transactions
Increment a Lodging Transactionpost
Capture a Credit Card Transactionput
Search for Transactionsget
Retrieve a Transactionget
Refund a Transactionpost
Void a Transactionput
Create a Transactionpost

Getting Started
Using This Documentation

OBJECTS
Address
Batch
Check
Contact Media
Credit Card
Customer
Custom Field
Device
Device Transaction
Lodging
Schedule
Repeat
Repeat Cancel
Transaction
Transaction Fee

Endpoints
Authentication
Obtain a bearer tokenpost
Payment Methods
Retrieve a Payment Method by Tokenget
Retrieve a Payment Method by External IDget
Create a Payment Methodpost
Customers
Search for Customersget
List all Customer Transactionsget
Retrieve a Customer by External IDget
Update a Customerput
Retrieve a Customer by IDget
Create a Customerpost
List all Customersget
Devices
Send a Device Transaction requestpost
Cancel a Device Transaction requestpatch
Cancel a Device Transaction requestput
Retrieve a Device Transactionget
List Active Devicesget
Transactions
Increment a Lodging Transactionpost
Capture a Credit Card Transactionput
Search for Transactionsget
Retrieve a Transactionget
Refund a Transactionpost
Void a Transactionput
Create a Transactionpost

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

400Authentication Token error

401Authentication required