shopifystats

API

Control your payments from your own software

Secure RESTful API.

#API </> {REST}

Transaction Setup

Our integration system allows our merchants to send their customers to their custom payment link using a post or redirect. Then when the payment is done, we can send them back to any custom results page. The results page must be a secure SSL encrypted page.

1. Set your API Pin in the Merchant Details > Settings page
2. (Optional) set your custom results page in the Merchant Details > Settings page
Note: If results_url is posted to the paidyet payment page, the posted value will be used instead of the dashboard value
3. Post data to your custom payment link
Note: replace the proper fields with your merchant key, pin and payment link

Sample to use PaidYET’s results page

<form action="https://[paymentlink].paidyet.com" method="post">
    Amount <input name="amount">
    Invoice<input name="invoice">
    Description <input name="description">
    <input type="hidden" name="api_key" value="[Your Api Key]">
    <input type="hidden" name="api_pin" value="[Your Api Pin]">
    <button type="submit">Submit</button>
</form>

 

To use your own results page add this

<input type="hidden" name="results_url" value="[Your Results URL]">

To use for testing

1. Change [paymentlink] to test
2. Change [api_key] to 4413-098f6bcd4621d373cade4e832627b4f6
3. Change [api_pin] to 123456789

<form action="https://test.paidyet.com" method="post">
    Amount <input name="amount">
    Invoice <input name="invoice">
    Description <input name="description">
    <input type="hidden" name="api_key" value="4413-098f6bcd4621d373cade4e832627b4f6">
    <input type="hidden" name="api_pin" value="123456789">
    <button type="submit">Submit</button>
</form>

To use for testing

Card NumberExpiration CVV2 CodeResult
40001000111122240919anySuccess
40003000111122200919anyDeclined

Possible Post Results

results_url The url that the transaction details will be posted back to.
amount The USD amount that will be charged.
invoice A unique PaidYET transaction number.
description The description of the transaction. **
email The email address of the cardholder. **
address The residing address of the cardholder. **
city The residing city of the cardholder. **
state The residing state of the cardholder. **
zip The residing zip code of the cardholder. **
phone The phone number of the cardholder. **
fName First name of the cardholder that made the payment. **
lName Last name of the cardholder that made the payment. **
** this field will be editable by the user.

Response

results_urlThe url that the transaction details were posted back to.
transaction array
timestampTimestamp of when the payment was made.
TRNA unique PaidYET transaction number.
invoiceThe invoice number sent in during payment.
descriptionThe description sent in during payment.
amountThe amount in USD of the payment.
resultThe result of the payment. (Approved or declined possible values)
transaction array
last4The last 4 digits of the credit card used for payment.
typeThe card brand name of the credit card used for payment.
Examples: Visa, Mastercard, American Express, Discover
cardholder array
fNameFirst name of the cardholder that made the payment.
lNameLast name of the cardholder that made the payment.
emailEmail address of the cardholder that made the payment.
addressResiding address of the cardholder that made the payment.
cityResiding city of the cardholder that made the payment.
stateResiding state of the cardholder that made the payment.
zipResiding zip code of the cardholder that made the payment.
phonePhone number of the cardholder that made the payment.
custfield array
custfield1Custom User Defined Field
custfield2Custom User Defined Field
custfield3Custom User Defined Field