Base URLhttps://apisandbox.surepay.co/api/v1

SurePay API reference

Introduction

Every SurePay surface — the portal, the virtual terminal, the mobile apps and the countertop terminals — runs on the endpoints below. Card and ACH, one-off and recurring, invoices and hosted payments, all under one base URL and one credential.

Pick an endpoint from the list on the left, or press / to search. Every request shows a runnable cURL, the raw JSON and a C# sample; switch language once and the whole page follows. Export Postman collection gives you the same requests as a v2.1 collection with baseUrl, token and apiKey already set up as variables.

Accounts with Token

Token

POST/token

This endpoint creates a sysadmin token.

Headers

Key	Value
Content-Type	application/x-www-form-urlencoded

Body

Parameter	Type	M/C/O	Value
grant_type	string	Mandatory	password.
username	string	Mandatory	Username of the sysadmin.
password	string	Mandatory	Password of the sysadmin.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=password&username=$SUREPAY_USER&password=$SUREPAY_PASS"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Account
    {
        public static void Token()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/token");

                var postData = "grant_type=password";
                postData += "&username=sysadmin";
                postData += "&password=123456";
                var data = Encoding.ASCII.GetBytes(postData);

                request.Method = "POST";
                request.ContentType = "application/x-www-form-urlencoded";
                request.ContentLength = data.Length;

                using (var stream = request.GetRequestStream())
                {
                    stream.Write(data, 0, data.Length);
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
  "access_token": "eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6EBqB7RFjVMuhmuPNWcYM7ozyMb3uaDe0gyDL_nMPESbuM5I4skBOYcUM4A06NO88CVV3yBYee7mWB1qT-YFu5A3KZJSfRIbTX9GZdrZpi-JuWsx-7GE9GIYrNJ29BpaQscTwxYDr67WiFlCCrsCqWnCPJUjCFRIrTDltz8vM15mlgjiO0y04ZACGOWNNErIVegX062oydV7SqumGJEbS9Av4gdy",
  "token_type": "bearer",
  "expires_in": 863999
}

Register user

POST/accounts/register

This endpoint registers a user.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
Username	string	Mandatory	Selected username.
Password	string	Mandatory	Selected password.
ConfirmPassword	string	Mandatory	Selected password.
IsoNumber	integer	Mandatory	Iso number.
FirstName	string	Mandatory	User’s first name.
LastName	string	Mandatory	User’s last name.
Email	string	Mandatory	User’s valid email address
Phone	integer	Mandatory	User’s phone number. The phone number must be syntactically correct. For example, 4152345678.
Address1	string	Mandatory	User’s address.
Address2	string	Optional	User’s address line 2.
City	string	Mandatory	User’s city.
State	string	Mandatory	User’s short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2.
Zipcode	integer	Mandatory	User’s zipcode. Length = 5.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/accounts/register \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
 "Username": "JohnDoe",
 "Password": "123456",
 "ConfirmPassword": "123456",
 "IsoNumber": "5000",
 "FirstName": "John",
 "LastName": "Doe",
 "Email": "johndoe@mailinator.com",
 "Phone": "9177563046",
 "Address1": "151 E 33rd ST",
 "Address2": "Second Floor",
 "City": "Dallas",
 "State": "TX",
 "Zipcode": "76092"
}'

{
 "Username": "JohnDoe",
 "Password": "123456",
 "ConfirmPassword": "123456",
 "IsoNumber": "5000",
 "FirstName": "John",
 "LastName": "Doe",
 "Email": "johndoe@mailinator.com",
 "Phone": "9177563046",
 "Address1": "151 E 33rd ST",
 "Address2": "Second Floor",
 "City": "Dallas",
 "State": "TX",
 "Zipcode": "76092"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Account
    {
        public static void RegisterUser()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/accounts/register");
                request.ContentType = "text/json";
                request.Method = "POST";

                var user = new
                {
                    Username = "JohnDoe",
                    Password = "123456",
                    ConfirmPassword = "123456",
                    IsoNumber = "1000",
                    FirstName = "John",
                    LastName = "Doe",
                    Email = "johndoe@mailinator.com",
                    Phone = "9177563046",
                    Address1 = "151 E 33rd ST",
                    Address2 = "Second Floor",
                    City = "Dallas",
                    State = "TX",
                    Zipcode = "76092"
                };

                string json = JsonConvert.SerializeObject(user);

                request.Headers.Add("Authorization", "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6EBqB7RFjVMuhmuPNWcYM7ozyMb3uaDe0gyDL_nMPESbuM5I4skBOYcUM4A06NO88CVV3yBYee7mWB1qT-YFu5A3KZJSfRIbTX9GZdrZpi-JuWsx-7GE9GIYrNJ29BpaQscTwxYDr67WiFlCCrsCqWnCPJUjCFRIrTDltz8vM15mlgjiO0y04ZACGOWNNErIVegX062oydV7SqumGJEbS9Av4gdy");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }  
    }
}

Response

{
  "id": "QyDhkzJXRRW8ydteUtCgGA",
  "userName": "JohnDoe",
  "isoNumber": 1000,
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@mailinator.com",
  "phone": "9177563046",
  "status": "User - Active",
  "address1": "151 E 33rd ST",
  "address2": "Second Floor",
  "city": "Dallas",
  "state": "TX",
  "zipcode": "76092",
  "accountNumber": "18746957"
}

Change user password

POST/accounts/ChangePassword

This endpoint changes user's password.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
Username	string	Mandatory	User’s username.
OldPassword	string	Mandatory	User’s old password.
NewPassword	string	Mandatory	User’s new password.
ConfirmPassword	string	Mandatory	User’s new password.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/accounts/ChangePassword \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "Username": "JohnDoe",
  "OldPassword": "123456",
  "NewPassword": "qwerty",
  "ConfirmPassword": "qwerty"
}'

{
  "Username": "JohnDoe",
  "OldPassword": "123456",
  "NewPassword": "qwerty",
  "ConfirmPassword": "qwerty"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Account
    {
        public static void ChangeUserPassword()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/accounts/ChangePassword");
                request.ContentType = "text/json";
                request.Method = "POST";

                var user = new
                {
                    Username = "JohnDoe",
                    OldPassword = "123456",
                    NewPassword = "qwerty",
                    ConfirmPassword = "qwerty"
                };

                string json = JsonConvert.SerializeObject(user);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }   
    }
}

Response

{
  "message": "Success"
}

Reset user password request

POST/accounts/ResetPasswordRequest

This endpoint generates user's password change request.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"

Headers using API Key

Key	Value
Content-Type	"application/json"

Query Parameters

Parameter	Type	M/C/O	Value
Username	string	Mandatory	User’s username.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/accounts/ResetPasswordRequest \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "UserName": "JohnDoe"
}'

{
  "UserName": "JohnDoe"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Account
    {
        public static void ResetUserPasswordRequest()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/accounts/ResetPasswordRequest");
                request.ContentType = "text/json";
                request.Method = "POST";

                var user = new
                {
                    UserName = "JohnDoe"
                };

                string json = JsonConvert.SerializeObject(user);

                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
  "message": "Success. Email sent."
}

Reset user password

POST/accounts/ResetPassword

This endpoint resets user's password.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"

Headers using API Key

Key	Value
Content-Type	"application/json"

Query Parameters

Parameter	Type	M/C/O	Value
Key	string	Mandatory	Key sent to user email.
NewPassword	string	Mandatory	User’s new password.
ConfirmPassword	string	Mandatory	User’s new password.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/accounts/ResetPassword \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "Key": "db92b207a57a48989924788199fbc104e3034780e4904df49d857320bce0e7de",
  "NewPassword": "123457",
  "ConfirmPassword": "123457"
}'

{
  "Key": "db92b207a57a48989924788199fbc104e3034780e4904df49d857320bce0e7de",
  "NewPassword": "123457",
  "ConfirmPassword": "123457"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Account
    {
        public static void ResetUserPassword()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/accounts/ResetPassword");
                request.ContentType = "text/json";
                request.Method = "POST";

                var user = new
                {
                    Key = "3a89ad7b706f418291423159b9ab95d0ecd384bcfe814acca35dc759aa22ea0f",
                    NewPassword = "abcdef",
                    ConfirmPassword = "abcdef"
                };

                string json = JsonConvert.SerializeObject(user);

                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
  "message": "Success. Password changed."
}

Users

Update user

PUT/users/<guid>

This endpoint updates a user.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	User’s guid to update

Query Parameters

Parameter	Type	M/C/O	Value
FirstName	string	Optional	User’s first name.
LastName	string	Optional	User’s last name.
Email	string	Optional	User’s valid email address
Phone	integer	Optional	User’s phone number. The phone number must be syntactically correct. For example, 4152345678.
Address1	string	Optional	User’s address.
Address2	string	Optional	User’s address line 2.
City	string	Optional	User’s city.
State	string	Optional	User’s short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2.
Zipcode	integer	Optional	User’s zipcode. Length = 5.

Request

curl -X PUT https://apisandbox.surepay.co/api/v1/users/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
 "FirstName": "John",
 "LastName": "Doe",
 "Email": "johndoe@mailinator.com",
 "Phone": "9177563666",
 "Address1": "151 E 33rd ST",
 "Address2": "Second Floor",
 "City": "Dallas",
 "State": "TX",
 "Zipcode": "76092"
}'

{
 "FirstName": "John",
 "LastName": "Doe",
 "Email": "johndoe@mailinator.com",
 "Phone": "9177563666",
 "Address1": "151 E 33rd ST",
 "Address2": "Second Floor",
 "City": "Dallas",
 "State": "TX",
 "Zipcode": "76092"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class User
    {
        public static void UpdateUser()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/users/f3db1e2c-df7f-4cbe-b0cf-25f74d17b501");
                request.ContentType = "text/json";
                request.Method = "PUT";

                var user = new
                {
                    FirstName = "John",
                    LastName = "Doe",
                    Email = "johndoe@mailinator.com",
                    Phone = "9177563666",
                    Address1 = "151 E 33rd ST",
                    Address2 = "Second Floor",
                    City = "Dallas",
                    State = "TX",
                    Zipcode = "76092"
                };

                string json = JsonConvert.SerializeObject(user);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
  "guid": "f3db1e2c-df7f-4cbe-b0cf-25f74d17b501",
  "userName": "JohnDoe",
  "isoNumber": 1000,
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@mailinator.com",
  "phone": "9177563666",
  "status": "User - Active",
  "address1": "151 E 33rd ST",
  "address2": "Second Floor",
  "city": "Dallas",
  "state": "TX",
  "zipcode": "76092",
  "accountNumber": "10000000",
  "roles": [
        {
            "name": "Iso Admin"
        },
        {
            "name": "Iso Employee"
        },
        {
            "name": "Merchant Admin"
        }
    ]
}

Get myself

GET/users/myself

This endpoint get myself.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Request

curl -X GET https://apisandbox.surepay.co/api/v1/users/myself \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class User
    {
        public static void GetMySelf()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/users/myself");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "961612a5-427b-4bbc-8a11-bfc1b9149243",
    "userName": "maxwinston",
    "isoNumber": "1000",
    "firstName": "Max",
    "lastName": "Winston",
    "email": "maxwinston@mailinator.com",
    "phone": "9177563046",
    "status": "User - Active",
    "address1": "151 E 33rd ST",
    "address2": "Second Floor",
    "city": "New York",
    "state": "NY",
    "zipcode": "10016",
    "accountNumber": "17091897",
    "roles": [
        {
            "name": "Iso Admin"
        },
        {
            "name": "Iso Employee"
        },
        {
            "name": "Merchant Admin"
        }
    ]
}

Bank Clearing

Create bank clearing

POST/BankClearings

This endpoint creates a bank clearing.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

You will get updates by e-mail regarding the Bank Clearing status.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device Guid.
Amount	decimal	Mandatory	Amount of the transaction. Min. amt.: $0.50
SequenceNumber	string	Optional	Use this number to call timeout reversal endpoint if you don't get a response.
IsBusinessPayment	boolean	Optional	True when using company (CCD), false when using individual (PPD). Allowed values: 1. true 2. false
SendReceipt	boolean	Optional	Set to “FALSE” if you do not want an e-mail receipt to be sent to the customer. Set to “TRUE” or leave empty if you want e-mail to be sent.
CustomData	string	Optional	order details.
CustomerLabel	string	Optional	Any name you want to show instead of customer. Eg., Player, Patient, Buyer.
CustomerID	string	Optional	Any combination of numbers and letters you use to identify the customer.
BusinessName	string	Optional	A merchant name you want to use instead of your DBA.
BankAccount	object	Mandatory	See BankAccount.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/BankClearings \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "4fdd9d2c-cda5-4e0f-b6d6-fed65393592a",
  "Amount" : 15.42, 
  "IsBusinessPayment" : true,
  "SendReceipt" : "true",
  "CustomData" : "order details",
  "CustomerLabel" : "Patient",
  "CustomerId" : "xt147",
  "BusinessName" : "Star Shoes California",
  "BankAccount":
  {
    "RoutingNumber" : "490000018",
    "AccountNumber" : "441142020",
    "NameOnAccount" : "Joe Black",  
    "Customer":
    {
      "FirstName" : "Joe",
      "LastName" : "Black",
      "Phone" : "4207888807",
      "City" : "Austin",
      "State" : "TX",
      "Country" : "US",
      "Email" : "jblack@mailinator.com",
      "Address1" : "107 7th Av.",
      "Address2" : "",
      "Zip" : "10007",
      "DateOfBirth" : "1987-07-07",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  }
}'

{
  "DeviceGuid" : "4fdd9d2c-cda5-4e0f-b6d6-fed65393592a",
  "Amount" : 15.42, 
  "IsBusinessPayment" : true,
  "SendReceipt" : "true",
  "CustomData" : "order details",
  "CustomerLabel" : "Patient",
  "CustomerId" : "xt147",
  "BusinessName" : "Star Shoes California",
  "BankAccount":
  {
    "RoutingNumber" : "490000018",
    "AccountNumber" : "441142020",
    "NameOnAccount" : "Joe Black",  
    "Customer":
    {
      "FirstName" : "Joe",
      "LastName" : "Black",
      "Phone" : "4207888807",
      "City" : "Austin",
      "State" : "TX",
      "Country" : "US",
      "Email" : "jblack@mailinator.com",
      "Address1" : "107 7th Av.",
      "Address2" : "",
      "Zip" : "10007",
      "DateOfBirth" : "1987-07-07",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class BankClearing
    {
        public static void CreateBankClearing()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/BankClearings");
                request.ContentType = "text/json";
                request.Method = "POST";

                var bankClearing = new
                {
                    DeviceGuid = "4fdd9d2c-cda5-4e0f-b6d6-fed65393592a",
                    Amount = "15.42",
                    IsBusinessPayment = "true",
                    SendReceipt = "true",
                    CustomData = "order details",
                    CustomerLabel = "Patient",
                    CustomerId = "xt147",
                    BusinessName = "Star Shoes California",
                    BankAccount = new
                    {
                        RoutingNumber = "490000018",
                        AccountNumber = "441142020",
                        NameOnAccount = "Joe Black",
                        Customer = new
                        {
                            FirstName = "Joe",
                            LastName = "Black",
                            Phone = "4207888807",
                            City = "Austin",
                            State = "TX",
                            Country = "US",
                            Email = "jblack@mailinator.com",
                            Address1 = "107 7th Av.",
                            Address2 = "",
                            Zip = "10007",
                            DateOfBirth = "1987-07-07",
                            DriverLicenseNumber = "12345678",
                            DriverLicenseState = "TX",
                            SSN4 = "1210"
                        }
                    }
                };

                string json = JsonConvert.SerializeObject(bankClearing);

                request.Headers.Add("Authorization", "Bearer DkpQk2A3K4Lwq6aFzbmkApOZWN28EowdVscW_sxY8_RTFt12xhnIa79bUmA12INI0YqKHwbMU5O5gMU_51E6wllvacKx68-mJ7F6GWnUkR2vFKaA-tdOJEqh0GD_61MGWWlXr9sxRNyH6ZzWqUS0-QdhcPLyFzJL-odqZ46I-Aouf3ixienzOnrL0m-zbExPAOnT58prg2dhB-rfIPBoF25rdokQ1KH4NFujgeF99qwIpObHeQQ25Qok7aJh5Spk");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);

Response

{
    "guid": "f3221d3c-0cb4-43be-89bc-2b5aee58b671",
    "status": "Transaction - Approved",
    "timeStamp": "2017-07-03T14:42:39.53",
    "deviceGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
    "amount": 15.42,
    "effectiveAmount": 15.42,
    "isBusinessPayment": false,
    "customData": "order details",
    "operationType": "Sale",
    "settlementType": "ACH",
    "customerLabel": "Patient",
    "businessName": "Star Shoes California",
    "customerID": "xt147",
    "processorStatusCode": "A",
    "processorResponseMessage": "APPROVED | APPROVAL | AUTH NUM 272-172 | [(4096): Internal Override] | [(0): ] | T:2315",
    "wasProcessed": true,
    "bankAccount": {
        "guid": "4506e746-b661-47f8-b70c-a2c85d28be96",
        "routingNumber": "490000018",
        "accountNumber": "441142020",
        "accountNumberLastFour": "2020",
        "nameOnAccount": "Joe Black",
        "customer": {
            "guid": "615e6b8c-18c9-4a7d-b0ca-aa6b4bec9692",
            "firstName": "Joe",
            "lastName": "Black",
            "phone": "4207888807",
            "city": "Austin",
            "country": "US",
            "email": "jblack@mailinator.com",
            "zip": "10007",
            "address1": "107 7th Av.",
            "address2": "",
            "state": "TX",
            "dateOfBirth": "1987-07-07T00:00:00",
            "driverLicenseNumber": "12345678",
            "driverLicenseState": "TX",
            "ssN4": "1210"
        }
    }
}

Get bank clearing

GET/BankClearings/<guid>

This endpoint gets a bank clearing.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Bank clearing’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/BankClearings/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class BankClearing
    {
        public static void GetBankClearing()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/BankClearings/f3221d3c-0cb4-43be-89bc-2b5aee58b671");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer DkpQk2A3K4Lwq6aFzbmkApOZWN28EowdVscW_sxY8_RTFt12xhnIa79bUmA12INI0YqKHwbMU5O5gMU_51E6wllvacKx68-mJ7F6GWnUkR2vFKaA-tdOJEqh0GD_61MGWWlXr9sxRNyH6ZzWqUS0-QdhcPLyFzJL-odqZ46I-Aouf3ixienzOnrL0m-zbExPAOnT58prg2dhB-rfIPBoF25rdokQ1KH4NFujgeF99qwIpObHeQQ25Qok7aJh5Spk");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "f3221d3c-0cb4-43be-89bc-2b5aee58b671",
    "status": "Transaction - Approved",
    "timeStamp": "2017-07-03T14:42:39.53",
    "deviceGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
    "amount": 15.42,
    "effectiveAmount": 15.42,
    "isBusinessPayment": false,
    "customData": "order details",
    "operationType": "Sale",
    "settlementType": "ACH",
    "customerLabel": "Patient",
    "businessName": "Star Shoes California",
    "customerID": "xt147",
    "processorStatusCode": "A",
    "processorResponseMessage": "APPROVED | APPROVAL | AUTH NUM 272-172 | [(4096): Internal Override] | [(0): ] | T:2315",
    "processorTransactionStatus": "Approved",
    "processorSettlementStatus": "To Be Originated",
    "wasProcessed": true,
    "bankAccount": {
        "guid": "4506e746-b661-47f8-b70c-a2c85d28be96",
        "routingNumber": "490000018",
        "accountNumber": "441142020",
        "accountNumberLastFour": "2020",
        "nameOnAccount": "Joe Black",
        "customer": {
            "guid": "615e6b8c-18c9-4a7d-b0ca-aa6b4bec9692",
            "firstName": "Joe",
            "lastName": "Black",
            "phone": "4207888807",
            "city": "Austin",
            "country": "US",
            "email": "jblack@mailinator.com",
            "zip": "10007",
            "address1": "107 7th Av.",
            "address2": "",
            "state": "TX",
            "dateOfBirth": "1987-07-07T00:00:00",
            "driverLicenseNumber": "12345678",
            "driverLicenseState": "TX",
            "ssN4": "1210"
        }
    }
}

Timeout Reversal

POST/bankclearings/timeoutreversal

This a feature that allows a user to void a transaction if it never got a response. You must send the device guid of the terminal used to run the transaction and the sequence number. If there was a sale run on that device with that sequence and it was approved, it will be voided. Otherwise you will be informed that a sale was found but it had not been approved or that there was no sale at all with that combination of device guid and sequence number.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device's Guid.
SequenceNumber	string	Mandatory	Sequence Number.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/bankclearings/timeoutreversal \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "DeviceGuid": "b29725af-b067-4a35-9819-bbb31bdf8808",
    "SequenceNumber": "849741"
}'

{
    "DeviceGuid": "b29725af-b067-4a35-9819-bbb31bdf8808",
    "SequenceNumber": "849741"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class BankClearing
    {
        public static void TimeoutReversal()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/bankclearings/timeoutreversal");
                request.ContentType = "text/json";
                request.Method = "POST";

                var bankClearing = new
                {
                    DeviceGuid = "b29725af-b067-4a35-9819-bbb31bdf8808",
                    SequenceNumber = "849741"
                };

                string json = JsonConvert.SerializeObject(bankClearing);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

"Device Guid and Sequence Number combination found and voided."

Bank Clearing Void

Create bank clearing void

POST/BankClearingVoids

This endpoint creates a bank clearing void.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device Guid.
ClearingGuid	string	Mandatory	Clearing Guid.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/BankClearingVoids \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "386ac1e6-250d-4866-b283-248c1e9340ef",
  "ClearingGuid" : "f3221d3c-0cb4-43be-89bc-2b5aee58b671"
}'

{
  "DeviceGuid" : "386ac1e6-250d-4866-b283-248c1e9340ef",
  "ClearingGuid" : "f3221d3c-0cb4-43be-89bc-2b5aee58b671"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class BankClearingVoid
    {
        public static void CreateBankClearingVoid()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/BankClearingVoids");
                request.ContentType = "text/json";
                request.Method = "POST";

                var bankClearingVoid = new
                {
                    DeviceGuid = "386ac1e6-250d-4866-b283-248c1e9340ef",
                    ClearingGuid = "f3221d3c-0cb4-43be-89bc-2b5aee58b671"
                };

                string json = JsonConvert.SerializeObject(bankClearingVoid);

                request.Headers.Add("Authorization", "Bearer DkpQk2A3K4Lwq6aFzbmkApOZWN28EowdVscW_sxY8_RTFt12xhnIa79bUmA12INI0YqKHwbMU5O5gMU_51E6wllvacKx68-mJ7F6GWnUkR2vFKaA-tdOJEqh0GD_61MGWWlXr9sxRNyH6ZzWqUS0-QdhcPLyFzJL-odqZ46I-Aouf3ixienzOnrL0m-zbExPAOnT58prg2dhB-rfIPBoF25rdokQ1KH4NFujgeF99qwIpObHeQQ25Qok7aJh5Spk");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "48ea2c28-fa67-404a-88f7-2d73801f4926",
    "status": "Transaction - Approved",
    "timeStamp": "2017-07-03T14:48:35.46",
    "deviceGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
    "clearingGuid": "f3221d3c-0cb4-43be-89bc-2b5aee58b671",
    "processorStatusCode": "A",
    "processorResponseMessage": "APPROVED | VOID ACCEPTED | VOID ACCEPTED | [(5120): Voided Check | Internal Override] | [(0): ] | T:2315",
    "wasProcessed": true,
    "relatedClearing": {
        "guid": "f3221d3c-0cb4-43be-89bc-2b5aee58b671",
        "status": "Transaction - Approved",
        "timeStamp": "2017-07-03T14:42:39.53",
        "deviceGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
        "amount": 15.42,
        "effectiveAmount": 0,
        "isBusinessPayment": false,
        "customData": "order details",
        "operationType": "Sale",
        "settlementType": "ACH",
        "processorStatusCode": "A",
        "processorResponseMessage": "APPROVED | APPROVAL | AUTH NUM 272-172 | [(4096): Internal Override] | [(0): ] | T:2315",
        "wasProcessed": true,
        "bankAccount": {
            "guid": "4506e746-b661-47f8-b70c-a2c85d28be96",
            "routingNumber": "490000018",
            "accountNumber": "441142020",
            "accountNumberLastFour": "2020",
            "nameOnAccount": "Joe Black",
            "customer": {
                "guid": "615e6b8c-18c9-4a7d-b0ca-aa6b4bec9692",
                "firstName": "Joe",
                "lastName": "Black",
                "phone": "4207888807",
                "city": "Austin",
                "country": "US",
                "email": "jblack@mailinator.com",
                "zip": "10007",
                "address1": "107 7th Av.",
                "address2": "",
                "state": "TX",
                "dateOfBirth": "1987-07-07T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        }
    }
}

Get bank clearing void

GET/BankClearingVoids/<guid>

This endpoint gets a bank clearing void.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Bank clearing void’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/BankClearingVoids/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class BankClearingVoid
    {
        public static void GetBankClearingVoid()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/BankClearingVoids/48ea2c28-fa67-404a-88f7-2d73801f4926");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer DkpQk2A3K4Lwq6aFzbmkApOZWN28EowdVscW_sxY8_RTFt12xhnIa79bUmA12INI0YqKHwbMU5O5gMU_51E6wllvacKx68-mJ7F6GWnUkR2vFKaA-tdOJEqh0GD_61MGWWlXr9sxRNyH6ZzWqUS0-QdhcPLyFzJL-odqZ46I-Aouf3ixienzOnrL0m-zbExPAOnT58prg2dhB-rfIPBoF25rdokQ1KH4NFujgeF99qwIpObHeQQ25Qok7aJh5Spk");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "48ea2c28-fa67-404a-88f7-2d73801f4926",
    "status": "Transaction - Approved",
    "timeStamp": "2017-07-03T14:48:35.46",
    "deviceGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
    "clearingGuid": "f3221d3c-0cb4-43be-89bc-2b5aee58b671",
    "processorStatusCode": "A",
    "processorResponseMessage": "APPROVED | VOID ACCEPTED | VOID ACCEPTED | [(5120): Voided Check | Internal Override] | [(0): ] | T:2315",
    "wasProcessed": true,
    "relatedClearing": {
        "guid": "f3221d3c-0cb4-43be-89bc-2b5aee58b671",
        "status": "Transaction - Approved",
        "timeStamp": "2017-07-03T14:42:39.53",
        "deviceGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
        "amount": 15.42,
        "effectiveAmount": 0,
        "isBusinessPayment": false,
        "customData": "order details",
        "operationType": "Sale",
        "settlementType": "ACH",
        "processorStatusCode": "A",
        "processorResponseMessage": "APPROVED | APPROVAL | AUTH NUM 272-172 | [(4096): Internal Override] | [(0): ] | T:2315",
        "wasProcessed": true,
        "bankAccount": {
            "guid": "4506e746-b661-47f8-b70c-a2c85d28be96",
            "routingNumber": "490000018",
            "accountNumber": "441142020",
            "accountNumberLastFour": "2020",
            "nameOnAccount": "Joe Black",
            "customer": {
                "guid": "615e6b8c-18c9-4a7d-b0ca-aa6b4bec9692",
                "firstName": "Joe",
                "lastName": "Black",
                "phone": "4207888807",
                "city": "Austin",
                "country": "US",
                "email": "jblack@mailinator.com",
                "zip": "10007",
                "address1": "107 7th Av.",
                "address2": "",
                "state": "TX",
                "dateOfBirth": "1987-07-07T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        }
    }
}

Bank Clearing Return

Create bank clearing return

POST/BankClearingReturns

This endpoint creates a bank clearing return.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device Guid.
ClearingGuid	string	Mandatory	Clearing Guid.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/BankClearingReturns \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "386ac1e6-250d-4866-b283-248c1e9340ef",
  "ClearingGuid" : "43d3f532-3c53-4b2c-aa25-0a0048b1e47e"
}'

{
  "DeviceGuid" : "386ac1e6-250d-4866-b283-248c1e9340ef",
  "ClearingGuid" : "43d3f532-3c53-4b2c-aa25-0a0048b1e47e"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class BankClearingReturn
    {
        public static void CreateBankClearingReturn()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/BankClearingReturns");
                request.ContentType = "text/json";
                request.Method = "POST";

                var bankClearingReturn = new
                {
                    DeviceGuid = "386ac1e6-250d-4866-b283-248c1e9340ef",
                    ClearingGuid = "43d3f532-3c53-4b2c-aa25-0a0048b1e47e"
                };

                string json = JsonConvert.SerializeObject(bankClearingReturn);

                request.Headers.Add("Authorization", "Bearer DkpQk2A3K4Lwq6aFzbmkApOZWN28EowdVscW_sxY8_RTFt12xhnIa79bUmA12INI0YqKHwbMU5O5gMU_51E6wllvacKx68-mJ7F6GWnUkR2vFKaA-tdOJEqh0GD_61MGWWlXr9sxRNyH6ZzWqUS0-QdhcPLyFzJL-odqZ46I-Aouf3ixienzOnrL0m-zbExPAOnT58prg2dhB-rfIPBoF25rdokQ1KH4NFujgeF99qwIpObHeQQ25Qok7aJh5Spk");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "122fb6b6-dd34-489a-875c-8ec61e8aa1ec",
    "status": "Transaction - Approved",
    "timeStamp": "2017-07-03T14:55:02.01",
    "deviceGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
    "clearingGuid": "43d3f532-3c53-4b2c-aa25-0a0048b1e47e",
    "processorStatusCode": "A",
    "processorResponseMessage": "APPROVED | REVERSAL ACCEPTED | REVERSAL ACCEPTED | [(5120): Voided Check | Internal Override] | [(0): ] | T:2315",
    "wasProcessed": true,
    "relatedClearing": {
        "guid": "43d3f532-3c53-4b2c-aa25-0a0048b1e47e",
        "status": "Transaction - Approved",
        "timeStamp": "2017-07-03T14:53:43.83",
        "deviceGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
        "amount": 15.42,
        "effectiveAmount": 0,
        "isBusinessPayment": false,
        "customData": "order details",
        "operationType": "Sale",
        "settlementType": "ACH",
        "processorStatusCode": "A",
        "processorResponseMessage": "APPROVED | APPROVAL | AUTH NUM 272-172 | [(4096): Internal Override] | [(0): ] | T:2315",
        "wasProcessed": true,
        "bankAccount": {
            "guid": "4506e746-b661-47f8-b70c-a2c85d28be96",
            "routingNumber": "490000018",
            "accountNumber": "441142020",
            "accountNumberLastFour": "2020",
            "nameOnAccount": "Joe Black",
            "customer": {
                "guid": "615e6b8c-18c9-4a7d-b0ca-aa6b4bec9692",
                "firstName": "Joe",
                "lastName": "Black",
                "phone": "4207888807",
                "city": "Austin",
                "country": "US",
                "email": "jblack@mailinator.com",
                "zip": "10007",
                "address1": "107 7th Av.",
                "address2": "",
                "state": "TX",
                "dateOfBirth": "1987-07-07T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        }
    }
}

Get bank clearing return

GET/BankClearingReturns/<guid>

This endpoint gets a bank clearing return.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Bank clearing return’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/BankClearingReturns/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class BankClearingReturn
    {
        public static void GetBankClearingReturn()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/BankClearingReturns/122fb6b6-dd34-489a-875c-8ec61e8aa1ec");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer DkpQk2A3K4Lwq6aFzbmkApOZWN28EowdVscW_sxY8_RTFt12xhnIa79bUmA12INI0YqKHwbMU5O5gMU_51E6wllvacKx68-mJ7F6GWnUkR2vFKaA-tdOJEqh0GD_61MGWWlXr9sxRNyH6ZzWqUS0-QdhcPLyFzJL-odqZ46I-Aouf3ixienzOnrL0m-zbExPAOnT58prg2dhB-rfIPBoF25rdokQ1KH4NFujgeF99qwIpObHeQQ25Qok7aJh5Spk");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "122fb6b6-dd34-489a-875c-8ec61e8aa1ec",
    "status": "Transaction - Approved",
    "timeStamp": "2017-07-03T14:55:02.01",
    "deviceGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
    "clearingGuid": "43d3f532-3c53-4b2c-aa25-0a0048b1e47e",
    "processorStatusCode": "A",
    "processorResponseMessage": "APPROVED | REVERSAL ACCEPTED | REVERSAL ACCEPTED | [(5120): Voided Check | Internal Override] | [(0): ] | T:2315",
    "wasProcessed": true,
    "relatedClearing": {
        "guid": "43d3f532-3c53-4b2c-aa25-0a0048b1e47e",
        "status": "Transaction - Approved",
        "timeStamp": "2017-07-03T14:53:43.83",
        "deviceGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
        "amount": 15.42,
        "effectiveAmount": 0,
        "isBusinessPayment": false,
        "customData": "order details",
        "operationType": "Sale",
        "settlementType": "ACH",
        "processorStatusCode": "A",
        "processorResponseMessage": "APPROVED | APPROVAL | AUTH NUM 272-172 | [(4096): Internal Override] | [(0): ] | T:2315",
        "wasProcessed": true,
        "bankAccount": {
            "guid": "4506e746-b661-47f8-b70c-a2c85d28be96",
            "routingNumber": "490000018",
            "accountNumber": "441142020",
            "accountNumberLastFour": "2020",
            "nameOnAccount": "Joe Black",
            "customer": {
                "guid": "615e6b8c-18c9-4a7d-b0ca-aa6b4bec9692",
                "firstName": "Joe",
                "lastName": "Black",
                "phone": "4207888807",
                "city": "Austin",
                "country": "US",
                "email": "jblack@mailinator.com",
                "zip": "10007",
                "address1": "107 7th Av.",
                "address2": "",
                "state": "TX",
                "dateOfBirth": "1987-07-07T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        }
    }
}

Sale

Create sale

POST/sales

The Sale transaction is used to charge a credit card. When running a sale you’re authorizing an amount on a credit card that will make the settlement of that amount at the end of the day. The sale is just like running an AuthOnly and a Capture all together.

This endpoint creates a sale.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device's Guid.
Amount	decimal	Mandatory	Amount of the transaction. Min. amt.: $0.50
TipAmount	decimal	Optional	Tip Amount of the transaction.
SequenceNumber	string	Optional	Use this number to call timeout reversal endpoint if you don't get a response.
OrderNumber	string	Optional	Merchant's order number. The value sent on this element will be returned as InvoiceNumber. Length = 17.
OrderDate	date	Optional	Order Date.
SendReceipt	boolean	Optional	Set to “FALSE” if you do not want an e-mail receipt to be sent to the customer. Set to “TRUE” or leave empty if you want e-mail to be sent.
CustomData	string	Optional	order details.
CustomerLabel	string	Optional	Any name you want to show instead of customer. Eg., Player, Patient, Buyer.
CustomerID	string	Optional	Any combination of numbers and letters you use to identify the customer.
BusinessName	string	Optional	A merchant name you want to use instead of your DBA.
AssociateCustomerCard	boolean	Optional	An option to know if you want use to save customer and card token.
SurchargeLabel	string	Optional	Surcharge Name.
SurchargeType	string	Optional	P or F (percentage or fixed).
Surcharge	decimal	Optional	Default additional charge value.
ServiceFee	decimal	Optional	Any additional amount the merchant wants to charge on every sale.(fixed)
Discount	decimal	Optional	Any amount the merchant wants to discount on every sale.(fixed)
GrossAmount	decimal	If ServiceFee and/or Discount are sent, GrossAmount is mandatory	Amount before service fee and/or discount.
SemiIntegrated	boolean	Optional	Only when physical terminal used on semi integrated mode, send value True.
Card	object	Mandatory	See Card.
EnhancedData	object	Optional	See EnhancedData.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/sales \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "2101a0b0-6e0b-481b-b313-049675630c43",
  "Amount" : 19.74,
  "TipAmount" : 0.74,
  "OrderNumber" : "11518",
  "OrderDate" : "2017-02-03",
  "SendReceipt" : "true",
  "CustomData" : "order details",
  "CustomerLabel" : "Patient",
  "CustomerId" : "xt147",
  "BusinessName" : "Star Shoes California",
  "AssociateCustomerCard" : "true",
  "Card":
  {
    "CardNumber" : "5306764208460213",
    "CardHolderName" : "John Doe",
    "Cvv2" : "998",
    "ExpirationDate" : "1907",
    "Customer":
    {
      "FirstName" : "John",
      "LastName" : "Doe",
      "Phone" : "9177563007",
      "City" : "New York",
      "State" : "NY",
      "Country" : "US",
      "Email" : "johnd@mailinator.com",
      "Address1" : "107 7th Av.",
      "Address2" : "",
      "Zip" : "10007",
      "DateOfBirth" : "1987-07-07",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  }
}'

{
  "DeviceGuid" : "2101a0b0-6e0b-481b-b313-049675630c43",
  "Amount" : 19.74,
  "TipAmount" : 0.74,
  "OrderNumber" : "11518",
  "OrderDate" : "2017-02-03",
  "SendReceipt" : "true",
  "CustomData" : "order details",
  "CustomerLabel" : "Patient",
  "CustomerId" : "xt147",
  "BusinessName" : "Star Shoes California",
  "AssociateCustomerCard" : "true",
  "Card":
  {
    "CardNumber" : "5306764208460213",
    "CardHolderName" : "John Doe",
    "Cvv2" : "998",
    "ExpirationDate" : "1907",
    "Customer":
    {
      "FirstName" : "John",
      "LastName" : "Doe",
      "Phone" : "9177563007",
      "City" : "New York",
      "State" : "NY",
      "Country" : "US",
      "Email" : "johnd@mailinator.com",
      "Address1" : "107 7th Av.",
      "Address2" : "",
      "Zip" : "10007",
      "DateOfBirth" : "1987-07-07",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Sale
    {
        public static void CreateSale()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/sales");
                request.ContentType = "text/json";
                request.Method = "POST";

                var sale = new
                {
                    DeviceGuid = "fde63679-0c47-4a9c-9b47-82cdf1929851",
                    Amount = "19.74",
                    TipAmount = "0.74",
                    OrderNumber = "11518",
                    OrderDate = "2017-02-03",
                    SendReceipt = "true",
                    CustomData = "order details",
                    CustomerLabel = "Patient",
                    CustomerId = "xt147",
                    BusinessName = "Star Shoes California",
                    AssociateCustomerCard = "true",
                    Card = new
                    {
                        CardNumber = "5306764208460213",
                        CardHolderName = "John Doe",
                        Cvv2 = "998",
                        ExpirationDate = "1907",
                        Customer = new
                        {
                            FirstName = "John",
                            LastName = "Doe",
                            Phone = "9177563007",
                            City = "New York",
                            State = "NY",
                            Country = "US",
                            Email = "johnd@mailinator.com",
                            Address1 = "107 7th Av.",
                            Address2 = "",
                            Zip = "10007",
                            DateOfBirth = "1987-07-07",
                            DriverLicenseNumber = "12345678",
                            DriverLicenseState = "TX",
                            SSN4 = "1210"
                        }
                    }
                };

                string json = JsonConvert.SerializeObject(sale);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console

Response

{
    "guid": "acd8333f-2fb7-4427-8101-6c8e22f4a537",
    "status": "Transaction - Approved",
    "batchStatus": "Batch - Open",
    "timeStamp": "2017-07-11T10:36:53.75",
    "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
    "amount": 19.74,
    "tipAmount": 0.74,
    "effectiveAmount": 19.74,
    "orderNumber": "11518",
    "orderDate": "2017-02-03T00:00:00",
    "cardDataSource": "MANUAL",
    "customerLabel": "Patient",
    "businessName": "Star Shoes California",
    "customerID": "xt147",
    "batchGuid": "c368cc6c-ec9f-4f63-b90f-e72bf498babd",
    "processorStatusCode": "A0000",
    "processorResponseMessage": "Success",
    "wasProcessed": true,
    "authCode": "VTLMC1",
    "refNumber": "13283532",
    "invoiceNumber": "11518",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 06:36:57\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283532\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $19.00\\n--------------------------------------\\nTip:                            $0.74\\n--------------------------------------\\nTotal:                          $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
    "customData": "order details",
    "generatedBy": "maxwinston",
    "card": {
        "first4": "5306",
        "last4": "0213",
        "cardNumber": "1zcGT7J4pkGh0213",
        "cardHolderName": "John Doe",
        "expirationDate": "2019-07",
        "customer": {
            "guid": "d1cf828d-3050-4e4c-b7cf-f4038d114d39",
            "firstName": "John",
            "lastName": "Doe",
            "phone": "9177563007",
            "city": "New York",
            "country": "US",
            "email": "johnd@mailinator.com",
            "zip": "10007",
            "address1": "107 7th Av.",
            "address2": "",
            "state": "NY",
            "dateOfBirth": "1987-07-07T00:00:00",
            "driverLicenseNumber": "12345678",
            "driverLicenseState": "TX",
            "ssN4": "1210"
        }
    },
    "associateCustomerCard": true
}

Token – Account Updater

When Merchant enrolled in the Account Updater program, the credit card number and expiration date will be reviewed and if a new card or expiration has been issued our host will return as a card token along with the Status for the update. If you are storing this information for recurring billing purposes, next transaction for this consumer should be utilizing the newly provided token representing the new card/expiration.

No request body.

Get sale

GET/sales/<guid>

This endpoint gets a sale.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Sale’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/sales/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Sale
    {
        public static void GetSale()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/sales/265717d6-baf6-4141-8563-537889f70d5d");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "265717d6-baf6-4141-8563-537889f70d5d",
    "status": "Transaction - Approved",
    "batchStatus": "Batch - Open",
    "timeStamp": "2017-07-11T10:36:53.75",
    "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
    "amount": 19.74,
    "tipAmount": 0.74,
    "effectiveAmount": 19.74,
    "orderNumber": "11518",
    "orderDate": "2017-02-03T00:00:00",
    "cardDataSource": "MANUAL",
    "customerLabel": "Patient",
    "businessName": "Star Shoes California",
    "customerID": "xt147",
    "batchGuid": "c368cc6c-ec9f-4f63-b90f-e72bf498babd",
    "processorStatusCode": "A0000",
    "processorResponseMessage": "Success",
    "wasProcessed": true,
    "authCode": "VTLMC1",
    "refNumber": "13283532",
    "invoiceNumber": "11518",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 06:36:57\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283532\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $19.00\\n--------------------------------------\\nTip:                            $0.74\\n--------------------------------------\\nTotal:                          $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
    "customData": "order details",
    "generatedBy": "maxwinston",
    "card": {
        "first4": "5306",
        "last4": "0213",
        "cardNumber": "1zcGT7J4pkGh0213",
        "cardHolderName": "John Doe",
        "expirationDate": "2019-07",
        "customer": {
            "guid": "d1cf828d-3050-4e4c-b7cf-f4038d114d39",
            "firstName": "John",
            "lastName": "Doe",
            "phone": "9177563007",
            "city": "New York",
            "country": "US",
            "email": "johnd@mailinator.com",
            "zip": "10007",
            "address1": "107 7th Av.",
            "address2": "",
            "state": "NY",
            "dateOfBirth": "1987-07-07T00:00:00",
            "driverLicenseNumber": "12345678",
            "driverLicenseState": "TX",
            "ssN4": "1210"
        }
    },
    "associateCustomerCard": true
}

Create Tip Adjustment

POST/sales/TipAdjustment

This endpoint creates a tip adjustment.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device's Guid.
TipAmount	decimal	Mandatory	Tip Amount.
SaleGuid	string	Conditional	Sale's Guid. Mandatory when SaleReferenceNumber field are not sent.
SaleReferenceNumber	string	Conditional	Sale Reference Number. Mandatory when SaleGuid field are not sent.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/sales/TipAdjustment \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "8ec1c40b-0c00-4a57-a9c7-7800bd52c308",
  "TipAmount" : 10.00,
  "SaleGuid" : "4d35a3c2-cab9-4a3e-b148-9e3c9586c7e5"
}'

{
  "DeviceGuid" : "8ec1c40b-0c00-4a57-a9c7-7800bd52c308",
  "TipAmount" : 10.00,
  "SaleGuid" : "4d35a3c2-cab9-4a3e-b148-9e3c9586c7e5"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Sale
    {
        public static void CreateTipAdjustment()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/sales/TipAdjustment");
                request.ContentType = "text/json";
                request.Method = "POST";

                var tipAdjustment = new
                {
                    DeviceGuid = "8ec1c40b-0c00-4a57-a9c7-7800bd52c308",
                    TipAmount = "10.00",
                    SaleGuid = "4d35a3c2-cab9-4a3e-b148-9e3c9586c7e5"

                };

                string json = JsonConvert.SerializeObject(tipAdjustment);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "d7b725a6-ef15-4e36-b06c-f1b0a587ba20",
    "tipAmount": 10.05,
    "status": "Transaction - Approved",
    "timeStamp": "2017-08-29T14:26:22.41-03:00",
    "deviceGuid": "8ec1c40b-0c00-4a57-a9c7-7800bd52c308",
    "saleGuid": "4d35a3c2-cab9-4a3e-b148-9e3c9586c7e5",
    "saleReferenceNumber": "13468992",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n08/29/2017 13:26:24\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 5075\\nCARD TYPE : VISA\\nEntry Mode : MANUAL\\n\\nREF # : 13468992\\nInvoice number : 11518\\nAUTH CODE : TAS690\\nSubtotal:                       $14.88\\n--------------------------------------\\nTip:                            $10.00\\n--------------------------------------\\nTotal:                          $24.88\\n--------------------------------------\\n\\n\\n\\nMax Tom\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
    "processorStatusCode": "A0000",
    "wasProcessed": true,
    "sale": {
        "guid": "4d35a3c2-cab9-4a3e-b148-9e3c9586c7e5",
        "status": "Transaction - Approved",
        "batchStatus": "Batch - Open",
        "timeStamp": "2017-08-29T14:26:07.98-03:00",
        "deviceGuid": "8ec1c40b-0c00-4a57-a9c7-7800bd52c308",
        "amount": 14.88,
        "effectiveAmount": 14.88,
        "orderNumber": "11518",
        "orderDate": "2017-02-03T00:00:00",
        "cardDataSource": "MANUAL",
        "customerLabel": "Patient",
        "businessName": "Star Shoes California",
        "customerID": "xt147",
        "batchGuid": "118104a1-ebdc-4d13-beba-aa264374e960",
        "processorStatusCode": "A0000",
        "processorResponseMessage": "Success",
        "wasProcessed": true,
        "authCode": "TAS690",
        "refNumber": "13468992",
        "invoiceNumber": "11518",
        "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n08/29/2017 13:26:09\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 5075\\nCARD TYPE : VISA\\nEntry Mode : MANUAL\\n\\nREF # : 13468992\\nInvoice number : 11518\\nAUTH CODE : TAS690\\nSubtotal:                       $14.88\\n--------------------------------------\\nTotal:                          $14.88\\n--------------------------------------\\n\\n\\n\\nMax Tom\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
        "customData": "any data the merchant or the customer",
        "generatedBy": "maxwinston",
        "card": {
            "first4": "4024",
            "last4": "5075",
            "cardNumber": "ehcNs0CAee8p5075",
            "cardHolderName": "Max Tom",
            "expirationDate": "2019-07",
            "customer": {
                "guid": "d7476418-eb46-4757-8ab6-3e2b8c96beb4",
                "firstName": "Max",
                "lastName": "Tom",
                "dateOfBirth": "1987-07-07T00:00:00",
                "address1": "107 7th Av.",
                "address2": "",
                "zip": "10007",
                "city": "New York",
                "state": "NY",
                "country": "US",
                "phone": "9123475842",
                "email": "maxtom@mailinator.com",
                "ssN4": "1210",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX"
            }
        },
        "associateCustomerCard": true
    }
}

Sales by batch

GET/sales/Batch/<guid>

This endpoint searches all sales by batch.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Batch’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/sales/Batch/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Sale
    {
        public static void GetSaleByBatch()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/sales/Batch/a72cf7fa-9169-421c-a7b8-9ebc6cd3e1ef");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

[
    {
        "guid": "46158f86-fd80-4383-a584-119775c6edf3",
        "status": "Transaction - Approved",
        "batchStatus": "Batch - Closed",
        "timeStamp": "2017-07-11T10:36:53.75",
        "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
        "amount": 19.74,
        "effectiveAmount": 19.74,
        "orderNumber": "11518",
        "orderDate": "2017-02-03T00:00:00",
        "cardDataSource": "MANUAL",
        "customerLabel": "Patient",
        "businessName": "Star Shoes California",
        "customerID": "xt147",
        "batchGuid": "c368cc6c-ec9f-4f63-b90f-e72bf498babd",
        "processorStatusCode": "A0000",
        "processorResponseMessage": "Success",
        "wasProcessed": true,
        "authCode": "VTLMC1",
        "refNumber": "13283532",
        "invoiceNumber": "11518",
        "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 06:36:57\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283532\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $19.00\\n--------------------------------------\\nTip:                            $0.74\\n--------------------------------------\\nTotal:                          $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
        "customData": "order details",
        "generatedBy": "maxwinston",
        "card": {
            "first4": "5306",
            "last4": "0213",
            "cardNumber": "1zcGT7J4pkGh0213",
            "cardHolderName": "John Doe",
            "expirationDate": "2019-07",
            "customer": {
                "guid": "d1cf828d-3050-4e4c-b7cf-f4038d114d39",
                "firstName": "John",
                "lastName": "Doe",
                "phone": "9177563007",
                "city": "New York",
                "country": "US",
                "email": "johnd@mailinator.com",
                "zip": "10007",
                "address1": "107 7th Av.",
                "address2": "",
                "state": "NY",
                "dateOfBirth": "1987-07-07T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        },
        "associateCustomerCard": true
    }
]

Timeout Reversal

POST/sales/timeoutreversal

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device's Guid.
SequenceNumber	string	Mandatory	Sequence Number.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/sales/timeoutreversal \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "DeviceGuid": "b29725af-b067-4a35-9819-bbb31bdf8808",
    "SequenceNumber": "849741"
}'

{
    "DeviceGuid": "b29725af-b067-4a35-9819-bbb31bdf8808",
    "SequenceNumber": "849741"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Sale
    {
        public static void TimeoutReversal()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/sales/timeoutreversal");
                request.ContentType = "text/json";
                request.Method = "POST";

                var sale = new
                {
                    DeviceGuid = "b29725af-b067-4a35-9819-bbb31bdf8808",
                    SequenceNumber = "849741"
                };

                string json = JsonConvert.SerializeObject(sale);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

"Device Guid and Sequence Number combination found and voided."

AuthOnly

Create AuthOnly

POST/AuthOnlys

You could use the AuthOnly transaction to authorize an amount on a credit card without making the actual settlement of that amount. In this case, you actually reserve an amount for a certain period against the credit limit of the card holder. The sale will be completed only if you run a successful capture later.

This endpoint creates an AuthOnly.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device's Guid.
Amount	decimal	Mandatory	Amount of the transaction. Min. amt.: $0.50
SequenceNumber	string	Optional	Use this number to call timeout reversal endpoint if you don't get a response.
OrderNumber	string	Optional	Merchant's order number. The value sent on this element will be returned as InvoiceNumber. Length = 17.
OrderDate	date	Optional	Order Date.
SendReceipt	boolean	Optional	Set to “FALSE” if you do not want an e-mail receipt to be sent to the customer. Set to “TRUE” or leave empty if you want e-mail to be sent.
CustomData	string	Optional	order details.
CustomerLabel	string	Optional	Any name you want to show instead of customer. Eg., Player, Patient, Buyer.
CustomerID	string	Optional	Any combination of numbers and letters you use to identify the customer.
AssociateCustomerCard	boolean	Optional	An option to know if you want use to save customer and card token.
SemiIntegrated	boolean	Optional	Only when physical terminal used on semi integrated mode, send value True.
Card	object	Mandatory	See Card.
EnhancedData	object	Optional	See EnhancedData.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/AuthOnlys \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "fde63679-0c47-4a9c-9b47-82cdf1929851",
  "Amount" : 90.00,
  "OrderNumber" : "11518",
  "OrderDate" : "2017-02-03",
  "SendReceipt" : "true",
  "CustomData" : "order details",
  "CustomerLabel" : "Patient",
  "CustomerId" : "xt147",
  "AssociateCustomerCard" : "true",
  "Card":
  {
    "CardNumber" : "5175526161474418",
    "CardHolderName" : "John Doe",
    "Cvv2" : "998",
    "ExpirationDate" : "1912",
    "Customer":
    {
      "FirstName" : "John",
      "LastName" : "Doe",
      "Phone" : "9177563006",
      "City" : "New York",
      "State" : "NY",
      "Country" : "US",
      "Email" : "johnd@mailinator.com",
      "Address1" : "106 6th Av.",
      "Address2" : "",
      "Zip" : "10006",
      "DateOfBirth" : "1986-06-06",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  }
}'

{
  "DeviceGuid" : "fde63679-0c47-4a9c-9b47-82cdf1929851",
  "Amount" : 90.00,
  "OrderNumber" : "11518",
  "OrderDate" : "2017-02-03",
  "SendReceipt" : "true",
  "CustomData" : "order details",
  "CustomerLabel" : "Patient",
  "CustomerId" : "xt147",
  "AssociateCustomerCard" : "true",
  "Card":
  {
    "CardNumber" : "5175526161474418",
    "CardHolderName" : "John Doe",
    "Cvv2" : "998",
    "ExpirationDate" : "1912",
    "Customer":
    {
      "FirstName" : "John",
      "LastName" : "Doe",
      "Phone" : "9177563006",
      "City" : "New York",
      "State" : "NY",
      "Country" : "US",
      "Email" : "johnd@mailinator.com",
      "Address1" : "106 6th Av.",
      "Address2" : "",
      "Zip" : "10006",
      "DateOfBirth" : "1986-06-06",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class AuthOnly
    {
        public static void CreateAuthOnly()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/AuthOnlys");
                request.ContentType = "text/json";
                request.Method = "POST";

                var authOnly = new
                {
                    DeviceGuid = "fde63679-0c47-4a9c-9b47-82cdf1929851",
                    Amount = "90.00",
                    OrderNumber = "11518",
                    OrderDate = "2017-02-03",
                    SendReceipt = "true",
                    CustomData = "order details",
                    CustomerLabel = "Patient",
                    CustomerId = "xt147",
                    AssociateCustomerCard = "true",
                    Card = new
                    {
                        CardNumber = "5175526161474418",
                        CardHolderName = "John Doe",
                        Cvv2 = "998",
                        ExpirationDate = "1912",
                        Customer = new
                        {
                            FirstName = "John",
                            LastName = "Doe",
                            Phone = "9177563006",
                            City = "New York",
                            State = "NY",
                            Country = "US",
                            Email = "johnd@mailinator.com",
                            Address1 = "106 6th Av.",
                            Address2 = "",
                            Zip = "10006",
                            DateOfBirth = "1986-06-06",
                            DriverLicenseNumber = "12345678",
                            DriverLicenseState = "TX",
                            SSN4 = "1210"
                        }
                    }
                };

                string json = JsonConvert.SerializeObject(authOnly);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Con

Response

{
    "guid": "c8741761-10fe-4530-be84-b1289dcdb9a7",
    "status": "Transaction - Approved",
    "batchStatus": "Batch - Open",
    "timeStamp": "2017-07-11T10:51:39.73",
    "amount": 90,
    "effectiveAmount": 90,
    "orderNumber": "11518",
    "orderDate": "2017-02-03T00:00:00",
    "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
    "customData": "order details",
    "cardDataSource": "MANUAL",
    "customerLabel": "Patient",
    "businessName": "Star Shoes California",
    "customerID": "xt147",
    "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
    "processorStatusCode": "A0002",
    "processorResponseMessage": "Partially Approved",
    "wasProcessed": true,
    "authCode": "VTLMC1",
    "refNumber": "13283616",
    "invoiceNumber": "11518",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 06:51:43\\n\\nCREDIT - AUTH ONLY\\n\\nCARD # : **** **** **** 4418\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283616\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $90.00\\n--------------------------------------\\nTotal:                          $90.00\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nPartially Approved\\n\\n\\n\\n\\nCustomer Copy\\n",
    "card": {
        "first4": "5175",
        "last4": "4418",
        "cardNumber": "dfTsPKwGQIUf4418",
        "cardHolderName": "John Doe",
        "expirationDate": "2019-12",
        "customer": {
            "guid": "53d38181-c766-48bd-acb7-37c12b6ddbeb",
            "firstName": "John",
            "lastName": "Doe",
            "phone": "9177563006",
            "city": "New York",
            "country": "US",
            "email": "johnd@mailinator.com",
            "zip": "10006",
            "address1": "106 6th Av.",
            "address2": "",
            "state": "NY",
            "dateOfBirth": "1986-06-06T00:00:00",
            "driverLicenseNumber": "12345678",
            "driverLicenseState": "TX",
            "ssN4": "1210"
        }
    },
    "associateCustomerCard": true
}

Get AuthOnly

GET/AuthOnlys/<guid>

This endpoint gets an AuthOnly.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	AuthOnly’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/AuthOnlys/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class AuthOnly
    {
        public static void GetAuthOnly()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/AuthOnlys/c8741761-10fe-4530-be84-b1289dcdb9a7");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "c8741761-10fe-4530-be84-b1289dcdb9a7",
    "status": "Transaction - Approved",
    "batchStatus": "Batch - Open",
    "timeStamp": "2017-07-11T10:51:39.73",
    "amount": 90,
    "effectiveAmount": 90,
    "orderNumber": "11518",
    "orderDate": "2017-02-03T00:00:00",
    "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
    "customData": "order details",
    "cardDataSource": "MANUAL",
    "customerLabel": "Patient",
    "customerID": "xt147",
    "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
    "processorStatusCode": "A0002",
    "processorResponseMessage": "Partially Approved",
    "wasProcessed": true,
    "authCode": "VTLMC1",
    "refNumber": "13283616",
    "invoiceNumber": "11518",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 06:51:43\\n\\nCREDIT - AUTH ONLY\\n\\nCARD # : **** **** **** 4418\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283616\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $90.00\\n--------------------------------------\\nTotal:                          $90.00\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nPartially Approved\\n\\n\\n\\n\\nCustomer Copy\\n",
    "card": {
        "first4": "5175",
        "last4": "4418",
        "cardNumber": "dfTsPKwGQIUf4418",
        "cardHolderName": "John Doe",
        "expirationDate": "2019-12",
        "customer": {
            "guid": "53d38181-c766-48bd-acb7-37c12b6ddbeb",
            "firstName": "John",
            "lastName": "Doe",
            "phone": "9177563006",
            "city": "New York",
            "country": "US",
            "email": "johnd@mailinator.com",
            "zip": "10006",
            "address1": "106 6th Av.",
            "address2": "",
            "state": "NY",
            "dateOfBirth": "1986-06-06T00:00:00",
            "driverLicenseNumber": "12345678",
            "driverLicenseState": "TX",
            "ssN4": "1210"
        }
    },
    "associateCustomerCard": true
}

Timeout Reversal

POST/AuthOnlys/timeoutreversal

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device's Guid.
SequenceNumber	string	Mandatory	Sequence Number.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/AuthOnlys/timeoutreversal \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "DeviceGuid": "b29725af-b067-4a35-9819-bbb31bdf8808",
    "SequenceNumber": "849741"
}'

{
    "DeviceGuid": "b29725af-b067-4a35-9819-bbb31bdf8808",
    "SequenceNumber": "849741"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Sale
    {
        public static void TimeoutReversal()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/AuthOnlys/timeoutreversal");
                request.ContentType = "text/json";
                request.Method = "POST";

                var sale = new
                {
                    DeviceGuid = "b29725af-b067-4a35-9819-bbb31bdf8808",
                    SequenceNumber = "849741"
                };

                string json = JsonConvert.SerializeObject(sale);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

"Device Guid and Sequence Number combination found and voided."

Capture

Create capture

POST/Captures

The Capture transaction is used to collect the money that you had asked during the AuthOnly transaction. You need to provide the AuthOnlyGuid that you received when you ran the AuthOnly.

This endpoint creates a capture.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device’s Guid.
AuthOnlyGuid	string	Mandatory	AuthOnly’s Guid.
NewAmount	decimal	Optional	Transaction's new amount. Min. amt.: $0.50

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Captures \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "4b5013f7-b275-4929-8e83-0167c6edf639",
  "AuthOnlyGuid" : "c8741761-10fe-4530-be84-b1289dcdb9a7",
  "NewAmount" : 90.00
}'

{
  "DeviceGuid" : "4b5013f7-b275-4929-8e83-0167c6edf639",
  "AuthOnlyGuid" : "c8741761-10fe-4530-be84-b1289dcdb9a7",
  "NewAmount" : 90.00
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Capture
    {
        public static void CreateCapture()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Captures");
                request.ContentType = "text/json";
                request.Method = "POST";

                var capture = new
                {
                    DeviceGuid = "4b5013f7-b275-4929-8e83-0167c6edf639",
                    AuthOnlyGuid = "c8741761-10fe-4530-be84-b1289dcdb9a7",
                    NewAmount = "90.00"
                };

                string json = JsonConvert.SerializeObject(capture);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "cf05ed0a-f9df-4e62-b613-61323a37c14e",
    "status": "Transaction - Approved",
    "batchStatus": "Batch - Open",
    "timeStamp": "2017-07-11T10:58:25.95",
    "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
    "authOnlyGuid": "539e87eb-54a2-44da-8980-62667d81d95c",
    "newAmount": 90,
    "effectiveAmount": 90,
    "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
    "processorStatusCode": "A0000",
    "processorResponseMessage": "Success",
    "wasProcessed": true,
    "refNumber": "13283616",
    "invoiceNumber": "11518",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 06:58:29\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 4418\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283616\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $90.00\\n--------------------------------------\\nTotal:                          $90.00\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
    "authOnly": {
        "guid": "539e87eb-54a2-44da-8980-62667d81d95c",
        "status": "Transaction - Approved",
        "batchStatus": "Batch - Open",
        "timeStamp": "2017-07-11T10:51:39.73",
        "amount": 90,
        "effectiveAmount": 90,
        "orderNumber": "11518",
        "orderDate": "2017-02-03T00:00:00",
        "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
        "customData": "order details",
        "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
        "processorStatusCode": "A0002",
        "processorResponseMessage": "Partially Approved",
        "wasProcessed": true,
        "authCode": "VTLMC1",
        "refNumber": "13283616",
        "invoiceNumber": "11518",
        "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 06:51:43\\n\\nCREDIT - AUTH ONLY\\n\\nCARD # : **** **** **** 4418\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283616\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $90.00\\n--------------------------------------\\nTotal:                          $90.00\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nPartially Approved\\n\\n\\n\\n\\nCustomer Copy\\n",
        "card": {
            "first4": "5175",
            "last4": "4418",
            "cardNumber": "dfTsPKwGQIUf4418",
            "cardHolderName": "John Doe",
            "expirationDate": "2019-12",
            "customer": {
                "guid": "53d38181-c766-48bd-acb7-37c12b6ddbeb",
                "firstName": "John",
                "lastName": "Doe",
                "phone": "9177563006",
                "city": "New York",
                "country": "US",
                "email": "johnd@mailinator.com",
                "zip": "10006",
                "address1": "106 6th Av.",
                "address2": "",
                "state": "NY",
                "dateOfBirth": "1986-06-06T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        }
    },
    "relatedSale": {
        "guid": "34f87b4e-3345-4c01-96de-c4257c38e822",
        "status": "Transaction - Approved",
        "batchStatus": "Batch - Open",
        "timeStamp": "2017-07-11T10:58:27.37",
        "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
        "amount": 90,
        "effectiveAmount": 90,
        "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
        "wasProcessed": true
    }
}

Get capture

GET/Captures/<guid>

This endpoint gets a capture.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Capture’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/Captures/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Capture
    {
        public static void GetCapture()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Captures/cf05ed0a-f9df-4e62-b613-61323a37c14e");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "cf05ed0a-f9df-4e62-b613-61323a37c14e",
    "status": "Transaction - Approved",
    "batchStatus": "Batch - Open",
    "timeStamp": "2017-07-11T10:58:25.95",
    "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
    "authOnlyGuid": "539e87eb-54a2-44da-8980-62667d81d95c",
    "newAmount": 90,
    "effectiveAmount": 90,
    "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
    "processorStatusCode": "A0000",
    "processorResponseMessage": "Success",
    "wasProcessed": true,
    "refNumber": "13283616",
    "invoiceNumber": "11518",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 06:58:29\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 4418\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283616\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $90.00\\n--------------------------------------\\nTotal:                          $90.00\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
    "authOnly": {
        "guid": "539e87eb-54a2-44da-8980-62667d81d95c",
        "status": "Transaction - Approved",
        "batchStatus": "Batch - Open",
        "timeStamp": "2017-07-11T10:51:39.73",
        "amount": 90,
        "effectiveAmount": 90,
        "orderNumber": "11518",
        "orderDate": "2017-02-03T00:00:00",
        "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
        "customData": "order details",
        "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
        "processorStatusCode": "A0002",
        "processorResponseMessage": "Partially Approved",
        "wasProcessed": true,
        "authCode": "VTLMC1",
        "refNumber": "13283616",
        "invoiceNumber": "11518",
        "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 06:51:43\\n\\nCREDIT - AUTH ONLY\\n\\nCARD # : **** **** **** 4418\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283616\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $90.00\\n--------------------------------------\\nTotal:                          $90.00\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nPartially Approved\\n\\n\\n\\n\\nCustomer Copy\\n",
        "card": {
            "first4": "5175",
            "last4": "4418",
            "cardNumber": "dfTsPKwGQIUf4418",
            "cardHolderName": "John Doe",
            "expirationDate": "2019-12",
            "customer": {
                "guid": "53d38181-c766-48bd-acb7-37c12b6ddbeb",
                "firstName": "John",
                "lastName": "Doe",
                "phone": "9177563006",
                "city": "New York",
                "country": "US",
                "email": "johnd@mailinator.com",
                "zip": "10006",
                "address1": "106 6th Av.",
                "address2": "",
                "state": "NY",
                "dateOfBirth": "1986-06-06T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        }
    },
    "relatedSale": {
        "guid": "34f87b4e-3345-4c01-96de-c4257c38e822",
        "status": "Transaction - Approved",
        "batchStatus": "Batch - Open",
        "timeStamp": "2017-07-11T10:58:27.37",
        "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
        "amount": 90,
        "effectiveAmount": 90,
        "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
        "wasProcessed": true
    }
}

Void

Create void

POST/void

You can run a Void when you need to cancel a sale that has not been settled yet or an authOnly. To void a sale you need to provide the SaleGuid or SaleReferenceNumber that you received when you ran the Sale. To void an authOnly you need to provide the AuthOnlyGuid or AuthOnlyReferenceNumber that you received when you ran the authOnly.

This endpoint creates a void.

Note: Send either SaleGuid, SaleReferenceNumber, AuthOnlyGuid or AuthOnlyReferenceNumber field in a request.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device’s Guid.
SaleGuid	string	Conditional	Sale’s Guid. Mandatory when SaleReferenceNumber, AuthOnlyGuid and AuthOnlyReferenceNumber field are not sent.
SaleReferenceNumber	integer	Conditional	SaleReferenceNumber. Mandatory when SaleGuid, AuthOnlyGuid and AuthOnlyReferenceNumber field are not sent.
AuthOnlyGuid	string	Conditional	AuthOnlyGuid’s Guid. Mandatory when SaleGuid, SaleReferenceNumber and AuthOnlyReferenceNumber field are not sent.
AuthOnlyReferenceNumber	integer	Conditional	AuthOnlyReferenceNumber. Mandatory when SaleGuid, SaleReferenceNumber and AuthOnlyGuid field are not sent.
VoidReason	string	Optional	Indicates the reason the transaction was voided. Allowed values: 1. POST_AUTH_USER_DECLINE 2. DEVICE_TIMEOUT 3. DEVICE_UNAVAILABLE 4. PARTIAL_REVERSAL 5. POST_AUTH_CHIP_DECLINE

Request

curl -X POST https://apisandbox.surepay.co/api/v1/void \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "4b5013f7-b275-4929-8e83-0167c6edf639",
  "SaleGuid": "c5ac2017-99cb-4b1f-a90e-142cc82b21e5",
  "VoidReason": "DEVICE_TIMEOUT"
}'

{
  "DeviceGuid" : "4b5013f7-b275-4929-8e83-0167c6edf639",
  "SaleGuid": "c5ac2017-99cb-4b1f-a90e-142cc82b21e5",
  "VoidReason": "DEVICE_TIMEOUT"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Void
    {
        public static void CreateVoid()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/void");
                request.ContentType = "text/json";
                request.Method = "POST";

                var void1 = new
                {
                    DeviceGuid = "4b5013f7-b275-4929-8e83-0167c6edf639",
                    SaleGuid = "c5ac2017-99cb-4b1f-a90e-142cc82b21e5",
                    VoidReason = "DEVICE_TIMEOUT"
                };

                string json = JsonConvert.SerializeObject(void1);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "7a4ef786-8288-404d-9340-e837d06784af",
    "batchStatus": "Batch - Open",
    "timeStamp": "2017-07-11T11:05:46.31",
    "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
    "saleGuid": "bfff1a26-4207-4871-9597-48282e3fcfea",
    "status": "Transaction - Approved",
    "voidReason": "DEVICE_TIMEOUT",
    "processorStatusCode": "A0000",
    "wasProcessed": true,
    "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
    "authCode": "VTLMC1",
    "refNumber": "13283644",
    "invoiceNumber": "11518",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 07:05:50\\n\\nCREDIT - VOID\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283644\\nInvoice number : 11518\\n\\nVoid Amount:                    $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
    "sale": {
        "guid": "bfff1a26-4207-4871-9597-48282e3fcfea",
        "status": "Transaction - Approved",
        "batchStatus": "Batch - Open",
        "timeStamp": "2017-07-11T11:05:24.65",
        "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
        "amount": 19.74,
        "effectiveAmount": 0,
        "orderNumber": "11518",
        "orderDate": "2017-02-03T00:00:00",
        "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
        "processorStatusCode": "A0000",
        "processorResponseMessage": "Success",
        "wasProcessed": true,
        "authCode": "VTLMC1",
        "refNumber": "13283644",
        "invoiceNumber": "11518",
        "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 07:05:27\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283644\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $19.74\\n--------------------------------------\\nTotal:                          $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
        "customData": "order details",
        "card": {
            "first4": "5306",
            "last4": "0213",
            "cardNumber": "1zcGT7J4pkGh0213",
            "cardHolderName": "John Doe",
            "expirationDate": "2019-07",
            "customer": {
                "guid": "d1cf828d-3050-4e4c-b7cf-f4038d114d39",
                "firstName": "John",
                "lastName": "Doe",
                "phone": "9177563007",
                "city": "New York",
                "country": "US",
                "email": "johnd@mailinator.com",
                "zip": "10007",
                "address1": "107 7th Av.",
                "address2": "",
                "state": "NY",
                "dateOfBirth": "1987-07-07T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        }
    }
}

Get void

GET/void/<guid>

This endpoint gets a void.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Void’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/void/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Void
    {
        public static void GetVoid()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/void/7a4ef786-8288-404d-9340-e837d06784af");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "7a4ef786-8288-404d-9340-e837d06784af",
    "batchStatus": "Batch - Open",
    "timeStamp": "2017-07-11T11:05:46.31",
    "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
    "saleGuid": "bfff1a26-4207-4871-9597-48282e3fcfea",
    "status": "Transaction - Approved",
    "voidReason": "DEVICE_TIMEOUT",
    "processorStatusCode": "A0000",
    "wasProcessed": true,
    "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
    "authCode": "VTLMC1",
    "refNumber": "13283644",
    "invoiceNumber": "11518",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 07:05:50\\n\\nCREDIT - VOID\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283644\\nInvoice number : 11518\\n\\nVoid Amount:                    $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
    "sale": {
        "guid": "bfff1a26-4207-4871-9597-48282e3fcfea",
        "status": "Transaction - Approved",
        "batchStatus": "Batch - Open",
        "timeStamp": "2017-07-11T11:05:24.65",
        "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
        "amount": 19.74,
        "effectiveAmount": 0,
        "orderNumber": "11518",
        "orderDate": "2017-02-03T00:00:00",
        "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
        "processorStatusCode": "A0000",
        "processorResponseMessage": "Success",
        "wasProcessed": true,
        "authCode": "VTLMC1",
        "refNumber": "13283644",
        "invoiceNumber": "11518",
        "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 07:05:27\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283644\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $19.74\\n--------------------------------------\\nTotal:                          $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
        "customData": "order details",
        "card": {
            "first4": "5306",
            "last4": "0213",
            "cardNumber": "1zcGT7J4pkGh0213",
            "cardHolderName": "John Doe",
            "expirationDate": "2019-07",
            "customer": {
                "guid": "d1cf828d-3050-4e4c-b7cf-f4038d114d39",
                "firstName": "John",
                "lastName": "Doe",
                "phone": "9177563007",
                "city": "New York",
                "country": "US",
                "email": "johnd@mailinator.com",
                "zip": "10007",
                "address1": "107 7th Av.",
                "address2": "",
                "state": "NY",
                "dateOfBirth": "1987-07-07T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        }
    }
}

Return

Create return

POST/returns

You can run a Return transaction when you need to refund either a partial or the full amount of a sale that has been settled. The Return amount doesn’t need to be the same as the total amount originally charged in the sale. To refund a sale you need to provide the SaleGuid or SaleReferenceNumber that you received when you ran the Sale.

This endpoint creates a return.

Note: Send either SaleGuid or SaleReferenceNumber field in a request.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device’s Guid.
SaleGuid	string	Conditional	Sale’s Guid. Mandatory when SaleReferenceNumber field is not sent.
SaleReferenceNumber	integer	Conditional	SaleReferenceNumber. Mandatory when SaleGuid field is not sent.
Amount	decimal	Mandatory	Transaction's amount. Min. amt.: $0.50
StatementDescription	string	Optional	Custom description to be displayed on the card holder statement.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/returns \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "4b5013f7-b275-4929-8e83-0167c6edf639",
  "SaleGuid": "41881e9c-f238-4ff7-8cba-3684bbb8bada",
  "Amount": 19.74
}'

{
  "DeviceGuid" : "4b5013f7-b275-4929-8e83-0167c6edf639",
  "SaleGuid": "41881e9c-f238-4ff7-8cba-3684bbb8bada",
  "Amount": 19.74
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Return
    {
        public static void CreateReturn()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/returns");
                request.ContentType = "text/json";
                request.Method = "POST";

                var returns = new
                {
                    DeviceGuid = "4b5013f7-b275-4929-8e83-0167c6edf639",
                    SaleGuid = "41881e9c-f238-4ff7-8cba-3684bbb8bada",
                    Amount = "19.74"
                };

                string json = JsonConvert.SerializeObject(returns);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "4f31b350-edd1-49fd-a1ad-4b065f78d7b9",
    "batchStatus": "Batch - Open",
    "timeStamp": "2017-07-11T11:10:38.11",
    "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
    "saleGuid": "ded98ad3-0553-4607-b84c-1bbd85f474d5",
    "status": "Transaction - Approved",
    "amount": 19.74,
    "batchGuid": "450463e0-5050-4c33-8c2f-4e39a2dd8614",
    "processorStatusCode": "A0014",
    "wasProcessed": true,
    "authCode": "VTLMC1",
    "refNumber": "13283670",
    "invoiceNumber": "11518",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 07:10:42\\n\\nCREDIT - VOID\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283670\\nInvoice number : 11518\\n\\nVoid Amount:                    $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
    "sale": {
        "guid": "ded98ad3-0553-4607-b84c-1bbd85f474d5",
        "status": "Transaction - Approved",
        "batchStatus": "Batch - Closed",
        "timeStamp": "2017-07-11T11:09:53.5",
        "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
        "amount": 19.74,
        "effectiveAmount": 0,
        "orderNumber": "11518",
        "orderDate": "2017-02-03T00:00:00",
        "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
        "processorStatusCode": "A0000",
        "processorResponseMessage": "Success",
        "wasProcessed": true,
        "authCode": "VTLMC1",
        "refNumber": "13283670",
        "invoiceNumber": "11518",
        "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 07:09:56\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283670\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $19.74\\n--------------------------------------\\nTotal:                          $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
        "customData": "order details",
        "card": {
            "first4": "5306",
            "last4": "0213",
            "cardNumber": "1zcGT7J4pkGh0213",
            "cardHolderName": "John Doe",
            "expirationDate": "2019-07",
            "customer": {
                "guid": "d1cf828d-3050-4e4c-b7cf-f4038d114d39",
                "firstName": "John",
                "lastName": "Doe",
                "phone": "9177563007",
                "city": "New York",
                "country": "US",
                "email": "johnd@mailinator.com",
                "zip": "10007",
                "address1": "107 7th Av.",
                "address2": "",
                "state": "NY",
                "dateOfBirth": "1987-07-07T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        }
    }
}

Create return without reference

POST/returns

This endpoint creates a return.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device’s Guid.
Amount	decimal	Mandatory	Transaction's amount. Min. amt.: $0.50
Card	object	Mandatory	See Card.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/returns \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "DeviceGuid" : "4b5013f7-b275-4929-8e83-0167c6edf639",
    "Amount": 19.74,
    "Card": {
        "CardNumber" : "5175526161474418",
        "CardHolderName" : "John Doe",
        "Cvv2" : "998",
        "ExpirationDate" : "2312",
    }
}'

{
    "DeviceGuid" : "4b5013f7-b275-4929-8e83-0167c6edf639",
    "Amount": 19.74,
    "Card": {
        "CardNumber" : "5175526161474418",
        "CardHolderName" : "John Doe",
        "Cvv2" : "998",
        "ExpirationDate" : "2312",
    }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurepaySample
{
    public class Return
    {
        public static void CreateReturnWithoutReference()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/returns");
                request.ContentType = "text/json";
                request.Method = "POST";

                var returns = new
                {
                    DeviceGuid = "4b5013f7-b275-4929-8e83-0167c6edf639",
                    Amount = "19.74",
                    Card = new
                    {
                        CardNumber = "5175526161474418",
                        CardHolderName = "John Doe",
                        Cvv2 = "998",
                        ExpirationDate = "2312"
                    }
                };

                string json = JsonConvert.SerializeObject(returns);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "58f6fd1f-6b20-4daa-8059-4a0986f67787",
    "batchStatus": "Batch - Open",
    "timeStamp": "11/14/2023 12:27:45 PM",
    "deviceGuid": "4b5013f7-b275-4929-8e83-0167c6edf639",
    "status": "Transaction - Approved",
    "amount": 19.74,
    "batchGuid": "1c90754e-dd20-4157-ba7e-2cff6e33f3d7",
    "processorStatusCode": "A0000",
    "wasProcessed": true,
    "authCode": "TAS348",
    "refNumber": "39349491",
    "invoiceNumber": "39349491",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DR\\nTEMPE AZ 85284\\n11/14/2023 05:27:46\\n\\nCREDIT - RETURN\\n\\nCARD # : **** **** **** 5511\\nCARD TYPE : VISA\\nEntry Mode : MANUAL\\n\\nTRANSACTION ID : 39349491\\nInvoice number : 39349491\\nAUTH CODE : TAS348\\nReturn Amount:                  $19.74\\n--------------------------------------\\n\\n\\n\\n\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n\\n",
    "card": {
        "first6": "517552",
        "last4": "4418",
        "cardNumber": "CARD NOT TOKENIZED",
        "cardType": "Visa",
        "expirationDate": "2023-12"
    }
}

Get return

GET/returns/<guid>

This endpoint gets a return.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Return’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/returns/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Return
    {
        public static void GetReturn()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/returns/4f31b350-edd1-49fd-a1ad-4b065f78d7b9");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "4f31b350-edd1-49fd-a1ad-4b065f78d7b9",
    "batchStatus": "Batch - Open",
    "timeStamp": "2017-07-11T11:10:38.11",
    "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
    "saleGuid": "ded98ad3-0553-4607-b84c-1bbd85f474d5",
    "status": "Transaction - Approved",
    "amount": 19.74,
    "batchGuid": "450463e0-5050-4c33-8c2f-4e39a2dd8614",
    "processorStatusCode": "A0014",
    "wasProcessed": true,
    "authCode": "VTLMC1",
    "refNumber": "13283670",
    "invoiceNumber": "11518",
    "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 07:10:42\\n\\nCREDIT - VOID\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283670\\nInvoice number : 11518\\n\\nVoid Amount:                    $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
    "sale": {
        "guid": "ded98ad3-0553-4607-b84c-1bbd85f474d5",
        "status": "Transaction - Approved",
        "batchStatus": "Batch - Closed",
        "timeStamp": "2017-07-11T11:09:53.5",
        "deviceGuid": "8f65764d-72c1-4dee-ac9f-4cd4c98e8c35",
        "amount": 19.74,
        "effectiveAmount": 0,
        "orderNumber": "11518",
        "orderDate": "2017-02-03T00:00:00",
        "batchGuid": "1564cb1b-eddb-4747-9565-61a7d7d225f9",
        "processorStatusCode": "A0000",
        "processorResponseMessage": "Success",
        "wasProcessed": true,
        "authCode": "VTLMC1",
        "refNumber": "13283670",
        "invoiceNumber": "11518",
        "customerReceipt": "SUR TECHNOLOGY HOLDINGS\\n8320 S HARDY DRIVE\\nTEMPE AZ 85284\\n07/11/2017 07:09:56\\n\\nCREDIT - SALE\\n\\nCARD # : **** **** **** 0213\\nCARD TYPE :MASTERCARD\\nEntry Mode : MANUAL\\n\\nREF # : 13283670\\nInvoice number : 11518\\nAUTH CODE : VTLMC1\\nSubtotal:                       $19.74\\n--------------------------------------\\nTotal:                          $19.74\\n--------------------------------------\\n\\n\\n\\nJohn Doe\\n\\nCUSTOMER ACKNOWLEDGES RECEIPT OF\\nGOODS AND/OR SERVICES IN THE AMOUNT\\nOF THE TOTAL SHOWN HEREON AND AGREES\\nTO PERFORM THE OBLIGATIONS SET FORTH\\nBY THE CUSTOMER`S AGREEMENT WITH THE\\nISSUER\\nAPPROVED\\n\\n\\n\\n\\nCustomer Copy\\n",
        "customData": "order details",
        "card": {
            "first4": "5306",
            "last4": "0213",
            "cardNumber": "1zcGT7J4pkGh0213",
            "cardHolderName": "John Doe",
            "expirationDate": "2019-07",
            "customer": {
                "guid": "d1cf828d-3050-4e4c-b7cf-f4038d114d39",
                "firstName": "John",
                "lastName": "Doe",
                "phone": "9177563007",
                "city": "New York",
                "country": "US",
                "email": "johnd@mailinator.com",
                "zip": "10007",
                "address1": "107 7th Av.",
                "address2": "",
                "state": "NY",
                "dateOfBirth": "1987-07-07T00:00:00",
                "driverLicenseNumber": "12345678",
                "driverLicenseState": "TX",
                "ssN4": "1210"
            }
        }
    }
}

Verify

Create verify

POST/Verify

The Verify transaction is used when you want to know if the card data you have is valid and it’s ready to run other transactions like Auth Only or Sale. Therefore we are talking about a $0.00 amount transaction, no money is moved.

This endpoint creates a verify.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device’s Guid.
—	—	—	—
Card	—	—	—
CardNumber	string	Mandatory	Card number. Must be 16 characters. (example: 4532538795426624).
CardHolderName	string	Optional	Cardholder's name.
Cvv2	integer	Mandatory	This is the three or four digit CVV code at the back side of the credit and debit card.
ExpirationDate	date	Mandatory	Card's expiry date in the YYMM format.
Customer	object	Mandatory	Customer.
—	—	—	—
Customer	—	—	—
Address1	string	Mandatory	Customer's address.
City	string	Mandatory	Customer's city.
State	string	Mandatory	Customer's short name state. The ISO 3166-2 CA and US state or province code of a customer. Length = 2.
Zip	integer	Mandatory	Customer's zipcode. Length = 5.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Verify \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "8257dde1-ded6-4c38-ab71-4338c4aa87ac",
  "Card":
  {
    "CardNumber" : "4111111111111111",
    "Cvv2" : "999",
    "ExpirationDate" : "1912",
    "Customer":
    {
      "City" : "New York",
      "State" : "NY",
      "Address1" : "111 11th Av.",
      "Zip" : "10011"
    }
  }
}'

{
  "DeviceGuid" : "8257dde1-ded6-4c38-ab71-4338c4aa87ac",
  "Card":
  {
    "CardNumber" : "4111111111111111",
    "Cvv2" : "999",
    "ExpirationDate" : "1912",
    "Customer":
    {
      "City" : "New York",
      "State" : "NY",
      "Address1" : "111 11th Av.",
      "Zip" : "10011"
    }
  }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Verify
    {
        public static void CreateVerify()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Verify");
                request.ContentType = "text/json";
                request.Method = "POST";

                var verify = new
                {
                    DeviceGuid = "fde63679-0c47-4a9c-9b47-82cdf1929851",
                    Card = new
                    {
                        CardNumber = "4111111111111111",
                        Cvv2 = "999",
                        ExpirationDate = "1912",
                        Customer = new
                        {
                            City = "New York",
                            State = "NY",
                            Address1 = "111 11th Av.",
                            Zip = "10011"
                        }
                    }
                };

                string json = JsonConvert.SerializeObject(verify);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "84c42030-40bd-4110-a928-84ece487d0e9",
    "status": "Transaction - Approved",
    "timeStamp": "2025-08-19T16:55:51.52",
    "deviceGuid": "8257dde1-ded6-4c38-ab71-4338c4aa87ac",
    "card": {
        "guid": "277b9710-8966-4d4c-b21c-74c982aeb32a",
        "first6": "411111",
        "last4": "1111",
        "cardNumber": "HdW4xmthd8iY1111",
        "cardType": "Visa",
        "expirationDate": "2030-12",
        "customer": {
            "guid": "2fe25eb3-a719-4643-93e2-ad3283ffea01",
            "address1": "111 11th Av.",
            "zip": "10016",
            "city": "New York",
            "state" : "NY"
        },
        "token": "HdW4xmthd8iY1111"
    },
    "cardDataSource": "INTERNET",
    "processorStatusCode": "A0000",
    "wasProcessed": true,
    "addressVerificationCode": "N",
    "cvvVerificationCode": "M",
    "addressVerificationResult": "No Match",
    "cvvVerificationResult": "Passed"
}

Get verify

GET/Verify/<guid>

This endpoint gets a verify.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Verify’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/Verify/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Verify
    {
        public static void GetVerify()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Verify/f1565d71-54c2-410e-a672-29aa28316b7d");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }

    }
}

Response

{
    "guid": "f1565d71-54c2-410e-a672-29aa28316b7d",
    "status": "Transaction - Approved",
    "timeStamp": "2017-07-03T14:08:15.53",
    "deviceGuid": "4b5013f7-b275-4929-8e83-0167c6edf639",
    "card": {
        "first4": "4532",
        "last4": "7402",
        "cardNumber": "hNDbeGr7VBgY7402",
        "cardHolderName": "Justin Troudeau",
        "expirationDate": "2019-12",
        "customer": {
            "guid": "97c01573-3736-4755-bbcf-de9da8e9391d",
            "firstName": "Justin",
            "lastName": "Troudeau",
            "phone": "9177563051",
            "city": "New York",
            "country": "US",
            "email": "justint@mailinator.com",
            "zip": "10011",
            "address1": "111 11th Av.",
            "address2": "",
            "state": "NY",
            "dateOfBirth": "1991-11-11T00:00:00",
            "driverLicenseNumber": "12345678",
            "driverLicenseState": "TX",
            "ssN4": "1210"
        }
    },
    "processorStatusCode": "A0000",
    "wasProcessed": true
}

Tokenization

Create tokenization Credit Card

POST/tokenization

The Tokenization service is used when you want to obtain a tokenized value of the card number but no validation to be performed at the issuing bank.

This endpoint creates a tokenization.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device’s Guid.
Card	—	—	—
CardNumber	string	Mandatory	Card number. Must be 16 characters. (example: 4532538795426624).
ExpirationDate	date	Mandatory	Card's expiry date in the YYMM format.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/tokenization \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "DeviceGuid": "F050E264-EABF-433E-8C81-916DFE110159",
    "Card": {
        "CardNumber": "4024007194311436",
        "ExpirationDate": "2507"
    }
}'

{
    "DeviceGuid": "F050E264-EABF-433E-8C81-916DFE110159",
    "Card": {
        "CardNumber": "4024007194311436",
        "ExpirationDate": "2507"
    }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Tokenization
    {
        public static void CreateTokenization()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/tokenization");
                request.ContentType = "text/json";
                request.Method = "POST";

                var tokenization = new
                {
                    DeviceGuid = "F050E264-EABF-433E-8C81-916DFE110159",
                    Card = new
                    {
                        CardNumber = "4024007194311436",
                        ExpirationDate = "2507"
                    }
                };

                string json = JsonConvert.SerializeObject(tokenization);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "a2b8842a-a248-4759-ad71-9607a472e7cc",
    "status": "Transaction - Approved",
    "timeStamp": "2021-07-16T15:36:07.31",
    "deviceGuid": "F050E264-EABF-433E-8C81-916DFE110159",
    "cardDataSource": "INTERNET",
    "processorStatusCode": "A0000",
    "card": {
        "first6": "402400",
        "last4": "1436",
        "cardNumber": "XR6ngXrNGdD31436",
        "expirationDate": "2025-07"
    }
}

Create tokenization Bank Account

POST/tokenization

The Tokenization service is used when you want to obtain a tokenized value of the bank account.

This endpoint creates a tokenization.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device’s Guid.
Bank Account	—	—	—
RoutingNumber	integer	Mandatory	Routing's number. Must be 9 characters (example: 490000018).
AccountNumber	integer	Mandatory	Account's number.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/tokenization \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "DeviceGuid": "F050E264-EABF-433E-8C81-916DFE110159",
    "BankAccount": {
        "RoutingNumber": "490000018",
        "AccountNumber": "441142020",
        "NameOnAccount": "John Doe"
    }
}'

{
    "DeviceGuid": "F050E264-EABF-433E-8C81-916DFE110159",
    "BankAccount": {
        "RoutingNumber": "490000018",
        "AccountNumber": "441142020",
        "NameOnAccount": "John Doe"
    }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Tokenization
    {
        public static void CreateTokenization()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/tokenization");
                request.ContentType = "text/json";
                request.Method = "POST";

                var tokenization = new
                {
                    DeviceGuid = "F050E264-EABF-433E-8C81-916DFE110159",
                    BankAccount = new
                    {
                        RoutingNumber = "490000018",
                        AccountNumber = "441142020",
                        NameOnAccount = "John Doe"
                    }
                };

                string json = JsonConvert.SerializeObject(tokenization);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
    "guid": "a2b8842a-a248-4759-ad71-9607a472e7cc",
    "status": "Transaction - Approved",
    "timeStamp": "2021-07-16T15:36:07.31",
    "deviceGuid": "F050E264-EABF-433E-8C81-916DFE110159",
    "bankAccount": {
        "routingNumber": "490000018",
        "accountType": "Checking",
        "nameOnAccount": "John Doe",
        "token": "0021c0089f39b8f644ff90ee82b1bd61831b7890"
    }
}

Recurring Billing

Create recurring billing

POST/recurringBillings

Recurring billing is a great feature you can use when you want to charge a card or debit from a bank account every a determined period of time. Period can be daily, weekly, biweekly, monthly, yearly, etc. Check the fields to know how to work with each of them.

This endpoint creates a recurring billing.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

You will get updates by e-mail regarding Recurring Billing status.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Optional	Device's Guid. Mandatory when providing a CreditCard or a BankAccount. Not required when providing an InvoiceGuid.
InvoiceGuid	string	Optional	The Guid of the Invoice you want to make recurring. Do not send amount, nor Card neither Bank Account in this case.
Amount	decimal	Optional	Transaction's amount. Min. amt.: $0.50. Mandatory when amount is fixed.
Interval	string	Mandatory	Recurring billing interval. A customer can schedule the recurring payment at a desired interval. Allowed values: 1. yearly 2. halfYearly 3. quarterly 4. monthly 5. fortnightly 6. weekly 7. biweekly 8. daily 9. CustomDates 10. each1st 11. each15th 12. 1st15th
IntervalValue	string	Mandatory for monthly, weekly and custom dates modes	Allowed values: 1.For the yearly, halfYearly , quarterly, fortnightly, biweekly and daily mode, does not need to enter IntervalValue, since they do not have. 2.For the monthly mode, select everyMonth or the months of the year. Example: "Interval" : "monthly", "IntervalValue" : "april, may, june". 3.For weekly mode, select everyWeek or the days of the week. Example: "Interval" : "weekly", "IntervalValue" : "monday, tuesday, wednesday". 4.For CustomDates mode, select a list of dates (yyyy-MM-dd) separated by commas. Example: "Interval" : "CustomDates", "IntervalValue" : "2017-03-12, 2017-04-06, 2017-05-17, 2017-06-12".
SubIntervalValue	string	Mandatory for monthly	Allowed values: 1.Any day of the month.
StartDate	date	Mandatory	The first payment date of the recurring billing schedule. Allowed Recurring Billing format: YYYY-MM-DD For example: 2002-05-30
EndDate	date	Mandatory when payment count is not submitted	The last payment date of the recurring billing schedule. Allowed Recurring Billing format: YYYY-MM-DD For example: 2002-05-30 Note: Send either EndDate or PaymentCount field in a request.
PaymentCount	integer	Mandatory when end date is not submitted	The count of payments in a recurring schedule payment, set by a customer. Note: Send either PaymentCount or EndDate field in a request.
ScheduleNotes	string	Optional	This field provides a place for the user to identify the reason they added or modified the recurring schedule.
Description	string	Optional	General description about the recurring billing.
DynamicAmount	boolean	Optional	Mandatory and true when providing a merchant product list guid. Not compatible with enhanced data.
MerchantProductListGuid	string	Optional	MerchantProductList's Guid. Mandatory when providing a dynamic amount.
SendReceipt	boolean	Optional	Set to “FALSE” if you do not want an e-mail receipt to be sent to the customer. Set to “TRUE” or leave empty if you want e-mail to be sent.
Card	object	Mandatory	See Card. Note: Send either Card or BankAccount object in a request.
BankAccount	object	Mandatory	See BankAccount. Note: Send either Card or BankAccount object in a request.
EnhancedData	object	Optional	See EnhancedData.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/recurringBillings \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "8257dde1-ded6-4c38-ab71-4338c4aa87ac",
  "Amount" : 10.50,
  "Interval" : "monthly",
  "IntervalValue" : "april, may, june",
  "StartDate" : "2017-05-13",
  "EndDate" : "2019-04-01",
  "PaymentCount" : "",
  "ScheduleNotes" : "Cable",
  "Description" : "Description",
  "Card":
  {
    "CardNumber" : "4556395004716019",
    "CardHolderName" : "John Doe",
    "Cvv2" : "999",
    "ExpirationDate" : "1710",
    "Customer":
    {
      "FirstName" : "John",
      "LastName" : "Doe",
      "Phone" : "9865123654",
      "City" : "New York",
      "State" : "NY",
      "Country" : "US",
      "Email" : "johndoe@mailinator.com",
      "Address1" : "12th Ave. 5472",
      "Address2" : "",
      "Zip" : "10003",
      "DateOfBirth" : "1989-10-01T00:00:01.000Z",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  }
}'

{
  "DeviceGuid" : "8257dde1-ded6-4c38-ab71-4338c4aa87ac",
  "Amount" : 10.50,
  "Interval" : "monthly",
  "IntervalValue" : "april, may, june",
  "StartDate" : "2017-05-13",
  "EndDate" : "2019-04-01",
  "PaymentCount" : "",
  "ScheduleNotes" : "Cable",
  "Description" : "Description",
  "Card":
  {
    "CardNumber" : "4556395004716019",
    "CardHolderName" : "John Doe",
    "Cvv2" : "999",
    "ExpirationDate" : "1710",
    "Customer":
    {
      "FirstName" : "John",
      "LastName" : "Doe",
      "Phone" : "9865123654",
      "City" : "New York",
      "State" : "NY",
      "Country" : "US",
      "Email" : "johndoe@mailinator.com",
      "Address1" : "12th Ave. 5472",
      "Address2" : "",
      "Zip" : "10003",
      "DateOfBirth" : "1989-10-01T00:00:01.000Z",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class RecurringBilling
    {
        public static void CreateRecurringBilling()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/recurringBillings");
                request.ContentType = "text/json";
                request.Method = "POST";

                var recurringBilling = new
                {
                    DeviceGuid = "8257dde1-ded6-4c38-ab71-4338c4aa87ac",
                    Amount = "10.50",
                    Interval = "monthly",
                    IntervalValue = "april, may, june",
                    StartDate = "2017-05-13T00:00:01.000Z",
                    EndDate = "2019-04-01T00:00:01.000Z",
                    PaymentCount = "",
                    ScheduleNotes = "Cable",
                    Description = "Description",
                    Card = new
                    {
                        CardNumber = "4556395004716019",
                        CardHolderName = "John Doe",
                        Cvv2 = "999",
                        ExpirationDate = "1710",
                        Customer = new
                        {
                            FirstName = "John",
                            LastName = "Doe",
                            Phone = "9865123654",
                            City = "New York",
                            State = "NY",
                            Country = "US",
                            Email = "johnd@mailinator.com",
                            Address1 = "12th Ave. 5472",
                            Address2 = "",
                            Zip = "10003",
                            DateOfBirth = "1989-10-01T00:00:01.000Z",
                            DriverLicenseNumber = "12345678",
                            DriverLicenseState = "TX",
                            SSN4 = "1210"
                        }
                    }
                };

                string json = JsonConvert.SerializeObject(recurringBilling);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Con

Response

{
  "guid": "d1507904-f84c-4508-98ef-5f0fcc417019",
  "deviceGuid": "75f97793-430b-4e94-9aec-383950639b18",
  "status": "RecurringBilling -  Active",
  "interval": "monthly",
  "intervalValue": "april, may, june",
  "amount": 10.5,
  "recurringBillingNumber": "14339150",
  "startDate": "2017-05-13T00:00:00",
  "endDate": "2019-04-01T00:00:00",
  "scheduleNotes": "Cable",
  "description" : "Description",
  "processorStatusCode": "OK",
  "processorResponseMessage": "Recurring billing scheduled. Payment count: 5. First payment: Saturday, May 13, 2017. Last payment: Wednesday, June 13, 2018",
  "wasProcessed": true,
  "card": {
    "first4": "4556",
    "last4": "6019",
    "cardNumber": "7hEtLJIhooTE6019",
    "cardHolderName": "John Doe",
    "expirationDate": "2017-10",
    "customer": {
      "guid": "d0912636-4fc1-48a4-b002-aa39a9df1288",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "9865123654",
      "city": "New York",
      "country": "US",
      "email": "johndoe@mailinator.com",
      "zip": "10003",
      "address1": "12th Ave. 5472",
      "address2": "",
      "state": "NY",
      "dateOfBirth": "1989-10-01T00:00:00",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  },
  "scheduleAndPayments": [
    {
      "scheduledPaymentDate": "2017-05-13T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Saturday",
      "scheduledPaymentNumber": 1,
      "scheduledWasProcessed": false
    },
    {
      "scheduledPaymentDate": "2017-06-13T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Tuesday",
      "scheduledPaymentNumber": 2,
      "scheduledWasProcessed": false
    },
    {
      "scheduledPaymentDate": "2018-04-13T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Friday",
      "scheduledPaymentNumber": 3,
      "scheduledWasProcessed": false
    },
    {
      "scheduledPaymentDate": "2018-05-13T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Sunday",
      "scheduledPaymentNumber": 4,
      "scheduledWasProcessed": false
    },
    {
      "scheduledPaymentDate": "2018-06-13T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Wednesday",
      "scheduledPaymentNumber": 5,
      "scheduledWasProcessed": false
    }
  ]
}

Update recurring billing

PUT/recurringBillings<guid>

This endpoint updates a recurring billing.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Recurring billings’s guid to update

Query Parameters

Parameter	Type	M/C/O	Value
Amount	decimal	Optional	Transaction's amount. Min. amt.: $0.50
Interval	string	Optional	Recurring billing interval. A customer can schedule the recurring payment at a desired interval. Allowed values: 1. yearly 2. halfYearly 3. quarterly 4. monthly 5. fortnightly 6. weekly 7. biweekly 8. daily 9. CustomDates 10. each1st 11. each15th 12. 1st15th
IntervalValue	string	Optional	Allowed values: 1.For the yearly, halfYearly , quarterly, fortnightly, biweekly and daily mode, does not need to enter IntervalValue, since they do not have. 2.For the monthly mode, select everyMonth or the months of the year. Example: "Interval" : "monthly", "IntervalValue" : "april, may, june". 3.For weekly mode, select everyWeek or the days of the week. Example: "Interval" : "weekly", "IntervalValue" : "monday, tuesday, wednesday". 4.For CustomDates mode, select a list of dates (yyyy-MM-dd) separated by commas. Example: "Interval" : "CustomDates", "IntervalValue" : "2017-03-12, 2017-04-06, 2017-05-17, 2017-06-12".
SubIntervalValue	string	Mandatory for monthly	Allowed values: 1.Any day of the month.
StartDate	date	Optional	The first payment date of the recurring billing schedule. Allowed Recurring Billing format: YYYY-MM-DD For example: 2002-05-30
EndDate	date	Optional	The first payment date of the recurring billing schedule. Allowed Recurring Billing format: YYYY-MM-DD For example: 2002-05-30 Note: Send either EndDate or PaymentCount field in a request.
PaymentCount	integer	Optional	The count of payments in a recurring schedule payment, set by a customer. Note: Send either PaymentCount or EndDate field in a request.
ScheduleNotes	string	Optional	This field provides a place for the user to identify the reason they added or modified the recurring schedule.
Description	string	Optional	General description about the recurring billing.
SendReceipt	boolean	Optional	Set to “FALSE” if you do not want an e-mail receipt to be sent to the customer. Set to “TRUE” or leave empty if you want e-mail to be sent.
Status	string	Optional	Recurring billing status. Allowed values: 1. RecurringBilling - Active 2. RecurringBilling - Created - Local 3. RecurringBilling - Created - Error: Processor not reached 4. RecurringBilling - Created - Processor Fail 5. RecurringBilling - Deactivated 6. RecurringBilling - Paused 7. RecurringBilling - Finished 8. RecurringBilling - Deleted 9. RecurringBilling - Active Started

Request

curl -X PUT https://apisandbox.surepay.co/api/v1/recurringBillings<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "Amount" : 25.40,
  "Interval" : "monthly",
  "IntervalValue" : "january",
  "StartDate" : "2017-04-01T00:00:01.000Z",
  "EndDate" : "2018-06-01T00:00:01.000Z",
  "PaymentCount" : "",
  "ScheduleNotes" : "Cable",
  "Description" : "Description",
  "Status" : "RecurringBilling -  Active"
}'

{
  "Amount" : 25.40,
  "Interval" : "monthly",
  "IntervalValue" : "january",
  "StartDate" : "2017-04-01T00:00:01.000Z",
  "EndDate" : "2018-06-01T00:00:01.000Z",
  "PaymentCount" : "",
  "ScheduleNotes" : "Cable",
  "Description" : "Description",
  "Status" : "RecurringBilling -  Active"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class RecurringBilling
    {
        public static void UpdateRecurringBilling()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/recurringBillings/1de7a995-6e4d-4726-afb3-c9972b9b150a");
                request.ContentType = "text/json";
                request.Method = "PUT";

                var recurringBilling = new
                {
                    Amount = "25.40",
                    Interval = "monthly",
                    IntervalValue = "january",
                    StartDate = "2017-04-01T00:00:01.000Z",
                    EndDate = "2018-06-01T00:00:01.000Z",
                    PaymentCount = "",
                    ScheduleNotes = "Cable",
                    Description = "Description",
                    Status = "RecurringBilling -  Active"
                };

                string json = JsonConvert.SerializeObject(recurringBilling);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
  "guid": "1de7a995-6e4d-4726-afb3-c9972b9b150a",
  "deviceGuid": "8257dde1-ded6-4c38-ab71-4338c4aa87ac",
  "status": "RecurringBilling -  Active",
  "interval": "monthly",
  "intervalValue": "january",
  "amount": 25.4,
  "recurringBillingNumber": "99851606",
  "startDate": "2017-04-01T00:00:01",
  "endDate": "2018-06-01T00:00:01",
  "scheduleNotes": "Cable",
  "description" : "Description",
  "processorStatusCode": "OK",
  "processorResponseMessage": "Recurring billing re-scheduled. Payment count: 1. First payment: Monday, January 1, 2018. Last payment: Monday, January 1, 2018",
  "wasProcessed": true,
  "card": {
    "first4": "4556",
    "last4": "6019",
    "cardNumber": "7hEtLJIhooTE6019",
    "cardHolderName": "John Doe",
    "expirationDate": "2017-10",
    "customer": {
      "guid": "d0912636-4fc1-48a4-b002-aa39a9df1288",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "9865123654",
      "city": "New York",
      "country": "US",
      "email": "johndoe@mailinator.com",
      "zip": "10003",
      "address1": "12th Ave. 5472",
      "address2": "",
      "state": "NY",
      "dateOfBirth": "1989-10-01T00:00:00",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  },
  "scheduleAndPayments": [
    {
      "scheduledPaymentDate": "2018-01-01T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Monday",
      "scheduledPaymentNumber": 1,
      "scheduledWasProcessed": false
    }
  ]
}

Get recurring billing

GET/recurringBillings/<guid>

This endpoint gets a recurring billing.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Recurring billings’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/recurringBillings/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class RecurringBilling
    {
        public static void GetRecurringBilling()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/recurringBillings/1de7a995-6e4d-4726-afb3-c9972b9b150a");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
  "guid": "d1507904-f84c-4508-98ef-5f0fcc417019",
  "deviceGuid": "75f97793-430b-4e94-9aec-383950639b18",
  "status": "RecurringBilling -  Active",
  "interval": "monthly",
  "intervalValue": "april, may, june",
  "amount": 10.5,
  "recurringBillingNumber": "14339150",
  "startDate": "2017-05-13T00:00:00",
  "endDate": "2019-04-01T00:00:00",
  "scheduleNotes": "Cable",
  "description": "Description",
  "processorStatusCode": "OK",
  "processorResponseMessage": "Recurring billing scheduled. Payment count: 5. First payment: Saturday, May 13, 2017. Last payment: Wednesday, June 13, 2018",
  "wasProcessed": true,
  "card": {
    "first4": "4556",
    "last4": "6019",
    "cardNumber": "7hEtLJIhooTE6019",
    "cardHolderName": "John Doe",
    "expirationDate": "2017-10",
    "customer": {
      "guid": "d0912636-4fc1-48a4-b002-aa39a9df1288",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "9865123654",
      "city": "New York",
      "country": "US",
      "email": "johndoe@mailinator.com",
      "zip": "10003",
      "address1": "12th Ave. 5472",
      "address2": "",
      "state": "NY",
      "dateOfBirth": "1989-10-01T00:00:00",
      "DriverLicenseNumber" : "12345678",
      "DriverLicenseState" : "TX",
      "SSN4" : "1210"
    }
  },
  "scheduleAndPayments": [
    {
      "scheduledPaymentDate": "2017-05-13T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Saturday",
      "scheduledPaymentNumber": 1,
      "scheduledWasProcessed": false
    },
    {
      "scheduledPaymentDate": "2017-06-13T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Tuesday",
      "scheduledPaymentNumber": 2,
      "scheduledWasProcessed": false
    },
    {
      "scheduledPaymentDate": "2018-04-13T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Friday",
      "scheduledPaymentNumber": 3,
      "scheduledWasProcessed": false
    },
    {
      "scheduledPaymentDate": "2018-05-13T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Sunday",
      "scheduledPaymentNumber": 4,
      "scheduledWasProcessed": false
    },
    {
      "scheduledPaymentDate": "2018-06-13T00:00:00",
      "scheduledPaymentDateDayOfWeek": "Wednesday",
      "scheduledPaymentNumber": 5,
      "scheduledWasProcessed": false
    }
  ]
}

Batch

Close batch

POST/Batches/close

Batch is processing all the authorized transactions of the day at the end of the day. However, you can close a batch manually before. You can also get your transactions searched by batch.

This endpoint closes a batch.

Batch closing is mandatory, otherwise transactions are not settled.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceGuid	string	Mandatory	Device’s Guid.
SemiIntegrated	boolean	Optional	Only when physical terminal used on semi integrated mode, send value True.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Batches/close \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "DeviceGuid" : "8257dde1-ded6-4c38-ab71-4338c4aa87ac"
}'

{
  "DeviceGuid" : "8257dde1-ded6-4c38-ab71-4338c4aa87ac"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Batch
    {
        public static void CloseBatch()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Batches/close");
                request.ContentType = "text/json";
                request.Method = "POST";

                var batch = new
                {
                    DeviceGuid = "8257dde1-ded6-4c38-ab71-4338c4aa87ac"
                };

                string json = JsonConvert.SerializeObject(batch);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }
    }
}

Response

{
  "deviceGuid": "8257dde1-ded6-4c38-ab71-4338c4aa87ac",
  "guid": "8193db64-dc35-4cf8-b4a9-7e1d66aa119f",
  "status": "PASS",
  "responseCode": "A0000",
  "responseMessage": "Success",
  "closureDate": "2017-03-15T15:27:31.8987491-03:00",
  "batchInfo": {
    "siccode": "5999",
    "saleCount": 8,
    "saleAmount": 137.65,
    "returnCount": 0,
    "returnAmount": 0
  }
}

Search batches

POST/Batches/search

This endpoint searches batches in a date range.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
deviceGuid	string	Mandatory	Device's guid.
startDate	date	Mandatory	Search's start date. Allowed Recurring Billing format: YYYY-MM-DD For example: 2002-05-30
endDate	date	Mandatory	Search's end date. Allowed Recurring Billing format: YYYY-MM-DD For example: 2002-05-30

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Batches/search \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "deviceGuid" : "58ccf5a4-1d5d-4546-8202-da5c7ad10711",
  "startDate" : "1/1/1900",
  "endDate" : "12/31/2020"
}'

{
  "deviceGuid" : "58ccf5a4-1d5d-4546-8202-da5c7ad10711",
  "startDate" : "1/1/1900",
  "endDate" : "12/31/2020"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Batch
    {
        public static void SearchBatch()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Batches/search");
                request.ContentType = "text/json";
                request.Method = "POST";

                var batch = new
                {
                    deviceGuid = "58ccf5a4-1d5d-4546-8202-da5c7ad10711",
                    startDate = "1/1/1900",
                    endDate = "12/31/2020"
                };

                string json = JsonConvert.SerializeObject(batch);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }  
    }
}

Response

{
    "count": 2,
    "ret": [
        {
            "batchGuid": "58e8a0ad-d167-4015-a4b1-904b1e7f2b26",
            "batchNumber": "160635",
            "closureDate": "2020-11-25T08:39:56.86-06:00",
            "batchTotalAmount": 26.79,
            "userName": "maxduplessy",
            "summary": {
                "saleCount": 2,
                "saleAmount": 46.53,
                "returnCount": 1,
                "returnAmount": 19.74
            },
            "transactions": [
                {
                    "transactionType": "Return",
                    "transactionDatetime": "2020-11-25T07:17:24.15-06:00",
                    "lastFour": "0213",
                    "cardType": "Mastercard",
                    "amount": 19.74,
                    "processorResponseMessage": "Return requested, Void successful"
                },
                {
                    "transactionType": "Sale",
                    "transactionDatetime": "2020-11-25T07:29:06.97-06:00",
                    "lastFour": "8442",
                    "cardType": "Visa",
                    "amount": 25.04,
                    "processorResponseMessage": "Success"
                },
                {
                    "transactionType": "Sale",
                    "transactionDatetime": "2020-11-25T07:30:52.72-06:00",
                    "lastFour": "0213",
                    "cardType": "Mastercard",
                    "amount": 21.49,
                    "processorResponseMessage": "Success"
                }
            ]
        },
        {
            "batchGuid": "b8d73296-e397-45c0-bb43-ba064e9750ac",
            "batchNumber": "160634",
            "closureDate": "2020-11-25T07:16:27.09-06:00",
            "batchTotalAmount": 19.74,
            "userName": "maxduplessy",
            "summary": {
                "saleCount": 1,
                "saleAmount": 19.74,
                "returnCount": 0,
                "returnAmount": 0.00
            },
            "transactions": [
                {
                    "transactionType": "Sale",
                    "transactionDatetime": "2020-11-25T07:15:27.28-06:00",
                    "lastFour": "0213",
                    "cardType": "Mastercard",
                    "amount": 19.74,
                    "processorResponseMessage": "Success"
                }
            ]
        }
    ]
}

Get batches with transactions

GET/Batches/<guid>/Transactions/

This endpoint gets a batch with its transactions.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Batch’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/Batches/<guid>/Transactions/ \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Batch
    {
        public static void GetBatchsWithTransactions()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Batches/10b88d43-9f5b-4d9a-a1b3-0827e22f53e0/Transactions");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

[
    {
        "transactionType": "Return",
        "transactionDatetime": "2020-11-25T07:17:24.15-06:00",
        "lastFour": "0213",
        "cardType": "Mastercard",
        "amount": 19.74,
        "processorResponseMessage": "Return requested, Void successful",
        "userName": "maxduplessy"
    },
    {
        "transactionType": "Sale",
        "transactionDatetime": "2020-11-25T07:29:06.97-06:00",
        "lastFour": "8442",
        "cardType": "Visa",
        "amount": 25.04,
        "processorResponseMessage": "Success",
        "userName": "maxduplessy"
    },
    {
        "transactionType": "Sale",
        "transactionDatetime": "2020-11-25T07:30:52.72-06:00",
        "lastFour": "0213",
        "cardType": "Mastercard",
        "amount": 21.49,
        "processorResponseMessage": "Success",
        "userName": "maxduplessy"
    }
]

Customer

Create customer

POST/Customers

This endpoint creates a customer.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant’s Guid.
CustomerType	string	Mandatory	Customer Type. Allowed values: 1. Individual 2. Business
AccountNumber	string	Optional	Account Number.
CompanyName	string	Optional	Company Name.
FirstName	string	Mandatory	User’s first name.
LastName	string	Mandatory	User’s last name.
Address1	string	Optional	User’s address.
Address2	string	Optional	User’s address line 2.
City	string	Optional	User’s city.
State	string	Optional	User’s short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2.
Zip	integer	Optional	User’s zipcode. Length = 5.
Phone	integer	Optional	User’s phone number. The phone number must be syntactically correct. For example, 4152345678.
Email	string	Optional	User’s valid email address
PresetCustomerNotes	string	Optional	Preset Customer Notes.
PresetTermsAndConditions	string	Optional	Preset Terms And Conditions.
ShippingAddresses	object	Optional	Shipping Addresses.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Customers \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "8cc84666-3a4f-41df-b208-d371a90b8b66",
    "customerType": "Individual",
    "accountNumber": "123456789",
    "companyName": "Incutex",
    "firstName": "John",
    "lastName": "Doe",
    "address1": "108 8th Av.",
    "city": "New York",
    "state": "NY",
    "zip": "10016",
    "phone": "8987655434",
    "email": "JohnDoe@mailinator.com",
    "presetCustomerNotes": "New Customer Notes",
    "presetTermsAndConditions": "New Terms And Conditions",
    "shippingAddresses": [
        {
            "address1": "108 8th Av.",
            "city": "New York",
            "state": "NY",
            "zip": "10016"
        }
    ]
}'

{
    "merchantGuid": "8cc84666-3a4f-41df-b208-d371a90b8b66",
    "customerType": "Individual",
    "accountNumber": "123456789",
    "companyName": "Incutex",
    "firstName": "John",
    "lastName": "Doe",
    "address1": "108 8th Av.",
    "city": "New York",
    "state": "NY",
    "zip": "10016",
    "phone": "8987655434",
    "email": "JohnDoe@mailinator.com",
    "presetCustomerNotes": "New Customer Notes",
    "presetTermsAndConditions": "New Terms And Conditions",
    "shippingAddresses": [
        {
            "address1": "108 8th Av.",
            "city": "New York",
            "state": "NY",
            "zip": "10016"
        }
    ]
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurepaySample
{
    public class InvoiceCustomer
    {
        public static void CreateCustomer()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Customers");
                request.ContentType = "text/json";
                request.Method = "POST";

                var customer = new
                {
                    MerchantGuid = "8cc84666-3a4f-41df-b208-d371a90b8b66",
                    CustomerType = "Individual",
                    AccountNumber = "123456789",
                    CompanyName = "Incutex",
                    FirstName = "John",
                    LastName = "Doe",
                    Address1 = "108 8th Av.",
                    Zip = "10016",
                    City = "New York",
                    State = "NY",
                    Phone = "8987655434",
                    Email = "JohnDoe@mailinator.com",
                    PresetCustomerNotes = "New Customer Notes",
                    PresetTermsAndConditions = "New Terms And Conditions",
                    shippingAddresses = new
                    {
                        Address1 =  "108 8th Av.",
                        City =  "New York",
                        State =  "NY",
                        Zip =  "10016"
                    }
                };

                string json = JsonConvert.SerializeObject(customer);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "b9c22c22-f110-4475-97a6-77903b7a9b16",
    "merchantGuid": "8cc84666-3a4f-41df-b208-d371a90b8b66",
    "firstName": "John",
    "lastName": "Doe",
    "address1": "108 8th Av.",
    "zip": "10016",
    "city": "New York",
    "state": "NY",
    "phone": "8987655434",
    "email": "JohnDoe@mailinator.com",
    "accountNumber": "123456789",
    "companyName": "Incutex",
    "customerCode": "CU4277",
    "invoiceNumber": "000001",
    "presetCustomerNotes": "New Customer Notes",
    "presetTermsAndConditions": "New Terms And Conditions",
    "shippingAddresses": [
        {
            "guid": "7ce2453e-368a-439b-836d-7a3fbfbe8d61",
            "address1": "108 8th Av.",
            "zip": "10016",
            "city": "New York",
            "state": "NY"
        }
    ],
    "customerType": "Individual"
}

Update customer

PUT/Customers/<guid>

This endpoint updates a customer.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Invoice customer’s guid to update

Query Parameters

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant’s Guid.
CustomerType	string	Mandatory	Customer Type. Allowed values: 1. Individual 2. Business
AccountNumber	string	Optional	Account Number.
CompanyName	string	Optional	Company Name.
FirstName	string	Mandatory	User’s first name.
LastName	string	Mandatory	User’s last name.
Address1	string	Optional	User’s address.
Address2	string	Optional	User’s address line 2.
City	string	Optional	User’s city.
State	string	Optional	User’s short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2.
Zip	integer	Optional	User’s zipcode. Length = 5.
Phone	integer	Optional	User’s phone number. The phone number must be syntactically correct. For example, 4152345678.
Email	string	Optional	User’s valid email address
PresetCustomerNotes	string	Optional	Preset Customer Notes.
PresetTermsAndConditions	string	Optional	Preset Terms And Conditions.
ShippingAddresses	object	Optional	Shipping Addresses.

Request

curl -X PUT https://apisandbox.surepay.co/api/v1/Customers/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "8cc84666-3a4f-41df-b208-d371a90b8b66",
    "customerType": "Individual",
    "accountNumber": "123456789",
    "companyName": "Incutex",
    "firstName": "John",
    "lastName": "Doe",
    "address1": "Belgrano 383",
    "city": "New York",
    "state": "NY",
    "zip": "10016",
    "phone": "8987655434",
    "email": "JohnDoe@mailinator.com",
    "guid": "b9c22c22-f110-4475-97a6-77903b7a9b16",
    "presetCustomerNotes": "New Customer Notes",
    "presetTermsAndConditions": "New Terms And Conditions",
    "shippingAddresses": [
        {
            "address1": "Belgrano 383",
            "address2": null,
            "city": "New York",
            "state": "NY",
            "zip": "10016"
        }
    ]
}'

{
    "merchantGuid": "8cc84666-3a4f-41df-b208-d371a90b8b66",
    "customerType": "Individual",
    "accountNumber": "123456789",
    "companyName": "Incutex",
    "firstName": "John",
    "lastName": "Doe",
    "address1": "Belgrano 383",
    "city": "New York",
    "state": "NY",
    "zip": "10016",
    "phone": "8987655434",
    "email": "JohnDoe@mailinator.com",
    "guid": "b9c22c22-f110-4475-97a6-77903b7a9b16",
    "presetCustomerNotes": "New Customer Notes",
    "presetTermsAndConditions": "New Terms And Conditions",
    "shippingAddresses": [
        {
            "address1": "Belgrano 383",
            "address2": null,
            "city": "New York",
            "state": "NY",
            "zip": "10016"
        }
    ]
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurepaySample
{
    public class Customer
    {
        public static void UpdateCustomer()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Customers/00572c03-3536-4f48-b083-caf1a3d30c18");
                request.ContentType = "text/json";
                request.Method = "PUT";

                var customer = new
                {
                    MerchantGuid = "8cc84666-3a4f-41df-b208-d371a90b8b66",
                    CustomerType = "Individual",
                    AccountNumber = "123456789",
                    CompanyName = "Incutex",
                    FirstName = "John",
                    LastName = "Doe",
                    Address1 = "108 8th Av.",
                    Zip = "10016",
                    City = "New York",
                    State = "NY",
                    Phone = "8987655434",
                    Email = "JohnDoe@mailinator.com",
                    PresetCustomerNotes = "New Customer Notes",
                    PresetTermsAndConditions = "New Terms And Conditions",
                    shippingAddresses = new
                    {
                        Address1 =  "108 8th Av.",
                        City =  "New York",
                        State =  "NY",
                        Zip =  "10016"
                    }
                };

                string json = JsonConvert.SerializeObject(customer);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "b9c22c22-f110-4475-97a6-77903b7a9b16",
    "merchantGuid": "8cc84666-3a4f-41df-b208-d371a90b8b66",
    "firstName": "John",
    "lastName": "Doe",
    "address1": "Belgrano 383",
    "zip": "10016",
    "city": "New York",
    "state": "NY",
    "phone": "8987655434",
    "email": "JohnDoe@mailinator.com",
    "accountNumber": "123456789",
    "companyName": "Incutex",
    "customerCode": "CU4277",
    "invoiceNumber": "000001",
    "presetCustomerNotes": "New Customer Notes",
    "presetTermsAndConditions": "New Terms And Conditions",
    "shippingAddresses": [
        {
            "guid": "1564389e-de8e-493b-9ddc-609597a91744",
            "address1": "Belgrano 383",
            "zip": "10016",
            "city": "New York",
            "state": "NY"
        }
    ],
    "customerType": "Individual"
}

Search customers

POST/Search/Customers/{exportable}/{pageNumber}/{pageSize}

This endpoint search a customers.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant’s Guid.
CustomerType	string	Optional	Customer Type. Allowed values: 1. Individual 2. Business
AccountNumber	string	Optional	Account Number.
CompanyName	string	Optional	Company Name.
FirstName	string	Optional	User’s first name.
LastName	string	Optional	User’s last name.
Address1	string	Optional	User’s address.
Address2	string	Optional	User’s address line 2.
City	string	Optional	User’s city.
State	string	Optional	User’s short name state. The ISO 3166-2 CA and US state or province code of a user. Length = 2.
Zip	integer	Optional	User’s zipcode. Length = 5.
Phone	integer	Optional	User’s phone number. The phone number must be syntactically correct. For example, 4152345678.
Email	string	Optional	User’s valid email address

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/Customers/{exportable}/{pageNumber}/{pageSize} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "customerType": "Individual",
    "merchantGuid": "8cc84666-3a4f-41df-b208-d371a90b8b66"
}'

{
    "customerType": "Individual",
    "merchantGuid": "8cc84666-3a4f-41df-b208-d371a90b8b66"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurepaySample
{
    public class Search
    {
        public static void SearchCustomers()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/Customers/false/1/10");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    MerchantGuid = "8cc84666-3a4f-41df-b208-d371a90b8b66",
                    CustomerType = "Individual"
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 10,
    "totalResults": 1,
    "searchResultDto": [
        {
            "guid": "b9c22c22-f110-4475-97a6-77903b7a9b16",
            "companyName": "Incutex",
            "firstName": "John",
            "lastName": "Doe",
            "email": "JohnDoe@mailinator.com",
            "address1": "Belgrano 383",
            "city": "New York",
            "state": "NY",
            "zip": "10016",
            "phone": "8987655434",
            "accountNumber": "123456789",
            "customerType": "Individual"
        }
    ]
}

Invoice

Create invoice

POST/Invoice

This endpoint creates a invoice.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
InvoiceCustomerGuid	string	Mandatory	InvoiceCustomer's Guid.
InvoiceNumber	string	Mandatory	Invoice Number.
OrderNumber	string	Optional	Order number. Length = 17.
PaymentTerm	string	Optional	The term of payments. Allowed values: 1. Custom 2. Due on Receipt 3. Due end of month 4. Due end of next month 5. Net 15 6. Net 30 7. Net 45 8. Net 60
DueDate	date	Optional	Due Date. Allowed format: MM-DD-YYYY. For example: 05-30-2018.
DiscountType	string	Optional	Discount Type. Allowed values: 1. Fixed 2. Percentage
DiscountValue	decimal	Optional	Discount Value.
TaxZip	integer	Optional	Tax Zip.
TaxAmount	decimal	Optional	Tax Amount.
TaxRate	decimal	Optional	Tax Rate.
Note	string	Optional	Note.
TermsAndConditions	string	Optional	Terms And Conditions.
SendStatus	string	Optional	Send Status. Allowed values: 1. Draft 2. Scheduled To be Sent 3. Scheduled To be SentEMAIL 4. Scheduled To be SentSMS
SendDate	date	Optional	Send Date. Allowed format: MM-DD-YYYY. For example: 05-30-2018.
InvoiceRecipientEmail	string	Optional	Valid email address.
SendBySMS	boolean	Optional	True or False.
SendToPhoneNumber	integer	Optional	Phone number. The phone number must be syntactically correct. For example, 4152345678.
Details	object	Mandatory	See Details.
EnhancedData	object	Optional	See EnhancedData.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Invoice \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "MerchantGuid" : "19344275-985e-4dff-81ee-cb84b8ad356c",
  "InvoiceCustomerGuid" : "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
  "InvoiceNumber" : "ARG001MAX",
  "OrderNumber" : "0001",
  "PaymentTerm" : "Custom",
  "DueDate" : "07/25/2018",
  "Details":
  [  
      {  
         "ItemDescription":"Wine Malbec",
         "Rate":14.78,
         "Quantity": 8
      },
      {  
         "ItemDescription":"Rum",
         "Rate":9.85,
         "Quantity": 4
      },
      {  
         "ItemDescription":"Brandy",
         "Rate":11.80,
         "Quantity": 2
      },
      {  
         "ItemDescription":"Cigars",
         "Rate": 44.89,
         "Quantity": 3
      }
   ],
  "DiscountType" : "Fixed",
  "DiscountValue" : 5.00,
  "TaxZip" : "10029",
  "TaxAmount" : 8.85,
  "TaxRate" : 5.785,
  "Note" : "For september services",
  "TermsAndConditions" : "The ones you accepted when you clicked two pages ago",
  "SendStatus" : "Scheduled To be Sent",
  "SendDate" : "07/20/2018",
  "InvoiceRecipientEmail" : "john.lock@mailinator.com",
  "SendBySMS" : true,
  "SendToPhoneNumber" : "9174355176",
  "EnhancedData":
  {
    "SaleTax" : 5,
    "PurchaseOrder" : "PURCHSEORDER1",
    "OrderDate" : "07/20/2018",
    "AdditionalTaxDetailTaxCategory" : "tex",
    "AdditionalTaxDetailTaxType" : "regional",
    "AdditionalTaxDetailTaxAmount" : 3,
    "AdditionalTaxDetailTaxRate" : 2.50,
    "ShippingCharges" : 20,
    "DutyCharges" : 17.59,
    "ShipToZip" : "50001",
    "ShipFromZip" : "55100",
    "DestinationCountryCode" : "ARG",
    "CustomerVATNumber": "75010101",
    "VATInvoice" : "231465214",
    "SummaryCommodityCode" : "Aa94",
    "SupplierReferenceNumber" : "123",
    "CustomerRefID" : "123",
    "ChargeDescriptor" : "lalala"
  }
}'

{
  "MerchantGuid" : "19344275-985e-4dff-81ee-cb84b8ad356c",
  "InvoiceCustomerGuid" : "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
  "InvoiceNumber" : "ARG001MAX",
  "OrderNumber" : "0001",
  "PaymentTerm" : "Custom",
  "DueDate" : "07/25/2018",
  "Details":
  [  
      {  
         "ItemDescription":"Wine Malbec",
         "Rate":14.78,
         "Quantity": 8
      },
      {  
         "ItemDescription":"Rum",
         "Rate":9.85,
         "Quantity": 4
      },
      {  
         "ItemDescription":"Brandy",
         "Rate":11.80,
         "Quantity": 2
      },
      {  
         "ItemDescription":"Cigars",
         "Rate": 44.89,
         "Quantity": 3
      }
   ],
  "DiscountType" : "Fixed",
  "DiscountValue" : 5.00,
  "TaxZip" : "10029",
  "TaxAmount" : 8.85,
  "TaxRate" : 5.785,
  "Note" : "For september services",
  "TermsAndConditions" : "The ones you accepted when you clicked two pages ago",
  "SendStatus" : "Scheduled To be Sent",
  "SendDate" : "07/20/2018",
  "InvoiceRecipientEmail" : "john.lock@mailinator.com",
  "SendBySMS" : true,
  "SendToPhoneNumber" : "9174355176",
  "EnhancedData":
  {
    "SaleTax" : 5,
    "PurchaseOrder" : "PURCHSEORDER1",
    "OrderDate" : "07/20/2018",
    "AdditionalTaxDetailTaxCategory" : "tex",
    "AdditionalTaxDetailTaxType" : "regional",
    "AdditionalTaxDetailTaxAmount" : 3,
    "AdditionalTaxDetailTaxRate" : 2.50,
    "ShippingCharges" : 20,
    "DutyCharges" : 17.59,
    "ShipToZip" : "50001",
    "ShipFromZip" : "55100",
    "DestinationCountryCode" : "ARG",
    "CustomerVATNumber": "75010101",
    "VATInvoice" : "231465214",
    "SummaryCommodityCode" : "Aa94",
    "SupplierReferenceNumber" : "123",
    "CustomerRefID" : "123",
    "ChargeDescriptor" : "lalala"
  }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Invoice
    {
        public static void CreateInvoice()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Invoice");
                request.ContentType = "text/json";
                request.Method = "POST";

                var invoice = new
                {
                    MerchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    InvoiceCustomerGuid = "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
                    InvoiceNumber = "ARG001MAX",
                    OrderNumber = "0001",
                    PaymentTerm = "Custom",
                    DueDate = "07/25/2018",
                    Details = new Detail[]
                    {
                        new Detail{
                             ItemDescription = "Wine Malbec",
                             Rate = 14.78,
                             Quantity = 8
                        },
                        new Detail{
                             ItemDescription = "Rum",
                             Rate = 9.85,
                             Quantity = 4
                        },
                        new Detail{
                             ItemDescription = "Brandy",
                             Rate = 11.80,
                             Quantity = 2
                        },
                        new Detail{
                             ItemDescription = "Rum",
                             Rate = 9.85,
                             Quantity = 4
                        }
                    },
                    DiscountType = "Fixed",
                    DiscountValue = 5.00,
                    TaxZip = "10029",
                    TaxAmount = 8.85,
                    TaxRate = 5.785,
                    Note = "For september services",
                    TermsAndConditions = "The ones you accepted when you clicked two pages ago",
                    SendStatus = "Scheduled To be Sent",
                    SendDate = "07/20/2018",
                    InvoiceRecipientEmail = "john.lock@mailinator.com",
                    SendBySMS = true,
                    SendToPhoneNumber = "9174355176",
                    EnhancedData = new
                    {
                        SaleTax = 5,
                        PurchaseOrder = "PURCHSEORDER1",
                        OrderDate = "07/20/2018",
                        AdditionalTaxDetailTaxCategory = "tex",
                        AdditionalTaxDetailTaxType = "regional",
                        AdditionalTaxDetailTaxAmount = 3,
                        AdditionalTaxDetailTaxRate = 2.50,
                        ShippingCharges = 20,
                        DutyCharges = 17.59,
                        ShipToZip = "50001",
                        ShipFromZip = "55100",
                        DestinationCountryCode = "ARG",
                        CustomerVATNumber = "75010101",
                        VATInvoice = "231465214",
                        SummaryCommodityCode = "Aa94",
                        SupplierReferenceNumber = "123",
                        CustomerRefID = "123",
                        ChargeDescriptor = "lalala"
                    }
                };

                string json = JsonConvert.SerializeObject(invoice);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))

Response

{
    "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
    "timeStamp": "2018-07-04T08:33:05.45-03:00",
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "invoiceCustomerGuid": "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
    "sendDate": "2018-07-20T00:00:00",
    "sendStatus": "Scheduled To be Sent",
    "invoiceRecipientEmail": "john.lock@mailinator.com",
    "paymentTerm": "Custom",
    "dueDate": "2018-07-25T00:00:00",
    "invoiceNumber": "ARG001MAX",
    "orderNumber": "0001",
    "amountSubTotal": 315.91,
    "amountDueTotal": 328.89,
    "amountDiscounted": 5,
    "discountValue": 5,
    "discountType": "Fixed",
    "taxRate": 5.785,
    "taxAmount": 17.98,
    "taxZip": "10029",
    "note": "For september services",
    "termsAndConditions": "The ones you accepted when you clicked two pages ago",
    "enhancedData": {
        "saleTax": 5,
        "purchaseOrder": "PURCHSEORDER1",
        "additionalTaxDetailTaxCategory": "tex",
        "additionalTaxDetailTaxType": "regional",
        "additionalTaxDetailTaxAmount": 3,
        "additionalTaxDetailTaxRate": 2.5,
        "shippingCharges": 20,
        "dutyCharges": 17.59,
        "shipToZip": "50001",
        "shipFromZip": "55100",
        "destinationCountryCode": "ARG",
        "customerVATNumber": "75010101",
        "summaryCommodityCode": "Aa94",
        "vatInvoice": "231465214",
        "orderDate": "07/20/2018",
        "supplierReferenceNumber": "123",
        "customerRefID": "123",
        "chargeDescriptor": "lalala"
    },
    "details": [
        {
            "guid": "ed85d22a-a8e8-4a97-b549-f9a735e7ab75",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Wine Malbec",
            "rate": 14.78,
            "quantity": 8,
            "amount": 118.24,
            "isDeleted": false
        },
        {
            "guid": "cdd55ede-e648-467d-b8b3-e553c7f1b561",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Rum",
            "rate": 9.85,
            "quantity": 4,
            "amount": 39.4,
            "isDeleted": false
        },
        {
            "guid": "d568eb74-2bfa-4072-ad35-172f13898343",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Brandy",
            "rate": 11.8,
            "quantity": 2,
            "amount": 23.6,
            "isDeleted": false
        },
        {
            "guid": "efb3e968-85da-4643-b56f-13c716dc58d8",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Cigars",
            "rate": 44.89,
            "quantity": 3,
            "amount": 134.67,
            "isDeleted": false
        }
    ],
    "reminders": [
        {
            "guid": "b51d548c-5e03-40a1-bc03-77fd953d643a",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "reminderType": "5 days before due date",
            "isActive": true,
            "isCompleted": false,
            "reminderDate": "2018-07-20T00:00:00"
        },
        {
            "guid": "e0684cdd-46b7-41fe-9a7b-a5c9e3424565",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "reminderType": "5 days after due date",
            "isActive": true,
            "isCompleted": false,
            "reminderDate": "2018-07-30T00:00:00"
        }
    ],
    "merchant": {
        "guid": "19344275-985e-4dff-81ee-cb84b8ad356c",
        "mid": "1210000189539040",
        "dba": "AudioBit",
        "legalName": "AudioBit LLC",
        "adminUserGuid": "8a1a455e-60ed-4a0d-a649-44e661d92a27",
        "email": "audiobit@mailinator.com",
        "phone": "9547218212",
        "address1": "151 E 33rd ST",
        "address2": "Second Floor",
        "city": "New York",
        "state": "CO",
        "zipcode": "10016",
        "webhookUrl": "https://audiobit.com",
        "mailingBcc": "maxduplessy@mailinator.com",
        "customerLabel": "patientId",
        "logoUrl": "https://res.cloudinary.com/surepay/image/upload/v1516126617/uxuxkm3odb6lltibyeyj.png",
        "allowsTips": true,
        "status": "Merchant - Active",
        "merchantOwners": [
            {
                "guid": "f1388a86-380e-4294-be5e-04886d7a9801",
                "firstName": "aaa",
                "lastName": "aaa",
                "email": "aaa@aaa.com",
                "phone": "9177874563",
                "address1": "151 E 33rd ST",
                "address2": "Second Floor",
                "city": "New York",
                "state": "MO",
                "zipcode": "10016",
                "country": "US",
                "ownerShipType": "Partnership",
                "ownerShipPercentage": "100.00",
                "status": "MerchantOwner - Active",
                "last4_SSN": "1234"
            },
            {
                "guid": "cd057c76-e237-4515-9b4b-295061598186",
                "firstName": "James",
                "lastName": "Dean",
                "email": "jamesdean@surtech.com",
                "phone": "9177874563",
                "address1": "151 E 33rd ST",
                "address2": "Second Floor",
                "city": "New York",
                "state": "NY",
                "zipcode": "10016",
                "country": "US",
                "ownerShipType": "Partnership",
                "ownerShipPercentage": "100.00",
                "status": "MerchantOwner - Active",
                "last4_SSN": "1234"
            }
        ]
    },
    "invoiceCustomer": {
        "guid": "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
        "customerCode": "GX8426",
        "companyName": "Incutex",
        "firstName": "Albus",
        "lastName": "Dumbledore",
        "address1": "108 8th Av.",
        "address2": "8th Floor",
        "zip": "10008",
        "city": "New York",
        "state": "NY",
        "personalPhone": "9727414574",
        "workPhone": "9177563046",
        "fax": "8004578796",
        "email": "john.lock@mailinator.com"
    },
    "sendBySMS": true,
    "sendToPhoneNumber": "9174355176"
}

Update invoice

PUT/Invoice/<guid>

This endpoint updates a invoice.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Invoice’s guid to update

Query Parameters

Parameter	Type	M/C/O	Value
OrderNumber	string	Optional	Order number. Length = 17.
PaymentTerm	string	Optional	The term of payments. Allowed values: 1. Custom 2. Due on Receipt 3. Due end of month 4. Due end of next month 5. Net 15 6. Net 30 7. Net 45 8. Net 60
DueDate	date	Optional	Due Date. Allowed format: MM-DD-YYYY. For example: 05-30-2018.
DiscountType	string	Optional	Discount Type. Allowed values: 1. Fixed 2. Percentage
DiscountValue	decimal	Optional	Discount Value.
TaxZip	integer	Optional	Tax Zip.
TaxAmount	decimal	Optional	Tax Amount.
TaxRate	decimal	Optional	Tax Rate.
Note	string	Optional	Note.
TermsAndConditions	string	Optional	Terms And Conditions.
SendStatus	string	Optional	Send Status. Allowed values: 1. Draft 2. Scheduled To be Sent 3. Scheduled To be SentEMAIL 4. Scheduled To be SentSMS
SendDate	date	Optional	Send Date. Allowed format: MM-DD-YYYY. For example: 05-30-2018.
InvoiceRecipientEmail	string	Optional	Valid email address.
SendBySMS	boolean	Optional	True or False.
SendToPhoneNumber	integer	Optional	Phone number. The phone number must be syntactically correct. For example, 4152345678.
EnhancedData	object	Optional	See EnhancedData.

Request

curl -X PUT https://apisandbox.surepay.co/api/v1/Invoice/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "OrderNumber" : "0001",
  "PaymentTerm" : "Custom",
  "DueDate" : "07/25/2018",
  "DiscountType" : "Fixed",
  "DiscountValue" : 5.00,
  "TaxZip" : "10029",
  "TaxAmount" : 8.85,
  "TaxRate" : 5.785,
  "Note" : "For september services",
  "TermsAndConditions" : "The ones you accepted when you clicked two pages ago",
  "SendStatus" : "Scheduled To be Sent",
  "SendDate" : "07/20/2018",
  "InvoiceRecipientEmail" : "john.lock@mailinator.com",
  "SendBySMS" : true,
  "SendToPhoneNumber" : "9174355176",
  "EnhancedData":
  {
    "SaleTax" : 5,
    "PurchaseOrder" : "PURCHSEORDER1",
    "OrderDate" : "07/20/2018",
    "AdditionalTaxDetailTaxCategory" : "tex",
    "AdditionalTaxDetailTaxType" : "regional",
    "AdditionalTaxDetailTaxAmount" : 3,
    "AdditionalTaxDetailTaxRate" : 2.50,
    "ShippingCharges" : 20,
    "DutyCharges" : 17.59,
    "ShipToZip" : "50001",
    "ShipFromZip" : "55100",
    "DestinationCountryCode" : "ARG",
    "CustomerVATNumber": "75010101",
    "VATInvoice" : "231465214",
    "SummaryCommodityCode" : "Aa94",
    "SupplierReferenceNumber" : "123",
    "CustomerRefID" : "123",
    "ChargeDescriptor" : "lalala"
  }
}'

{
  "OrderNumber" : "0001",
  "PaymentTerm" : "Custom",
  "DueDate" : "07/25/2018",
  "DiscountType" : "Fixed",
  "DiscountValue" : 5.00,
  "TaxZip" : "10029",
  "TaxAmount" : 8.85,
  "TaxRate" : 5.785,
  "Note" : "For september services",
  "TermsAndConditions" : "The ones you accepted when you clicked two pages ago",
  "SendStatus" : "Scheduled To be Sent",
  "SendDate" : "07/20/2018",
  "InvoiceRecipientEmail" : "john.lock@mailinator.com",
  "SendBySMS" : true,
  "SendToPhoneNumber" : "9174355176",
  "EnhancedData":
  {
    "SaleTax" : 5,
    "PurchaseOrder" : "PURCHSEORDER1",
    "OrderDate" : "07/20/2018",
    "AdditionalTaxDetailTaxCategory" : "tex",
    "AdditionalTaxDetailTaxType" : "regional",
    "AdditionalTaxDetailTaxAmount" : 3,
    "AdditionalTaxDetailTaxRate" : 2.50,
    "ShippingCharges" : 20,
    "DutyCharges" : 17.59,
    "ShipToZip" : "50001",
    "ShipFromZip" : "55100",
    "DestinationCountryCode" : "ARG",
    "CustomerVATNumber": "75010101",
    "VATInvoice" : "231465214",
    "SummaryCommodityCode" : "Aa94",
    "SupplierReferenceNumber" : "123",
    "CustomerRefID" : "123",
    "ChargeDescriptor" : "lalala"
  }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Invoice
    {
        public static void UpdateInvoice()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Invoice/00572c03-3536-4f48-b083-caf1a3d30c18");
                request.ContentType = "text/json";
                request.Method = "PUT";

                var invoice = new
                {
                    OrderNumber = "0001",
                    PaymentTerm = "Custom",
                    DueDate = "07/25/2018",
                    DiscountType = "Fixed",
                    DiscountValue = 5.00,
                    TaxZip = "10029",
                    TaxAmount = 8.85,
                    TaxRate = 5.785,
                    Note = "For september services",
                    TermsAndConditions = "The ones you accepted when you clicked two pages ago",
                    SendStatus = "Scheduled To be Sent",
                    SendDate = "07/20/2018",
                    InvoiceRecipientEmail = "john.lock@mailinator.com",
                    SendBySMS = true,
                    SendToPhoneNumber = "9174355176",
                    EnhancedData = new
                    {
                        SaleTax = 5,
                        PurchaseOrder = "PURCHSEORDER1",
                        OrderDate = "07/20/2018",
                        AdditionalTaxDetailTaxCategory = "tex",
                        AdditionalTaxDetailTaxType = "regional",
                        AdditionalTaxDetailTaxAmount = 3,
                        AdditionalTaxDetailTaxRate = 2.50,
                        ShippingCharges = 20,
                        DutyCharges = 17.59,
                        ShipToZip = "50001",
                        ShipFromZip = "55100",
                        DestinationCountryCode = "ARG",
                        CustomerVATNumber = "75010101",
                        VATInvoice = "231465214",
                        SummaryCommodityCode = "Aa94",
                        SupplierReferenceNumber = "123",
                        CustomerRefID = "123",
                        ChargeDescriptor = "lalala"
                    }
                };

                string json = JsonConvert.SerializeObject(invoice);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {

Response

{
    "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
    "timeStamp": "2018-07-04T08:33:05.45-03:00",
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "invoiceCustomerGuid": "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
    "sendDate": "2018-07-20T00:00:00",
    "sendStatus": "Scheduled To be Sent",
    "invoiceRecipientEmail": "john.lock@mailinator.com",
    "paymentTerm": "Custom",
    "dueDate": "2018-07-25T00:00:00",
    "invoiceNumber": "ARG001MAX",
    "orderNumber": "0001",
    "amountSubTotal": 315.91,
    "amountDueTotal": 328.9,
    "amountDiscounted": 5,
    "discountValue": 5,
    "discountType": "Fixed",
    "taxRate": 5.785,
    "taxAmount": 17.98,
    "taxZip": "10029",
    "note": "For september services",
    "termsAndConditions": "The ones you accepted when you clicked two pages ago",
    "enhancedData": {
        "saleTax": 5,
        "purchaseOrder": "PURCHSEORDER1",
        "additionalTaxDetailTaxCategory": "tex",
        "additionalTaxDetailTaxType": "regional",
        "additionalTaxDetailTaxAmount": 3,
        "additionalTaxDetailTaxRate": 2.5,
        "shippingCharges": 20,
        "dutyCharges": 17.59,
        "shipToZip": "50001",
        "shipFromZip": "55100",
        "destinationCountryCode": "ARG",
        "customerVATNumber": "75010101",
        "summaryCommodityCode": "Aa94",
        "vatInvoice": "231465214",
        "orderDate": "MM/DD/YYYY",
        "supplierReferenceNumber": "123",
        "customerRefID": "123",
        "chargeDescriptor": "lalala"
    },
    "details": [
        {
            "guid": "ed85d22a-a8e8-4a97-b549-f9a735e7ab75",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Wine Malbec",
            "rate": 14.78,
            "quantity": 8,
            "amount": 118.24,
            "isDeleted": false
        },
        {
            "guid": "cdd55ede-e648-467d-b8b3-e553c7f1b561",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Rum",
            "rate": 9.85,
            "quantity": 4,
            "amount": 39.4,
            "isDeleted": false
        },
        {
            "guid": "d568eb74-2bfa-4072-ad35-172f13898343",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Brandy",
            "rate": 11.8,
            "quantity": 2,
            "amount": 23.6,
            "isDeleted": false
        },
        {
            "guid": "efb3e968-85da-4643-b56f-13c716dc58d8",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Cigars",
            "rate": 44.89,
            "quantity": 3,
            "amount": 134.67,
            "isDeleted": false
        }
    ],
    "reminders": [
        {
            "guid": "b51d548c-5e03-40a1-bc03-77fd953d643a",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "reminderType": "5 days before due date",
            "isActive": false,
            "isCompleted": false,
            "reminderDate": "2018-07-20T00:00:00"
        },
        {
            "guid": "e0684cdd-46b7-41fe-9a7b-a5c9e3424565",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "reminderType": "5 days after due date",
            "isActive": true,
            "isCompleted": false,
            "reminderDate": "2018-07-30T00:00:00"
        }
    ],
    "merchant": {
        "guid": "19344275-985e-4dff-81ee-cb84b8ad356c",
        "mid": "1210000189539040",
        "dba": "AudioBit",
        "legalName": "AudioBit LLC",
        "adminUserGuid": "8a1a455e-60ed-4a0d-a649-44e661d92a27",
        "email": "audiobit@mailinator.com",
        "phone": "9547218212",
        "address1": "151 E 33rd ST",
        "address2": "Second Floor",
        "city": "New York",
        "state": "CO",
        "zipcode": "10016",
        "webhookUrl": "https://audiobit.com",
        "mailingBcc": "maxduplessy@mailinator.com",
        "customerLabel": "patientId",
        "logoUrl": "https://res.cloudinary.com/surepay/image/upload/v1516126617/uxuxkm3odb6lltibyeyj.png",
        "allowsTips": true,
        "status": "Merchant - Active",
        "merchantOwners": [
            {
                "guid": "f1388a86-380e-4294-be5e-04886d7a9801",
                "firstName": "aaa",
                "lastName": "aaa",
                "email": "aaa@aaa.com",
                "phone": "9177874563",
                "address1": "151 E 33rd ST",
                "address2": "Second Floor",
                "city": "New York",
                "state": "MO",
                "zipcode": "10016",
                "country": "US",
                "ownerShipType": "Partnership",
                "ownerShipPercentage": "100.00",
                "status": "MerchantOwner - Active",
                "last4_SSN": "1234"
            },
            {
                "guid": "cd057c76-e237-4515-9b4b-295061598186",
                "firstName": "James",
                "lastName": "Dean",
                "email": "jamesdean@surtech.com",
                "phone": "9177874563",
                "address1": "151 E 33rd ST",
                "address2": "Second Floor",
                "city": "New York",
                "state": "NY",
                "zipcode": "10016",
                "country": "US",
                "ownerShipType": "Partnership",
                "ownerShipPercentage": "100.00",
                "status": "MerchantOwner - Active",
                "last4_SSN": "1234"
            }
        ]
    },
    "invoiceCustomer": {
        "guid": "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
        "customerCode": "GX8426",
        "companyName": "Incutex",
        "firstName": "Albus",
        "lastName": "Dumbledore",
        "address1": "108 8th Av.",
        "address2": "8th Floor",
        "zip": "10008",
        "city": "New York",
        "state": "NY",
        "personalPhone": "9727414574",
        "workPhone": "9177563046",
        "fax": "8004578796",
        "email": "john.lock@mailinator.com"
    },
    "sendBySMS": true,
    "sendToPhoneNumber": "9174355176"
}

Get invoice

GET/Invoice/<guid>

This endpoint gets a invoice.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Invoice’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/Invoice/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Invoice
    {
        public static void GetInvoice()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Invoice/89e6c76c-35fe-4360-95ca-6e4c0eb49bdc");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
    "timeStamp": "2018-07-04T08:33:05.45-03:00",
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "invoiceCustomerGuid": "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
    "sendDate": "2018-07-20T00:00:00",
    "sendStatus": "Scheduled To be Sent",
    "invoiceRecipientEmail": "john.lock@mailinator.com",
    "paymentTerm": "Custom",
    "dueDate": "2018-07-25T00:00:00",
    "invoiceNumber": "ARG001MAX",
    "orderNumber": "0001",
    "amountSubTotal": 315.91,
    "amountDueTotal": 328.9,
    "amountDiscounted": 5,
    "discountValue": 5,
    "discountType": "Fixed",
    "taxRate": 5.785,
    "taxAmount": 17.98,
    "taxZip": "10029",
    "note": "For september services",
    "termsAndConditions": "The ones you accepted when you clicked two pages ago",
    "enhancedData": {
        "saleTax": 5,
        "purchaseOrder": "PURCHSEORDER1",
        "additionalTaxDetailTaxCategory": "tex",
        "additionalTaxDetailTaxType": "regional",
        "additionalTaxDetailTaxAmount": 3,
        "additionalTaxDetailTaxRate": 2.5,
        "shippingCharges": 20,
        "dutyCharges": 17.59,
        "shipToZip": "50001",
        "shipFromZip": "55100",
        "destinationCountryCode": "ARG",
        "customerVATNumber": "75010101",
        "summaryCommodityCode": "Aa94",
        "vatInvoice": "231465214",
        "orderDate": "MM/DD/YYYY",
        "supplierReferenceNumber": "123",
        "customerRefID": "123",
        "chargeDescriptor": "lalala"
    },
    "details": [
        {
            "guid": "ed85d22a-a8e8-4a97-b549-f9a735e7ab75",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Wine Malbec",
            "rate": 14.78,
            "quantity": 8,
            "amount": 118.24,
            "isDeleted": false
        },
        {
            "guid": "cdd55ede-e648-467d-b8b3-e553c7f1b561",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Rum",
            "rate": 9.85,
            "quantity": 4,
            "amount": 39.4,
            "isDeleted": false
        },
        {
            "guid": "d568eb74-2bfa-4072-ad35-172f13898343",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Brandy",
            "rate": 11.8,
            "quantity": 2,
            "amount": 23.6,
            "isDeleted": false
        },
        {
            "guid": "efb3e968-85da-4643-b56f-13c716dc58d8",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "itemDescription": "Cigars",
            "rate": 44.89,
            "quantity": 3,
            "amount": 134.67,
            "isDeleted": false
        }
    ],
    "reminders": [
        {
            "guid": "b51d548c-5e03-40a1-bc03-77fd953d643a",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "reminderType": "5 days before due date",
            "isActive": false,
            "isCompleted": false,
            "reminderDate": "2018-07-20T00:00:00"
        },
        {
            "guid": "e0684cdd-46b7-41fe-9a7b-a5c9e3424565",
            "invoiceGuid": "89e6c76c-35fe-4360-95ca-6e4c0eb49bdc",
            "reminderType": "5 days after due date",
            "isActive": true,
            "isCompleted": false,
            "reminderDate": "2018-07-30T00:00:00"
        }
    ],
    "merchant": {
        "guid": "19344275-985e-4dff-81ee-cb84b8ad356c",
        "mid": "1210000189539040",
        "dba": "AudioBit",
        "legalName": "AudioBit LLC",
        "adminUserGuid": "8a1a455e-60ed-4a0d-a649-44e661d92a27",
        "email": "audiobit@mailinator.com",
        "phone": "9547218212",
        "address1": "151 E 33rd ST",
        "address2": "Second Floor",
        "city": "New York",
        "state": "CO",
        "zipcode": "10016",
        "webhookUrl": "https://audiobit.com",
        "mailingBcc": "maxduplessy@mailinator.com",
        "customerLabel": "patientId",
        "logoUrl": "https://res.cloudinary.com/surepay/image/upload/v1516126617/uxuxkm3odb6lltibyeyj.png",
        "allowsTips": true,
        "status": "Merchant - Active",
        "merchantOwners": [
            {
                "guid": "f1388a86-380e-4294-be5e-04886d7a9801",
                "firstName": "aaa",
                "lastName": "aaa",
                "email": "aaa@aaa.com",
                "phone": "9177874563",
                "address1": "151 E 33rd ST",
                "address2": "Second Floor",
                "city": "New York",
                "state": "MO",
                "zipcode": "10016",
                "country": "US",
                "ownerShipType": "Partnership",
                "ownerShipPercentage": "100.00",
                "status": "MerchantOwner - Active",
                "last4_SSN": "1234"
            },
            {
                "guid": "cd057c76-e237-4515-9b4b-295061598186",
                "firstName": "James",
                "lastName": "Dean",
                "email": "jamesdean@surtech.com",
                "phone": "9177874563",
                "address1": "151 E 33rd ST",
                "address2": "Second Floor",
                "city": "New York",
                "state": "NY",
                "zipcode": "10016",
                "country": "US",
                "ownerShipType": "Partnership",
                "ownerShipPercentage": "100.00",
                "status": "MerchantOwner - Active",
                "last4_SSN": "1234"
            }
        ]
    },
    "invoiceCustomer": {
        "guid": "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
        "customerCode": "GX8426",
        "companyName": "Incutex",
        "firstName": "Albus",
        "lastName": "Dumbledore",
        "address1": "108 8th Av.",
        "address2": "8th Floor",
        "zip": "10008",
        "city": "New York",
        "state": "NY",
        "personalPhone": "9727414574",
        "workPhone": "9177563046",
        "fax": "8004578796",
        "email": "john.lock@mailinator.com"
    },
    "sendBySMS": true,
    "sendToPhoneNumber": "9174355176"
}

Invoice Detail

Add invoice detail

POST/Invoice/Detail

This endpoint add a invoice detail.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
InvoiceGuid	string	Mandatory	Invoice's Guid.
ItemDescription	string	Mandatory	Item Description.
Rate	decimal	Mandatory	Rate.
Quantity	integer	Mandatory	Quantity.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Invoice/Detail \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "invoiceGuid" : "4be52be2-bedf-4125-b7d5-2ed9ef8d6027",
    "ItemDescription":"Sparkling Wine",
    "Rate":1.95,
    "Quantity": 3
}'

{
    "invoiceGuid" : "4be52be2-bedf-4125-b7d5-2ed9ef8d6027",
    "ItemDescription":"Sparkling Wine",
    "Rate":1.95,
    "Quantity": 3
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class InvoiceDetail
    {
        public static void CreateInvoiceDetail()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Invoice/Detail");
                request.ContentType = "text/json";
                request.Method = "POST";

                var invoiceDetail = new
                {
                    InvoiceGuid = "4be52be2-bedf-4125-b7d5-2ed9ef8d6027",
                    ItemDescription = "Sparkling Wine",
                    Rate = 1.95,
                    Quantity = 3
                };

                string json = JsonConvert.SerializeObject(invoiceDetail);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "13e6a6cb-c7a6-47e1-82da-ec8091b87d48",
    "invoiceGuid": "4be52be2-bedf-4125-b7d5-2ed9ef8d6027",
    "itemDescription": "Sparkling Wine",
    "rate": 1.95,
    "quantity": 3,
    "amount": 5.85,
    "isDeleted": false
}

Create invoice details list

PUT/Invoice/Detail/all/<guid>

This endpoint create a invoice details list.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Invoice’s guid

Query Parameters

Parameter	Type	M/C/O	Value
ItemDescription	string	Mandatory	Item Description.
Rate	decimal	Mandatory	Rate.
Quantity	integer	Mandatory	Quantity.

Request

curl -X PUT https://apisandbox.surepay.co/api/v1/Invoice/Detail/all/<guid> \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[  
    {  
        "ItemDescription":"Wine Malbec",
        "Rate":14.78,
        "Quantity": 8
    },
    {  
        "ItemDescription":"Rum",
        "Rate":9.85,
        "Quantity": 4
    }
]'

[  
    {  
        "ItemDescription":"Wine Malbec",
        "Rate":14.78,
        "Quantity": 8
    },
    {  
        "ItemDescription":"Rum",
        "Rate":9.85,
        "Quantity": 4
    }
]

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class InvoiceDetail
    {
        public static void CreateInvoiceDetailsList()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Invoice/Detail/all/e92d3395-34d8-4472-9ad3-62a183d6b030");
                request.ContentType = "text/json";
                request.Method = "PUT";

                var invoiceDetailsList = new Detail[]
                {
                    new Detail{
                         ItemDescription = "Wine Malbec",
                         Rate = 14.78,
                         Quantity = 8
                    },
                    new Detail{
                         ItemDescription = "Rum",
                         Rate = 9.85,
                         Quantity = 4
                    }
                };

                string json = JsonConvert.SerializeObject(invoiceDetailsList);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "invoiceGuid": "e92d3395-34d8-4472-9ad3-62a183d6b030",
    "timeStamp": "2018-07-04T13:39:28.68-03:00",
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "invoiceCustomerGuid": "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
    "sendDate": "2018-07-20T00:00:00",
    "sendStatus": "Scheduled To be Sent",
    "invoiceRecipientEmail": "john.lock@mailinator.com",
    "paymentTerm": "Custom",
    "dueDate": "2018-07-25T00:00:00",
    "invoiceNumber": "ARG001MAXYTRTU",
    "orderNumber": "0001",
    "amountSubTotal": 157.64,
    "amountDueTotal": 161.47,
    "amountDiscounted": 5,
    "discountValue": 5,
    "discountType": "Fixed",
    "taxRate": 5.785,
    "taxAmount": 8.83,
    "taxZip": "10029",
    "note": "For september services",
    "termsAndConditions": "The ones you accepted when you clicked two pages ago",
    "enhancedData": {
        "saleTax": 5,
        "purchaseOrder": "PURCHSEORDER1",
        "additionalTaxDetailTaxCategory": "tex",
        "additionalTaxDetailTaxType": "regional",
        "additionalTaxDetailTaxAmount": 3,
        "additionalTaxDetailTaxRate": 2.5,
        "shippingCharges": 20,
        "dutyCharges": 17.59,
        "shipToZip": "50001",
        "shipFromZip": "55100",
        "destinationCountryCode": "ARG",
        "customerVATNumber": "75010101",
        "summaryCommodityCode": "Aa94",
        "vatInvoice": "231465214",
        "orderDate": "07/20/2018",
        "supplierReferenceNumber": "123",
        "customerRefID": "123",
        "chargeDescriptor": "lalala"
    },
    "details": [
        {
            "guid": "c4438621-9d16-4434-9ab6-3a6b599ffea6",
            "invoiceGuid": "e92d3395-34d8-4472-9ad3-62a183d6b030",
            "itemDescription": "Wine Malbec",
            "rate": 14.78,
            "quantity": 8,
            "amount": 118.24,
            "isDeleted": false
        },
        {
            "guid": "8dfd0749-0748-4b21-9ebc-af10a72c55ec",
            "invoiceGuid": "e92d3395-34d8-4472-9ad3-62a183d6b030",
            "itemDescription": "Rum",
            "rate": 9.85,
            "quantity": 4,
            "amount": 39.4,
            "isDeleted": false
        }
    ],
    "reminders": [
        {
            "guid": "a56ddc1b-9f4f-4ed7-947b-a654291fcd8a",
            "invoiceGuid": "e92d3395-34d8-4472-9ad3-62a183d6b030",
            "reminderType": "5 days before due date",
            "isActive": true,
            "isCompleted": false,
            "reminderDate": "2018-07-20T00:00:00"
        },
        {
            "guid": "0ddc0b29-ab5d-4bf5-be33-877099789df5",
            "invoiceGuid": "e92d3395-34d8-4472-9ad3-62a183d6b030",
            "reminderType": "5 days after due date",
            "isActive": true,
            "isCompleted": false,
            "reminderDate": "2018-07-30T00:00:00"
        }
    ],
    "merchant": {
        "guid": "19344275-985e-4dff-81ee-cb84b8ad356c",
        "mid": "1210000189539040",
        "dba": "AudioBit",
        "legalName": "AudioBit LLC",
        "adminUserGuid": "8a1a455e-60ed-4a0d-a649-44e661d92a27",
        "email": "audiobit@mailinator.com",
        "phone": "9547218212",
        "address1": "151 E 33rd ST",
        "address2": "Second Floor",
        "city": "New York",
        "state": "CO",
        "zipcode": "10016",
        "webhookUrl": "https://audiobit.com",
        "mailingBcc": "maxduplessy@mailinator.com",
        "customerLabel": "patientId",
        "logoUrl": "https://res.cloudinary.com/surepay/image/upload/v1516126617/uxuxkm3odb6lltibyeyj.png",
        "allowsTips": true,
        "status": "Merchant - Active",
        "merchantOwners": [
            {
                "guid": "f1388a86-380e-4294-be5e-04886d7a9801",
                "firstName": "aaa",
                "lastName": "aaa",
                "email": "aaa@aaa.com",
                "phone": "9177874563",
                "address1": "151 E 33rd ST",
                "address2": "Second Floor",
                "city": "New York",
                "state": "MO",
                "zipcode": "10016",
                "country": "US",
                "ownerShipType": "Partnership",
                "ownerShipPercentage": "100.00",
                "status": "MerchantOwner - Active",
                "last4_SSN": "1234"
            },
            {
                "guid": "cd057c76-e237-4515-9b4b-295061598186",
                "firstName": "James",
                "lastName": "Dean",
                "email": "jamesdean@surtech.com",
                "phone": "9177874563",
                "address1": "151 E 33rd ST",
                "address2": "Second Floor",
                "city": "New York",
                "state": "NY",
                "zipcode": "10016",
                "country": "US",
                "ownerShipType": "Partnership",
                "ownerShipPercentage": "100.00",
                "status": "MerchantOwner - Active",
                "last4_SSN": "1234"
            }
        ]
    },
    "invoiceCustomer": {
        "guid": "9dcceb12-f084-4346-a03d-ed46a6c35d4e",
        "customerCode": "GX8426",
        "companyName": "Incutex",
        "firstName": "Albus",
        "lastName": "Dumbledore",
        "address1": "108 8th Av.",
        "address2": "8th Floor",
        "zip": "10008",
        "city": "New York",
        "state": "NY",
        "personalPhone": "9727414574",
        "workPhone": "9177563046",
        "fax": "8004578796",
        "email": "john.lock@mailinator.com"
    },
    "sendBySMS": true,
    "sendToPhoneNumber": "9174355176"
}

Invoice Reminder

Create invoice reminder

POST/Invoice/Reminder

This endpoint creates a invoice reminder.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
InvoiceGuid	string	Mandatory	Invoice's Guid.
ReminderType	string	Mandatory	Reminder Type. Allowed values: 1. X days before due date 2. 1 days before due date 3. 5 days before due date 4. 1 week before due date 5. 10 days before due date 6. 2 week before due date 7. X days after due date 8. 1 days after due date 9. 5 days after due date 10. 1 week after due date 11. 10 days after due date 12. 2 week after due date
ReminderDaysValue	integer	Optional	Reminder Days Value. Only with "X days before due date" or "X days after due date"

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Invoice/Reminder \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "InvoiceGuid" : "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
    "ReminderType" : "2 weeks after due date"
}'

{
    "InvoiceGuid" : "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
    "ReminderType" : "2 weeks after due date"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class InvoiceReminder
    {
        public static void CreateInvoiceReminder()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Invoice/Reminder");
                request.ContentType = "text/json";
                request.Method = "POST";

                var invoiceReminder = new
                {
                    InvoiceGuid = "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
                    ReminderType = "2 weeks after due date"
                };

                string json = JsonConvert.SerializeObject(invoiceReminder);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "a4e4278b-f2de-41d9-8da5-d0aabbf5a385",
    "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
    "reminderType": "2 weeks after due date",
    "isActive": true,
    "isCompleted": false,
    "reminderDate": "2019-08-08T00:00:00"
}

Update invoice reminder

PUT/Invoice/Reminder/<guid>/true

Json Example Response (PUT https://apisandbox.surepay.co/api/v1/Invoice/Reminder//true):

Json Example Response (PUT https://apisandbox.surepay.co/api/v1/Invoice/Reminder//false):

This endpoint updates a invoice reminder.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Reminder’s guid to update

Request

curl -X PUT https://apisandbox.surepay.co/api/v1/Invoice/Reminder/<guid>/true \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class InvoiceReminder
    {
        public static void UpdateInvoiceReminder()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Invoice/Reminder/a4e4278b-f2de-41d9-8da5-d0aabbf5a385/true");
                request.ContentType = "text/json";
                request.Method = "PUT";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "guid": "a4e4278b-f2de-41d9-8da5-d0aabbf5a385",
    "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
    "reminderType": "2 weeks after due date",
    "isActive": true,
    "isCompleted": false,
    "reminderDate": "2019-08-08T00:00:00"
}

Get invoice reminder

GET/Invoice/Reminder/<guid>/true

Json Example Response (GET https://apisandbox.surepay.co/api/v1/Invoice/Reminder//true):

Json Example Response (GET https://apisandbox.surepay.co/api/v1/Invoice/Reminder//false):

This endpoint gets a invoice reminder.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters

Parameter	Description
guid	Invoice’s guid to get

Request

curl -X GET https://apisandbox.surepay.co/api/v1/Invoice/Reminder/<guid>/true \
  -H "Authorization: Bearer $SUREPAY_TOKEN"

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class InvoiceReminder
    {
        public static void GetInvoiceReminder()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Invoice/Reminder/d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf/true");
                request.Method = "GET";

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

[
    {
        "guid": "00000000-0000-0000-0000-000000000000",
        "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
        "reminderType": "1 day before due date",
        "isActive": false,
        "isCompleted": false,
        "reminderDate": "0001-01-01T00:00:00"
    },
    {
        "guid": "fbb2633f-0bf4-412b-a51e-edad3fb4b058",
        "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
        "reminderType": "5 days before due date",
        "isActive": true,
        "isCompleted": false,
        "reminderDate": "2019-07-20T00:00:00"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000000",
        "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
        "reminderType": "1 week before due date",
        "isActive": false,
        "isCompleted": false,
        "reminderDate": "0001-01-01T00:00:00"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000000",
        "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
        "reminderType": "10 days before due date",
        "isActive": false,
        "isCompleted": false,
        "reminderDate": "0001-01-01T00:00:00"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000000",
        "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
        "reminderType": "2 weeks before due date",
        "isActive": false,
        "isCompleted": false,
        "reminderDate": "0001-01-01T00:00:00"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000000",
        "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
        "reminderType": "1 day after due date",
        "isActive": false,
        "isCompleted": false,
        "reminderDate": "0001-01-01T00:00:00"
    },
    {
        "guid": "cf7f8d0a-7540-43de-b637-09f7dec0a273",
        "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
        "reminderType": "5 days after due date",
        "isActive": true,
        "isCompleted": false,
        "reminderDate": "2019-07-30T00:00:00"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000000",
        "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
        "reminderType": "1 week after due date",
        "isActive": false,
        "isCompleted": false,
        "reminderDate": "0001-01-01T00:00:00"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000000",
        "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
        "reminderType": "10 days after due date",
        "isActive": false,
        "isCompleted": false,
        "reminderDate": "0001-01-01T00:00:00"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000000",
        "invoiceGuid": "d5828cfd-12a6-4a7e-9be6-7c4b11f07dbf",
        "reminderType": "2 weeks after due date",
        "isActive": false,
        "isCompleted": false,
        "reminderDate": "0001-01-01T00:00:00"
    }
]

Search

Search sales

POST/Search/Sales/{exportable}

This endpoint search a sales.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
AmountFrom	integer	Optional	Amount of the transaction. Min. amt.: $0.50
AmountTo	integer	Optional	Amount of the transaction. Min. amt.: $0.50
CardHolderName	string	Optional	Cardholder's name.
CardLastFour	string	Optional	Card last four number.
CardType	string	Optional	Card type.
InvoiceNumber	integer	Optional	Sale's InvoiceNumber.
OrderNumber	string	Optional	Sale's order number. Length = 17.
OrderDateFrom	date	Optional	Sale's order Date.
OrderDateTo	date	Optional	Sale's order Date.
TimeStampFrom	date	Optional	Sale's TimeStamp.
TimeStampTo	date	Optional	Sale's TimeStamp.
Status	string	Optional	Sale’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning
CustomerId	string	Optional	Customer Id.
CustomData	string	Optional	Customer Data.
GeneratedByCapture	boolean	Optional	Generated By Capture. Allowed values: 1. true 2. false
ProcessorRefNumber	string	Optional	Processor Reference Number.
UserName	string	Optional	UserName.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/Sales/{exportable} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}'

{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Search
    {
        public static void SearchSales()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/Sales/false");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    merchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    Status = "Transaction - Approved"
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 10,
    "totalResults": 1,
    "cardSummary": null,
    "searchResultDTO": [
        {
            "status": "Transaction - Approved",
            "amount": 20.00,
            "card": {
                "cardHolderName": null,
                "cardType": "Visa",
                "last4": "2910"
            },
            "timeStamp": "2020-11-26T06:34:34.46-06:00",
            "processorResponseMessage": "Success",
            "effectiveAmount": 0.00,
            "batchStatus": "Batch - Open",
            "relatedVoid": {
                "guid": "0f85c12d-9f51-49b8-8b8a-38238c89b9a6"
            },
            "guid": "372d66e5-1a5d-48ec-bebc-bb9347abe200",
            "deviceGuid": "b29725af-b067-4a35-9819-bbb31bdf8808",
            "generatedByCapture": false,
            "processorRefNumber": "24823396",
            "type": "Credit",
            "surchargeType": null,
            "tipAmount": null,
            "cardDataSource": "INTERNET",
            "allowCardEmv": false,
            "addressVerificationCode": "0",
            "addressVerificationResult": "Full Match",
            "cvvVerificationResult": " ",
            "semiIntegrated": false,
            "userName": "maxduplessy"
        }
    ]
}

Search voids

POST/Search/Voids/{exportable}

This endpoint search a voids.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
VoidReason	string	Optional	Indicates the reason the transaction was voided. Allowed values: 1. POST_AUTH_USER_DECLINE 2. DEVICE_TIMEOUT 3. DEVICE_UNAVAILABLE 4. PARTIAL_REVERSAL 5. POST_AUTH_CHIP_DECLINE
Status	string	Optional	Void’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning
TimeStampFrom	date	Optional	Void's TimeStamp.
TimeStampTo	date	Optional	Void's TimeStamp.
UserName	string	Optional	UserName.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/Voids/{exportable} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}'

{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Search
    {
        public static void SearchVoids()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/Voids/false");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    merchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    Status = "Transaction - Approved"
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 500,
    "totalResults": 1,
    "cardSummary": null,
    "searchResultDTO": [
        {
            "status": "Transaction - Approved",
            "sale": {
                "amount": 10.00,
                "card": {
                    "cardHolderName": null,
                    "cardType": "Visa",
                    "last4": "6734"
                }
            },
            "voidReason": "POST_AUTH_USER_DECLINE",
            "timeStamp": "2020-11-26T06:40:25.7-06:00",
            "processorStatusCode": "A0000",
            "batchStatus": "Batch - Open",
            "guid": "4130888a-cb0a-41a9-9d06-d90e10535b2a",
            "allowCardEmv": false,
            "userName": "maxduplessy"
        }
    ]
}

Search returns

POST/Search/Returns/{exportable}

This endpoint search a returns.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
AmountFrom	integer	Optional	Amount of the transaction. Min. amt.: $0.50
AmountTo	integer	Optional	Amount of the transaction. Min. amt.: $0.50
Status	string	Optional	Return’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning
CardLastFour	string	Optional	Card last four number.
TimeStampFrom	date	Optional	Return's TimeStamp.
TimeStampTo	date	Optional	Return's TimeStamp.
UserName	string	Optional	UserName.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/Returns/{exportable} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}'

{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Search
    {
        public static void SearchReturns()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/Returns/false");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    merchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    Status = "Transaction - Approved"                
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 500,
    "totalResults": 1,
    "cardSummary": null,
    "searchResultDTO": [
        {
            "status": "Transaction - Approved",
            "amount": 19.74,
            "card": {
                "cardHolderName": "John Doe",
                "cardType": "Mastercard",
                "last4": "0213"
            },
            "timeStamp": "2020-11-25T07:17:24.15-06:00",
            "processorStatusCode": "A0014",
            "batchStatus": "Batch - Closed",
            "userName": "maxduplessy",
            "guid": "9fb17f4e-b508-48d3-bd77-bb6813b42620",
            "deviceGuid": "b29725af-b067-4a35-9819-bbb31bdf8808",
            "saleGuid": "b4084e11-884d-468c-84d9-614c5b986fde",
            "type": "CreditReturn",
            "cardDataSource": "",
            "allowCardEmv": false
        }
    ]
}

Search authOnlys

POST/Search/AuthOnlys/{exportable}

This endpoint search an authOnlys.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
AmountFrom	integer	Optional	Amount of the transaction. Min. amt.: $0.50
AmountTo	integer	Optional	Amount of the transaction. Min. amt.: $0.50
CardLastFour	string	Optional	Card last four number.
CardHolderName	string	Optional	Cardholder's name.
CardType	string	Optional	Card Type.
InvoiceNumber	integer	Optional	AuthOnly's InvoiceNumber.
OrderNumber	string	Optional	AuthOnly's order number. Length = 17.
OrderDateFrom	date	Optional	AuthOnly's order Date.
OrderDateTo	date	Optional	AuthOnly's order Date.
TimeStampFrom	date	Optional	AuthOnly's TimeStamp.
TimeStampTo	date	Optional	AuthOnly's TimeStamp.
Status	string	Optional	AuthOnly’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning
MerchantCustomerId	string	Optional	Merchant Customer Id.
UserName	string	Optional	UserName.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/AuthOnlys/{exportable} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}'

{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Search
    {
        public static void SearchAuthOnlys()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/AuthOnlys/false");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    merchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    Status = "Transaction - Approved"
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 10,
    "totalResults": 1,
    "cardSummary": null,
    "searchResultDTO": [
        {
            "status": "Transaction - Approved",
            "amount": 10.00,
            "effectiveAmount": 10.00,
            "card": {
                "cardHolderName": "John Doe",
                "cardType": "Mastercard",
                "last4": "9426"
            },
            "orderNumber": "11518",
            "orderDate": "2020-11-24T00:00:00",
            "timeStamp": "2020-11-24T14:18:54.16-06:00",
            "customerId": "xt147",
            "processorResponseMessage": "Success",
            "batchStatus": "Batch - Closed",
            "relatedCapture": {
                "guid": "284dd923-a266-4d0f-80bd-e8441154c742",
                "newAmount": 10.00
            },
            "relatedVoid": null,
            "guid": "493cffed-232a-4896-b9ca-36b543d7da13",
            "deviceGuid": "b29725af-b067-4a35-9819-bbb31bdf8808",
            "partiallyApprovedAmount": null,
            "cardDataSource": "INTERNET",
            "allowCardEmv": false,
            "addressVerificationCode": "N",
            "addressVerificationResult": "No Match",
            "cvvVerificationCode": "M",
            "cvvVerificationResult": "Passed",
            "semiIntegrated": null,
            "userName": "maxduplessy"
        }
    ]
}

Search captures

POST/Search/Captures/{exportable}

This endpoint search a captures.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
NewAmountFrom	integer	Optional	NewAmount From of the transaction. Min. amt.: $0.50
NewAmountTo	integer	Optional	NewAmount To of the transaction. Min. amt.: $0.50
TimeStampFrom	date	Optional	Capture's TimeStamp From.
TimeStampTo	date	Optional	Capture's TimeStamp To.
Status	string	Optional	Capture’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning
UserName	string	Optional	UserName.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/Captures/{exportable} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}'

{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Search
    {
        public static void SearchCaptures()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/Captures/false");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    merchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    Status = "Transaction - Approved"
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 500,
    "totalResults": 1,
    "cardSummary": null,
    "searchResultDTO": [
        {
            "status": "Transaction - Approved",
            "authOnly": {
                "status": null,
                "amount": 10.00,
                "effectiveAmount": null,
                "card": {
                    "cardHolderName": "John Doe",
                    "cardType": "Mastercard",
                    "last4": "9426"
                },
                "orderNumber": "11518",
                "orderDate": "2020-11-24T00:00:00",
                "timeStamp": "0001-01-01T00:00:00",
                "customerId": null,
                "processorResponseMessage": null,
                "batchStatus": null,
                "relatedCapture": null,
                "relatedVoid": null,
                "guid": "493cffed-232a-4896-b9ca-36b543d7da13",
                "deviceGuid": "b29725af-b067-4a35-9819-bbb31bdf8808",
                "partiallyApprovedAmount": null,
                "cardDataSource": null,
                "allowCardEmv": false,
                "addressVerificationCode": null,
                "addressVerificationResult": null,
                "cvvVerificationCode": null,
                "cvvVerificationResult": null,
                "semiIntegrated": null,
                "userName": null
            },
            "newAmount": 10.00,
            "timeStamp": "2020-11-24T14:21:25.59-06:00",
            "processorResponseMessage": "Success",
            "batchStatus": "Batch - Closed",
            "guid": "284dd923-a266-4d0f-80bd-e8441154c742",
            "allowCardEmv": false,
            "userName": "maxduplessy"
        }
    ]
}

Search verify

POST/Search/Verifies/{exportable}

This endpoint search a verify.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
CardLastFour	string	Optional	Card last four number.
CardHolderName	string	Optional	Cardholder's name.
CardType	string	Optional	Card Type.
TimeStampFrom	date	Optional	Verify's TimeStamp From.
TimeStampTo	date	Optional	Verify's TimeStamp To.
Status	string	Optional	Verify’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning
UserName	string	Optional	UserName.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/Verifies/{exportable} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}'

{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Search
    {
        public static void SearchVerify()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/Verifies/false");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    merchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    Status = "Transaction - Approved"
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 500,
    "totalResults": 1,
    "cardSummary": null,
    "searchResultDTO": [
        {
            "status": "Transaction - Approved",
            "card": {
                "cardHolderName": "Justin Troudeau",
                "cardType": "Visa",
                "last4": "7402"
            },
            "timeStamp": "2020-11-25T07:24:25.29-06:00",
            "processorStatusCode": "A0000",
            "userName": "maxduplessy"
        }
    ]
}

Search Recurring Billings

POST/Search/RecurringBillings/{exportable}

This endpoint search a recurring billings.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
CardOnly	string	Optional	Card Only.
BankAccountOnly	string	Optional	Bank Account Only.
Status	string	Optional	Recurring billing status. Allowed values: 1. RecurringBilling - Active 2. RecurringBilling - Created - Local 3. RecurringBilling - Created - Error: Processor not reached 4. RecurringBilling - Created - Processor Fail 5. RecurringBilling - Deactivated 6. RecurringBilling - Paused 7. RecurringBilling - Finished 8. RecurringBilling - Deleted 9. RecurringBilling - Active Started
Name	string	Optional	Name.
AmountFrom	integer	Optional	amount from of the transaction. Min. amt.: $0.50
AmountTo	integer	Optional	amount to of the transaction. Min. amt.: $0.50
CreatedDateFrom	date	Optional	Created Date From RecurringBillings.
CreatedDateTo	date	Optional	Created Date To RecurringBillings.
BillingDateFrom	date	Optional	Created Billing Date From RecurringBillings.
BillingDateTo	date	Optional	Created Billing Date To RecurringBillings.
LastFour	string	Optional	LastFour.
RecurringBillingNumber	string	Optional	RecurringBillingNumber.
ScheduleNotes	string	Optional	ScheduleNotes.
ScheduleExceptions	string	Optional	ScheduleExceptions.
UserName	string	Optional	UserName.
AccountNumber	string	Optional	AccountNumber.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/RecurringBillings/{exportable} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}'

{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Search
    {
        public static void SearchRecurringBillings()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/RecurringBillings/false");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    merchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    Status = "Transaction - Approved"
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 10,
    "totalResults": 1,
    "cardSummary": null,
    "searchResultDTO": [
        {
            "status": "RecurringBilling - Active",
            "interval": "monthly",
            "intervalValue": "april, may, june",
            "amount": 10.50,
            "name": "John Doe",
            "recurringBillingNumber": "64942678",
            "startDate": "2021-05-13T00:00:00",
            "endDate": "2023-04-01T00:00:00",
            "paymentCount": null,
            "processorResponseMessage": null,
            "cardLastFour": "6019",
            "accountNumberLastFour": null,
            "timeStamp": "2020-11-25T14:31:38.6",
            "invoiceGuid": "00000000-0000-0000-0000-000000000000",
            "invoiceNumber": null,
            "guid": "11fd2d0a-298f-4387-81ed-ffd6780f7a21",
            "scheduleNotes": "Cable",
            "pause": null,
            "accountNumber": "",
            "pauseStartDate": null,
            "pauseEndDate": null,
            "userName": "maxduplessy"
        }
    ]
}

Search bank clearing

POST/Search/BankClearings/{exportable}

This endpoint search a bank clearings.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
Status	string	Optional	Bank clearing’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning
TotalAmountFrom	integer	Optional	Total amount from of the transaction. Min. amt.: $0.50
TotalAmountTo	integer	Optional	Total amount to of the transaction. Min. amt.: $0.50
NameOnAccount	string	Optional	Account's name.
RoutingNumber	integer	Optional	Routing's number. Must be 9 characters (example: 490000018).
AccountNumberLastFour	integer	Optional	Account's number last four.
FromRecurringBilling	boolean	Optional	From RecurringBilling.
TimeStampFrom	date	Optional	Bank clearing's TimeStamp.
TimeStampTo	date	Optional	Bank clearing's TimeStamp.
MerchantCustomerId	string	Optional	Merchant Customer Id.
UserName	string	Optional	UserName.
SettlementStatus	string	Optional	Settlement’s status. Allowed values: 1.Pending 2. Debit Sent 3. Credit Sent 4. Chargeback 5. Not Available 6. No Credit 7. Voided 8. Returned 9. Cancelled

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/BankClearings/{exportable} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}'

{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Search
    {
        public static void SearchBankClearing()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/BankClearings/false");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    merchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    Status = "Transaction - Approved"
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 1,
    "totalResults": 1,
    "cardSummary": null,
    "searchResultDTO": [
        {
            "status": "Transaction - Approved",
            "amount": 8.99,
            "effectiveAmount": 0,
            "bankAccount": {
                "nameOnAccount": "ddd dddd",
                "routingNumber": "490000018",
                "lastFour": "2323"
            },
            "timeStamp": "2018-11-09T07:24:32.52-03:00",
            "fromRecurringBilling": false,
            "customerId": null,
            "processorResponseMessage": "APPROVED | APPROVAL | AUTH NUM 272-172 | [(4096): Internal Override] | [(0): ] | T:2010",
            "relatedVoid": null,
            "relatedReturn": null,
            "guid": "3d97cf24-bd0e-47e6-9e4c-7613f9a98d7f",
            "deviceGuid": "572c0d53-b8de-4710-9837-a06657928430",
            "responseTransactionStatus": null,
            "responseSettlementStatus": null
        }
    ]
}

Search bank clearing voids

POST/Search/BankClearingVoids/{exportable}

This endpoint search a bank clearing voids.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
TimeStampFrom	date	Optional	Bank clearing void's TimeStamp.
TimeStampTo	date	Optional	Bank clearing void's TimeStamp.
Status	string	Optional	Bank clearing void’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning
UserName	string	Optional	UserName.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/BankClearingVoids/{exportable} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}'

{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Search
    {
        public static void SearchBankClearingVoids()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/BankClearingVoids/false");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    merchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    Status = "Transaction - Approved"
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 1,
    "totalResults": 1,
    "cardSummary": null,
    "searchResultDTO": [
        {
            "status": "Transaction - Approved",
            "relatedClearing": {
                "status": null,
                "amount": 10.5,
                "effectiveAmount": 0,
                "bankAccount": {
                    "nameOnAccount": "Jorge Pedro",
                    "routingNumber": "490000018",
                    "lastFour": "1555"
                },
                "timeStamp": "0001-01-01T00:00:00",
                "fromRecurringBilling": null,
                "customerId": null,
                "processorResponseMessage": null,
                "relatedVoid": null,
                "relatedReturn": null,
                "guid": "00000000-0000-0000-0000-000000000000",
                "deviceGuid": "00000000-0000-0000-0000-000000000000",
                "responseTransactionStatus": null,
                "responseSettlementStatus": null
            },
            "timeStamp": "2018-11-09T10:15:02",
            "processorResponseMessage": "APPROVED | VOID ACCEPTED | VOID ACCEPTED | [(5120): Voided Check | Internal Override] | [(0): ] | T:2010",
            "guid": "23860c1a-29e2-4203-a4ab-a87a6c5315e0"
        }
    ]
}

Search bank clearing returns

POST/Search/BankClearingReturns/{exportable}

This endpoint search a bank clearing returns.

Remember you will need to use an authentication token or the API Key in the header request for every transaction.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

URL Parameters:

Parameter	Type	M/C/O	Value
Exportable	string	Mandatory	True or False. It means if you want results exportable to CSV.
PageNumber	integer	Optional	Int. Number of page of the results. Default is 1 (Page size default is 500).
PageSize	integer	Optional	Int. Size of each page of the results. Default is 500.

Json Body:

Parameter	Type	M/C/O	Value
MerchantGuid	string	Mandatory	Merchant's Guid.
TimeStampFrom	date	Optional	Bank clearing void's TimeStamp.
TimeStampTo	date	Optional	Bank clearing void's TimeStamp.
Status	string	Optional	Bank clearing void’s status. Allowed values: 1. Transaction - Approved 2. Transaction - Declined 3. Transaction - Created - Local 4. Transaction - Created - Error: Processor not reached 5. Transaction - Processor Error 6. Transaction - Approved - Warning
UserName	string	Optional	UserName.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/Search/BankClearingReturns/{exportable} \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}'

{
    "merchantGuid": "19344275-985e-4dff-81ee-cb84b8ad356c",
    "Status": "Transaction - Approved"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Search
    {
        public static void SearchBankClearingReturns()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/Search/BankClearingReturns/false");
                request.ContentType = "text/json";
                request.Method = "POST";

                var search = new
                {
                    merchantGuid = "19344275-985e-4dff-81ee-cb84b8ad356c",
                    Status = "Transaction - Approved"
                };

                string json = JsonConvert.SerializeObject(search);

                request.Headers.Add("Authorization", "Bearer 1A089D6ziUybPZFQ3mpPyjt9OEx9yrCs7eQIC6V3A0lmXR2N6-seGNK16Gsnl3td6Ilfbr2Xf_EyukFXwnVEO3fYL-LuGw-L3c8WuaoxhPE8MMdlMPILJTIOV3lTGGdxbFXdKd9U03bbJ9TDUkqxHqq8_VyyjDrw7fs0YOob7bg0OovXTeWgIvZaIrSR1WFR06rYJ0DfWn-Inuf7re1-4SMOjY1ZoCelVwduWCBJpw1111cNbWtHJfObV8u1CVf0");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        } 
    }
}

Response

{
    "pageCurrent": 1,
    "pageCurrentResults": 1,
    "pageTotal": 1,
    "pageSize": 500,
    "totalResults": 1,
    "cardSummary": null,
    "searchResultDTO": [
        {
            "status": "Transaction - Approved",
            "relatedClearing": {
                "status": null,
                "amount": 24.99,
                "effectiveAmount": 0,
                "bankAccount": {
                    "nameOnAccount": "Javier Ricardo",
                    "routingNumber": "490000018",
                    "lastFour": "8456"
                },
                "timeStamp": "0001-01-01T00:00:00",
                "fromRecurringBilling": null,
                "customerId": null,
                "processorResponseMessage": null,
                "relatedVoid": null,
                "relatedReturn": null,
                "guid": "00000000-0000-0000-0000-000000000000",
                "deviceGuid": "00000000-0000-0000-0000-000000000000",
                "responseTransactionStatus": null,
                "responseSettlementStatus": null
            },
            "timeStamp": "2017-11-21T15:04:57.24",
            "processorResponseMessage": "APPROVED | REVERSAL ACCEPTED | REVERSAL ACCEPTED | [(5120): Voided Check | Internal Override] | [(0): ] | T:2315",
            "guid": "6971e562-0c65-4f25-bc24-edbf6da92751"
        }
    ]
}

Payment Link

Create Payment Link

POST/HostedPaymentPageRequests/PaymentLink

The payment link feature allows merchants to generate a secure, single-use payment link that can be shared with customers to complete a one-time payment online using a Credit Card or ACH payment method.

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
Amount	decimal	Mandatory	Items total amount.
Email	string	Mandatory	Customer's valid email address.
Phone	integer	Mandatory	Customer's phone number. The phone number must be syntactically correct. For example, 4152345678.
Description	string	Mandatory	Items description.
DeviceCreditCardGuid	string	Conditional	Device's guid Credit Card. Do not send together with DeviceAchGuid.
DeviceAchGuid	string	Conditional	Device's guid Ach. Do not send together with DeviceCreditCardGuid.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/HostedPaymentPageRequests/PaymentLink \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 10.00,
    "email": "maxmerchant@mailinator.com",
    "phone": "3265852255",
    "description": "Description",
    "deviceCreditCardGuid": "b395d18f-af5d-4b69-8258-1dfd2e444c62"
}'

{
    "amount": 10.00,
    "email": "maxmerchant@mailinator.com",
    "phone": "3265852255",
    "description": "Description",
    "deviceCreditCardGuid": "b395d18f-af5d-4b69-8258-1dfd2e444c62"
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class PaymentLink
    {
        public static void PaymentLink()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/HostedPaymentPageRequests/PaymentLink");
                request.ContentType = "text/json";
                request.Method = "POST";

                var paymentLink = new
                {
                    Amount = 10.00,
                    Email = "maxmerchant@mailinator.com",
                    Phone = "3265852255",
                    Description = "Description",
                    DeviceCreditCardGuid = "b395d18f-af5d-4b69-8258-1dfd2e444c62"
                };

                string json = JsonConvert.SerializeObject(paymentLink);

                request.Headers.Add("Authorization", "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6EBqB7RFjVMuhmuPNWcYM7ozyMb3uaDe0gyDL_nMPESbuM5I4skBOYcUM4A06NO88CVV3yBYee7mWB1qT-YFu5A3KZJSfRIbTX9GZdrZpi-JuWsx-7GE9GIYrNJ29BpaQscTwxYDr67WiFlCCrsCqWnCPJUjCFRIrTDltz8vM15mlgjiO0y04ZACGOWNNErIVegX062oydV7SqumGJEbS9Av4gdy");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }  
    }
}

Response

{
    "description": "Description",
    "amount": 10,
    "otherUrl": "https://websandbox.surepay.co/hosted-payment/results/fail",
    "successUrl": "https://websandbox.surepay.co/hosted-payment/results/success",
    "cancelUrl": "https://websandbox.surepay.co/hosted-payment/results/cancel",
    "tempToken": "6e3b10fc-9804-4d59-a8be-c16eb64b8566",
    "status": "PaymentLink - Active",
    "url": "https://websandbox.surepay.co/hosted-payment/6e3b10fc-9804-4d59-a8be-c16eb64b8566"
}

Hosted Payment Page

POST/HostedPaymentPageRequests

If the transaction gets approved the user will be redirected back to your site, sending a POST to the SuccessURL with the following parameters.

If the transaction goes wrong the user will be redirected back to your site, sending a POST to OtherURL with the following parameters

The hosted payment page feature allows online and small merchants to redirect via a checkout button at their website visitors who wish to purchase items, pay invoices or make any type or transaction credit or ACH (if enabled).

To do this, simply POST to the following address using the following parameters and get your temporal token back. Then GET to our Hosted Payment Page using that temporal token and we care about the rest. This streamlines the checkout process and helps protect shoppers’ sensitive payment account data.

Enjoy a seamless checkout experience that automatically routes them to a secure page, branded with your company name. The customer enters their payment data directly into our server, releasing you of the responsibility of receiving, storing and transmitting sensitive cardholder data.

If the transaction gets approved the user will be redirected back to your site, sending a POST to the SuccessURL with the parameters on the Json sample.

If the transaction goes wrong the user will be redirected back to your site, sending a POST to OtherURL with the parameters on the Json sample.

Go to https://websandbox.surepay.co/hosted-payment/{{tempToken}}

Headers using token

Key	Value
Content-Type	"application/json"
Authorization	Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."

Headers using API Key

Key	Value
Content-Type	"application/json"
UserAuthorization	API Key. Eg: "e516b6db-3230-4b1c-ae3f-e5379b774a80"

Query Parameters

Parameter	Type	M/C/O	Value
DeviceCreditCardGuid	string	Mandatory	Device's guid Credit Card.
DeviceAchGuid	string	Mandatory	Device's guid Ach.
Merchantname	string	Mandatory	Merchant's name.
Description	string	Mandatory	Items description.
Amount	string	Mandatory	Items total amount.
OtherURL	string	Mandatory	Web page you want to redirect the user in case something failed.
SuccessURL	string	Mandatory	Web page you want to redirect the user when transaction was successful.
CancelURL	string	Mandatory	Web page you want to redirect the user in case he decided to cancel the transaction.
OtherInfo	string	Optional	Any alphanumeric code you might want to send to see it on the confirmation's response to keep track of your sales.
IsButton	boolean	Optional	Determines if the hosted payment page request will be used as a button (allows multiple payments for the same request or not).
ButtonLabel	string	Optional	This will be the text shown on your button (For example: "Pay here", "Donate").
Html	string	optional	Provide the html code you will use to share the button on your website.
Customer	object	Optional	See Customer.
RecurringBilling	object	Optional	See Recurring Billing for details.
Invoice	object	Optional	See Invoice for details.
CustomFieldConfigurations	object	Optional	See Custom Field Configurations.

Request

curl -X POST https://apisandbox.surepay.co/api/v1/HostedPaymentPageRequests \
  -H "Authorization: Bearer $SUREPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "DeviceCreditCardGuid": "4b5013f7-b275-4929-8e83-0167c6edf639",
    "DeviceAchGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
    "Merchantname": "StarCoffe",
    "Description": "coffe latte",
    "Amount": "7.50",
    "OtherURL": "http://StarCoffe/other",
    "SuccessURL": "http://StarCoffe/success",
    "CancelURL": "http://StarCoffe/cancel",
    "OtherInfo": "Energy tax",
    "Customer": {
        "FirstName": "Max",
        "LastName": "Duplessy",
        "Phone": "8741234745",
        "City": "New York",
        "State": "NY",
        "Email": "maxduplessy@mailinator.com",
        "Address1": "110 10th Av.",
        "Address2": "",
        "Zip": "10016"
    }
}'

{
    "DeviceCreditCardGuid": "4b5013f7-b275-4929-8e83-0167c6edf639",
    "DeviceAchGuid": "386ac1e6-250d-4866-b283-248c1e9340ef",
    "Merchantname": "StarCoffe",
    "Description": "coffe latte",
    "Amount": "7.50",
    "OtherURL": "http://StarCoffe/other",
    "SuccessURL": "http://StarCoffe/success",
    "CancelURL": "http://StarCoffe/cancel",
    "OtherInfo": "Energy tax",
    "Customer": {
        "FirstName": "Max",
        "LastName": "Duplessy",
        "Phone": "8741234745",
        "City": "New York",
        "State": "NY",
        "Email": "maxduplessy@mailinator.com",
        "Address1": "110 10th Av.",
        "Address2": "",
        "Zip": "10016"
    }
}

using System;
using Newtonsoft.Json;
using System.IO;
using System.Net;
using System.Text;

namespace SurePaySample
{
    public class Account
    {
        public static void HostedPaymentPage()
        {
            try
            {
                var request = (HttpWebRequest)WebRequest.Create("https://apisandbox.surepay.co/api/v1/HostedPaymentPageRequests");
                request.ContentType = "text/json";
                request.Method = "POST";

                var payment = new
                {
                    DeviceCreditCardGuid = "4b5013f7-b275-4929-8e83-0167c6edf639",
                    DeviceAchGuid = "386ac1e6-250d-4866-b283-248c1e9340ef",
                    Merchantname = "StarCoffe",
                    Description = "coffe latte",
                    Amount = "7.50",
                    OtherURL = "http://StarCoffe/other",
                    SuccessURL = "http://StarCoffe/success",
                    CancelURL = "http://StarCoffe/cancel"
                    OtherInfo = "Energy tax",
                    Customer = new
                    {
                        FirstName = "Max",
                        LastName = "Duplessy",
                        Phone = "8741234745",
                        City = "New York",
                        State = "NY",
                        Email = "maxduplessy@mailinator.com",
                        Address1 = "110 10th Av.",
                        Address2 = "",
                        Zip = "10016"
                    }
                };

                string json = JsonConvert.SerializeObject(payment);

                request.Headers.Add("Authorization", "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6EBqB7RFjVMuhmuPNWcYM7ozyMb3uaDe0gyDL_nMPESbuM5I4skBOYcUM4A06NO88CVV3yBYee7mWB1qT-YFu5A3KZJSfRIbTX9GZdrZpi-JuWsx-7GE9GIYrNJ29BpaQscTwxYDr67WiFlCCrsCqWnCPJUjCFRIrTDltz8vM15mlgjiO0y04ZACGOWNNErIVegX062oydV7SqumGJEbS9Av4gdy");
                request.ContentType = "application/json";
                request.Accept = "application/json";

                using (var streamWriter = new StreamWriter(request.GetRequestStream()))
                {
                    streamWriter.Write(json);
                    streamWriter.Flush();
                    streamWriter.Close();
                }

                try
                {
                    var response = (HttpWebResponse)request.GetResponse();
                    using (var reader = new StreamReader(response.GetResponseStream()))
                    {
                        string result = reader.ReadToEnd();
                        Console.Write((int)response.StatusCode);
                        Console.WriteLine();
                        Console.WriteLine(response.StatusDescription);
                        Console.WriteLine(result);
                    }
                }
                catch (WebException wex)
                {
                    if (wex.Response != null)
                    {
                        using (var errorResponse = (HttpWebResponse)wex.Response)
                        {
                            using (var reader = new StreamReader(errorResponse.GetResponseStream()))
                            {
                                string result = reader.ReadToEnd();
                                Console.Write((int)errorResponse.StatusCode);
                                Console.WriteLine();
                                Console.WriteLine(errorResponse.StatusDescription);
                                Console.WriteLine(result);
                            }
                        }
                    }
                }
            }
            catch (IOException e)
            {
                Console.WriteLine(e);
            }
        }  
    }
}

Response

{
    "merchantname": "StarCoffe",
    "description": "coffe latte",
    "amount": 7.50,
    "otherURL": "http://StarCoffe/other",
    "successURL": "http://StarCoffe/success",
    "cancelURL": "http://StarCoffe/cancel",
    "tempToken": "69337810-182e-4afe-a9d9-7268def789c7",
    "expiration": "2120-11-26T15:01:06.75",
    "otherInfo": "Energy tax",
    "customer": {
        "guid": "8144d441-acf2-4549-98cb-bab762675423",
        "firstName": "Max",
        "lastName": "Duplessy",
        "address1": "110 10th Av.",
        "address2": "",
        "zip": "10016",
        "city": "New York",
        "state": "NY",
        "phone": "8741234745",
        "email": "maxduplessy@mailinator.com"
    }
}

Custom Field Configurations

Create Custom Field Configurations

Query Parameters

Parameter	Type	M/C/O	Value
number	integer	Mandatory	Sequential identifier or position number of the custom field configuration.
label	string	Mandatory	Display name or label shown for the custom field.
required	boolean	Mandatory	Indicates whether the custom field must be completed by the user.
type	string	Mandatory	Defines the custom field type. Allowed values are: Text or Dropdown.
dropDownValues	string	Mandatory	List of selectable values available when the field type is Dropdown. Use an empty array for non-dropdown fields.
disabled	boolean	Mandatory	Indicates whether the custom field is disabled and cannot be edited or used.
value	string	Optional	Default value.

Request

"customFieldConfigurations": [
  {
    "number": 1,
    "label": "Customer Name",
    "required": true,
    "type": "Text",
    "dropDownValues": [],
    "disabled": false
  },
  {
    "number": 2,
    "label": "Department",
    "required": true,
    "type": "Dropdown",
    "dropDownValues": [
      "Sales",
      "Finance",
      "Operations"
    ],
    "disabled": false,
    "value": "Finance"
  }
]

Payment Token JS

Integration example for script tag:

Integration example for your script:

Response examples:

Example form page for integration:

Token JS is a JavaScript framework that allows merchants to collect credit card information from their customers without exposing their website to PCI compliance and therefore avoiding the requirements of PCI.

This can be done while allowing merchants to retain full control over the look and feel of their checkout experience.

This is a data collection and tokenization system, not a full payments API, once a token is obtained you would need to integrate to the standard payment API but rather than collecting full credit card information, the merchant will submit the token obtained by the Token.js system.

https://websandbox.surepay.co/assets/payment/Token.js

https://webportal.surepay.co/assets/payment/Token.js

Script tag properties

Property	M/C/O	Value	Description
src	Mandatory	Token js url	URL location of the JavaScript code to import into your solution.
id	Mandatory	gtwPayment	A mandatory field that represents the script tag name to be used on your checkout page.
user-api-key	Mandatory	Api Key	User API Key issued by your gateway processor.
merch-device-guid	Mandatory	Device Guid	Device GUID issued by your gateway processor.
merch-sys-alert	Optional	true/false	When enabled system will display an error alert for any exceptions or errors. If set to false, ISV should handle events at checkout.
merch-style-class	Optional	string	Name of the class you wish to apply to input text boxes to match your checkout pages look and feel.
sys-environment	Mandatory	sandbox/production	This value identifies the environment to use.

No request body.

Appendix

Card

Query Parameters

Parameter	Type	M/C/O	Value
CardNumber	string	Mandatory	Card number. Must be 16 characters. (example: 4532538795426624) or token (example: FfL7exC7Xe2y6624). See token.
CardHolderName	string	Optional	Cardholder's name.
Cvv2	integer	Optional	This is the three or four digit CVV code at the back side of the credit and debit card.
ExpirationDate	date	Mandatory	Card's expiry date in the YYMM format.
Customer	object	Optional	See Customer.

No request body.

Test Cards

Parameters

VISA	MASTERCARD	Discover	Amex
4012000098765439	5146315000000055	6011000993026909	371449635392376
4012881888818888	5146312200000035	—	—
4716783102838529	5282265190260890	6011960117941160	377027056060401
4444333322221111	5536350678530461	38555565010005	370295101114559
4284017409968669	5550000000000003	6011027500001232	—
4049765406537244	5525000000000054	6011201300002340	—
4778499702783735	5146350000000003	—	—
4000000000000002	5146312400000025	—	—
4818690480136615	5146312200000035	—	—
4005578000000838	5146312620000045	—	—
—	5146315000000055	—	—
—	5146311340000061	—	—
—	5146311550000066	—	—
—	5499740000000057	—	—
—	5146312800000070	—	—
—	5146312700000071	—	—
—	5272320502277140	—	—

No request body.

CVV

Parameters

Card Brand	Column 2	Column 3
Visa	999	—
MasterCard	998	—
Discover	996	—
Amex	9997	—

No request body.

BankAccount

Query Parameters

Parameter	Type	M/C/O	Value
RoutingNumber	integer	Mandatory	Routing's number. Must be 9 characters (example: 490000018).
AccountNumber	integer	Mandatory	Account's number.
NameOnAccount	string	Mandatory	Account's name.
Customer	object	Optional	See Customer.

No request body.

Customer

Query Parameters

Parameter	Type	M/C/O	Value
FirstName	string	Optional	Customer's first name.
LastName	string	Optional	Customer's last name.
Phone	integer	Optional	Customer's phone number. The phone number must be syntactically correct. For example, 4152345678.
City	string	Optional	Customer's city.
State	string	Optional	Customer's short name state. The ISO 3166-2 CA and US state or province code of a customer. Length = 2.
Country	string	Optional	Customer's country. The ISO country code of a customer’s country. Length = 2 or 3.
Email	string	Optional	Customer's valid email address.
Address1	string	Optional	Customer's address.
Address2	string	Optional	Customer's address line 2.
Zip	integer	Optional	Customer's zipcode. Length = 5.
DateOfBirth	date	Optional	Customer's date of birth. Allowed format: YYYY-MM-DD. For example: 2002-05-30
DriverLicenseNumber	integer	Optional	Customer's driver license number.
DriverLicenseState	string	Conditional	Customer's driver license short name state. The ISO 3166-2 CA and US state or province code of a customer. Length = 2. Mandatory when DriverLicenseNumber is provided.
SSN4	integer	Conditional	Customer's social security number. Mandatory when DOB is not submitted.

No request body.

EnhancedData

Query Parameters

Parameter	Type	M/C/O	Value
SaleTax	decimal	Optional	Transaction's amount.
AdditionalTaxDetailTaxCategory	string	Optional	Tax Category.
AdditionalTaxDetailTaxType	string	Optional	Tax Type.
AdditionalTaxDetailTaxAmount	decimal	Optional	Tax Amount.
AdditionalTaxDetailTaxRate	decimal	Optional	Tax Rate.
PurchaseOrder	string	Optional	Purchase Order.
OrderDate	date	Optional	Order Date.
ShippingCharges	decimal	Optional	Shipping Charges.
DutyCharges	decimal	Optional	Duty Charges.
CustomerVATNumber	integer	Optional	Customer VAT Number.
VATInvoice	integer	Optional	VAT Invoice.
SummaryCommodityCode	string	Optional	Summary Commodity Code.
ShipToZip	integer	Optional	Ship To Zip.
ShipFromZip	integer	Optional	Ship From Zip.
DestinationCountryCode	string	Optional	Destination Country Code.
SupplierReferenceNumber	integer	Optional	Supplier Reference Number.
CustomerRefID	integer	Optional	Customer Ref ID.
ChargeDescriptor	string	Optional	Charge Descriptor.
AdditionalAmount	decimal	Optional	Additional Amount.
AdditionalAmountType	string	Optional	Additional Amount Type.
ProductName	string	Optional	Product Name.
ProductCode	string	Optional	Product Code.
Price	string	Optional	Price.

No request body.

Details

Query Parameters

Parameter	Type	M/C/O	Value
ItemDescription	string	Mandatory	Item Description.
Rate	decimal	Mandatory	Rate.
Quantity	integer	Mandatory	Quantity.

No request body.

Level 2 & Level 3

Level 2 and Level 3 rates apply exclusively to commercial card products (not standard consumer credit/debit).

Supported on most commercial credit products (business, corporate, purchasing, government) for B2B/B2G transactions; requires mid‑level fields such as tax amount.

Restricted to purchasing, corporate, fleet, and government cards used in B2B/B2G; requires detailed line‑item data such as Product code, quantity, shipping charges, ship‑to & from zip, etc.

Business (small‑business) credit cards issued to companies for expenses Corporate cards (T&E, general corporate spend) Purchasing / procurement cards (P‑cards) Fleet cards (fuel, vehicle expenses, often a purchasing sub‑type) Government/commercial purchasing cards used by public sector entities

Consumer personal credit cards (classic, gold, platinum, rewards) Consumer debit cards (online PIN, offline/signature debit) Prepaid and gift cards For these card types, even if you submit Level 2/3 fields, the networks treat them as standard Level 1 transactions and apply normal consumer interchange.

The fields that qualify a transaction for Level 2 Interchange rates are:

The fields that qualify a transaction for Level 3 Interchange rates are:

Allowed Values:

ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, STP, SUR, SVK, SVN, SWE, SWZ, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, UK, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW, BES, BQ, CUW, CW, SXM, SX, SSD, SS, ANT, AN, PRK

Qualifying Level 2 Fields

Field	Visa	Mastercard	AMEX	Additional Comments
Amount	Required	Required	Required	Format: Numeric Max Length=12 Allowed characters: 0-9 .(dot)
EnhancedData.saleTax	Required	Required	Required	Format: Numeric Max Length=12 Allowed characters: 0-9 .(dot)
EnhancedData.CardLevel	Required	Required	Required	Format: Numeric Allowed Values: 2,3 Description: For Level 2 send value of 2
EnhancedData.purchaseOrder	Required	Required	Not Supported	Format: Alphanumeric Min Length=0 Max Length=25 Allowed characters: a-z A-Z 0-9 Space
EnhancedData.chargeDescriptor	Not Supported	Not Supported	Required	Format: Alphanumeric and Special Character Min Length=0 Max Length=40 Description: Displays descriptive information about a transaction on a customer's AMEX statement.
EnhancedData.customerRefID	Not Supported	Not Supported	Required	Format: Alphanumeric and Special Character Min Length=0 Max Length=17 a-z A-Z 0-9 Space <>
EnhancedData.supplierReferenceNumber	Not Supported	Not Supported	Optional	Format: Alphanumeric and Special Character Min Length=0 Max Length=9 Allowed characters: a-z A-Z 0-9 Space <> Description: This field contains a reference number that is used by American Express to obtain supporting information on a charge from a merchant. The number can be any combination of characters and numbers defined by the merchant.
EnhancedData.shipToZip	Not Supported	Not Supported	Optional	Format: Alphanumeric Min Length=2 Max Length=10

Qualifying Level 3 Fields

Field	Visa	Mastercard	Additional Comments
Amount	Required	Required	Format: Numeric Max Length=12 Allowed characters: 0-9 .(dot)
EnhancedData.saleTax	Required	Required	Format: Numeric Max Length=12 Allowed characters: 0-9 .(dot) Note: If a decimal point is included, the amount reflects a dollar value. If a decimal point is not included, the amount reflects a cent value.
EnhancedData.AdditionalTaxDetailTaxType	Optional	Optional	Format: Alphanumeric and Special Character Description: The type of tax. For example, VAT, NATIONAL, Service Tax.
EnhancedData.AdditionalTaxDetailTaxAmount	Optional	Optional	Format: Numeric Max Length=12 Allowed characters: 0-9 .(dot) Note: If a decimal point is included, the amount reflects a dollar value. If a decimal point is not included, the amount reflects a cent value.
EnhancedData.AdditionalTaxDetailTaxRate	Optional	Optional	Format: Decimal Number Max Length=4 Allowed characters: 0-9 .(dot) Allowed range: 0.01 - 100
EnhancedData.AdditionalTaxDetailTaxCategory	Optional	Optional	Format: Alphanumeric Enumeration: Allowed Values: SERVICE, DUTY, VAT, ALTERNATE, NATIONAL, TAX_EXEMPT Description: The type of tax.
EnhancedData.shippingCharges	Optional	Optional	Format: Numeric Max Length=12 Allowed characters: 0-9 .(dot) Note: If a decimal point is included, the amount reflects a dollar value. If a decimal point is not included, the amount reflects a cent value.
EnhancedData.dutyCharges	Optional	Optional	Format: Numeric Max Length=12 Allowed characters: 0-9 . (dot) Note: If a decimal point is included, the amount reflects a dollar value. If a decimal point is not included, the amount reflects a cent value.
EnhancedData.CardLevel	Required	Required	Format: Numeric Allowed Values: 2, 3 Description: For Level 3 send value of 3
EnhancedData.purchaseOrder	Required	Required	Format: Alphanumeric Min Length=0 Max Length=25 Allowed characters: a-z A-Z 0-9 Space
EnhancedData.customerVATNumber	Optional	Not Supported	Format: Alphanumeric and Special Character Min Length=0 Max Length=13 a-z A-Z 0-9 Space <> Description: Indicates the customer's government assigned tax identification number or the identification number assigned to their purchasing company by the tax authorities.
EnhancedData.orderDate	Required	Required	Format: Alphanumeric and Special Character Min Length=0 Max Length=10 Allowed format: MM/DD/YYYY For example: 12/01/2016
EnhancedData.summaryCommodityCode	Optional	Optional	Format: Alphanumeric and Special Character Min Length=0 Max Length=4 Allowed character: a-z A-Z 0-9 Space <> Description: The international description code of the overall goods or services being supplied.
EnhancedData.vatInvoice	Optional	Optional	Format: Alphanumeric and Special Character Min Length=0 Max Length=15 Allowed character: a-z A-Z 0-9 Space <> Description: The Value Added Tax (VAT) invoice number associated with the transaction.
EnhancedData.shipFromZip	Optional	Optional	Format: Alphanumeric Min Length=2 Max Length=10
EnhancedData.shipToZip	Optional	Optional	Format: Alphanumeric Min Length=2 Max Length=10
EnhancedData.destinationCountryCode	Optional	Optional	Format: Alphanumeric Enumeration: Allowed Values: See country codes.
EnhancedData.productCode	Required	Required	Format: Alphanumeric and Special Character Min Length=1 Max Length=20 Allowed special characters: (Space) , / , -
EnhancedData.productName	Required	Required	Format: Alphanumeric and Special Character Min Length=1 Max Length=50 Allowed special characters: (Space) <> , Slash / , Hyphen <-> , Comma <,>
EnhancedData.price	Required	Required	Format: Numeric Max Length=12 Allowed characters: 0-9 .(dot)
EnhancedData.quantity	Required	Required	Format: Decimal Number Max Length=12
EnhancedData.productCommodityCode	Optional	Not Supported	Format: Alphanumeric Min Length=0 Max Length=12 Allowed characters: a-z A-Z 0-9 (Space)
EnhancedData.measurementUnit	Required	Required	Format: Alphanumeric and Special Character Min Length=0 Max Length=20

No request body.

Declined Response Codes

Code	Response Message	Description
D0001	Duplicate Request (Approved previously)	The transaction was already performed and approved. Verify if the request was submitted twice for the same transaction ID or external reference number.
D0003	Duplicate Request (Declined previously)	The transaction was already performed and declined. Verify if the request was submitted twice for the same transaction ID or external reference number.
D0004	Reversal Not Allowed	The transaction is not authorized for reversal. This error may occur because the transaction was not settled, was declined, or already reversed.
D0005	Return Not Allowed	The transaction is not authorized for return. This error may occur because the transaction was not settled, was declined, or already reversed.
D0006	Supervisor Override Required	—
D0007	Modify Transaction Not Allowed	The transaction is not authorized for modification. This error may occur because the transaction was already settled, or was declined.
D0008	Possible Duplicate Request	This is a duplicate request. The credentials for this transaction (i.e. amount, card number or same service) are the same as another transaction submitted less than one minute apart.
D0009	Duplicate Request (Reversed previously)	The request with the same credentials (amount, card number, or same service) hit the server twice within a minute.
E0010	Inactive Device (Terminal)	The device is not registered, or is inactive in the system.
E0011	Device (Terminal) Configuration missing	The configuration parameter is missing.
E0012	Insufficient privileges	—
E0013	Incremental Auth Not Allowed	—
E0015	Unable to process your request. Settlement InProgress.	The transaction settlement is in progress.
E0016	Functionality currently not available.	The functionality is not supported.
E0020	Inactive Merchant (Account)	The merchant is not registered, or is inactive in the system.
E0021	Merchant (Account) configuration missing	The configuration parameter is missing.
E0022	Processor configuration missing	The processor parameter is missing.
D0023	Merchant already active	—
E0030	Unique ID Error The terminal unique ID is invalid, or is not registered in the system.	—
D0050	Inactive terminal (Backend)	The device is inactive, or is not registered at the host.
D0060	Inactive account (Backend)	The account is inactive, or is not registered at the host.
D0070	Unique ID Error (Backend)	The terminal unique ID is invalid, or is not registered at the host.
D0080	Duplicate Request (Backend)	This is a duplicate transaction. This transaction was already approved and processed.
D0090	Reversal Not Allowed (Backend)	The transaction is not authorized for reversal. This error may occur because the transaction was settled, declined, or already reversed.
D0091	Return Not Allowed (Backend)	The transaction is not authorized for return. This error may occur because the transaction was settled, declined, or already reversed.
D0092	Request Format Error (Backend)	—
D0093	Encryption failure from host	—
D0094	Return not allowed, Card number requested does not match with original transaction card number	—
D0095	Invalid taskID	—
D0096	Currency code mismatch with original transaction	—
D0097	Multiple amount format in single request not supported	—
D0098	Multiple tax with same tax type is not allowed.	A request includes multiple tax with same tax type.
E0110	System Error (BillParam)	—
E0111	System Error (UBillACC)	—
E0200	System Error (Tran)	—
E0201	System Error (BillpayTran)	—
E0202	System Error (CardTran)	—
E0203	System Error (CheckTran)	—
E0204	System Error (MTTran)	—
E0205	System Error (MOTran)	—
E0206	System Error (AccTran)	—
E0207	System Error (Shipping_Info Tran)	—
E0208	System Error (Products Tran)	—
E0209	System Error (Override Tran)	—
E0210	System Error (PayMode Tran)	—
E0300	System Error (UTran)	—
E0301	System Error (BillpayUTran)	—
E0302	System Error (CardUTran)	—
E0303	System Error (CheckUTran)	—
E0304	System Error (MTUTran)	—
E0305	System Error (MoUTran)	—
E0306	System Error (ACCUTran)	—
E0310	System Error (BillPay WAY UTran)	—
E0311	System Error (BillPay WAY Seq)	—
E0350	System Error (UTranStatus)	—
E0360	System Error (PERIUTran)	—
E0370	System Error (SearchTran)	—
E0380	System Error (chkc history)	—
E0400	System Error (Login)	—
E0450	System Error (NoFee)	—
E0451	System Error (GetFEE)	—
E0460	System Error (EXRate)	—
E0470	System Error (PhCountry)	—
E0480	System Error (PrePay Number)	—
E0481	System Error (PrePay update)	—
E0482	System Error (PrePay List)	—
E0490	System Error (Bin Lookup)	—
E0491	System Error (Merchant Bin Lookup)	—
E0500	System Error (BrdCorp)	—
E0501	System Error (BrdMer)	—
E0502	System Error (Upate DeviceProc)	—
E0503	System Error (Upate MerchProductProc)	—
E0504	System Error (Upate LogoProc)	—
E0510	System Error (Upate MerchantProc)	—
E0511	System Error (Upate OperatorProc)	—
E0550	System Error (Search Corporation)	—
E0551	System Error (Search Merchant)	—
E0560	System Error (Modify Schedule)	—
E0561	System Error (Modify Payment)	—
E0600	System Error (CCust)	—
E0601	System Error (CCustID)	—
E0610	System Error (UCust)	—
E0611	System Error (UCustID)	—
E0620	System Error (SCust)	—
E0621	System Error (CustDt)	—
E0630	System Error (ECustACC)	—
E0631	System Error (ECust)	—
E0632	System Error (Deactivate Cust Account)	—
E0650	System Error (CRec)	—
E0651	System Error (CRecID)	—
E0660	System Error (URec)	—
E0661	System Error (URecID)	—
E0670	System Error (SRec)	—
E0671	System Error (RecDt)	—
E0672	System Error (CAdminTran)	—
E0673	System Error (BoardFee)	—
E0713	Transaction Key Expired	Transaction Key provided in request is expired. Register new key with our system.
E0720	System Error(Async Insert)	—
E0721	System Error (Async Update)	—
E0722	System Error (Async Call Fail)	—
E0723	System Error (Async Select Fail)	—
E0724	System Error (Key Gen Fail)	System Error. Please contact help desk.
E0800	System Error (KeyNox Error)	—
E0910	Time out	—
E0911	System Error	—
E0912	Error on Host	—
D1001	Account Number Invalid	Account number provided in request is not a valid account number.
D1002	Valid Account, Cash payments only.	—
D1003	Amount invalid.	—
D1004	Biller ID Invalid.	Biller ID provided in request is not valid.
D1005	Cash only biller.	—
D1006	Bill Pay Processor Code is missing or is incorrect. Processing host is not configured please contact help desk.	—
D1007	One or more Fields missing or incorrect.	—
D1020	Pre Pay Number not available.	—
D1201	Unable to determine merchant ID.	Merchant is not register with Mobilozophy.
D1202	Unable to process your request.	—
D1203	Invalid redemption code.	Redemption code provided in request is invalid.
D1204	Unable to determine coupon ID.	Unable to determine coupon ID.
D1205	Coupon not valid at this location.	Coupon not valid at this location.
D1206	Minimum Purchase Amount criteria not met.	Minimum Purchase Amount criteria not met.
D1207	Either end user ID or registration ID is required.	Either end user ID or registration ID is required.
D1208	Unable to modify coupon.	Modification of coupon data is not allowed.
D1209	Unable to modify coupon.	Modification of coupon data is not allowed.
D1210	Unable to modify coupon.	Modification of coupon data is not allowed.
D1211	Unable to modify coupon.	Modification of coupon data is not allowed.
D1212	This code has already been redeemed.	This code has already been redeemed.
D1213	This code has been deleted.	This code has been deleted.
D1214	Invalid store ID.	Invalid store ID.
D1215	Invalid amount.	Amount provided in request is invalid.
D1217	Coupon service is temporarily unavailable.	Coupon service is temporarily unavailable.
D1999	General Bill Pay Decline.	General declined please contact help desk.
D2001	Refer to Issuer.	The merchant must call the issuer to obtain verbal authorization.
D2002	Suspected Card (pick-up, hot-card)	This credit card has been flagged for fraud. the merchant should call the number on the back of the card to obtain further instructions. Suspected card error occurs in the following scenarios: 1-The card is restricted by the issuer 2-Loss of card is reported 3-Theft of card is reported
D2003	Honor with identification?	The card is not identified.
D2004	Invalid Amount	The amount exceeds the limits established by the issuer for this type of transaction.
D2005	Invalid Card	The issuer indicates that this card is invalid.
D2006	No such issuer	The card issuer number is invalid.
D2007	Invalid fee	The transaction fee is unacceptable.
D2008	Incorrect Pin	The PIN entered by the cardholder is incorrect.
D2009	Pin attempts exceeded	The number of attempts to enter the PIN has exceeded.
D2010	Key synchronization failed from the host	The failure of a key synchronization from the host.
D2011	Expired Card	The card has expired.
D2012	Insufficient Funds	The credit limit for this account has exceeded, or the amount is not enough to perform the transaction.
D2013	Invalid From Account	The transaction account is invalid.
D2014	Invalid To Account	The transaction account is invalid.
D2015	Withdrawal Limit exceeded	The withdrawal limit on an account is exceeded.
D2016	Withdrawal frequency exceeded	The withdrawal frequency on an account is exceeded.
D2017	Time limit for Pre-Auth reached	The time for Pre-Auth has reached its limit.
D2018	AVS FAILED	The address verification has failed and the merchant is configured for auto decline on AVS failure.
D2019	Billing ZIP Mismatch	The zip provided does not match the billing address on file and merchant is configured for auto decline on ZIP code mismatch.
D2020	CVV2 verification failed	The V code provided is invalid or does not match what is on file and merchant set up for auto decline on CVV2 failure.
D2021	Issuer or Switch inoperative	The bank is unavailable to authorize this transaction.
D2022	Duplicate transaction ( Same amount / Account)	The transaction with same amount and account is performed twice.
D2023	Balance unavailable for inquiry	The balance cannot be validated.
D2024	Check Digit Err	The credit card number entered did not pass validation. Correct and re-enter the credit card number.
D2025	Excluded Bin ID for Merchant	Card is not allowed to do transaction at this merchant.
D2026	Do not honor	The transaction was declined by the issuer.
D2027	AVS and CVV2 failed	The address verification and V code verification failed and merchant set up for auto decline on AVS anc CVV2 failure.
D2028	Invalid Date	The credit card expiration date is invalid. Verify and re-enter the expiration date.
D2029	Invalid Service	The service provided by the card is invalid.
D2030	Host Validation Error	The host is an invalid host.
D2031	Activity Limit exceeded	The daily card activity limit has been exceeded.
D2032	Cannot complete because of Violation	The transaction cannot be completed because the credit card account has been flagged with a violation.
D2033	Debit Pin Required	—
D2034	Debit Pin Required	The BIN is blocked by the issuer.
D2035	Check Service authentication failure	—
D2039	Could Not Retrieve a Valid Card Number for Token	—
E2042	No Card found for the BIN No Card found for the BIN	—
D2200	UNKNOWN_ERROR	—
D2201	CONTENT_TYPE_NOT_SET	—
D2202	UNKNOWN_CONTENT_TYPE	—
D2203	CONTENT_LENGTH_NOT_SET	—
D2204	INCOMING_REQUEST_READ_ERROR	—
D2205	OUTGOING_RESPONSE_SEND_ERROR	—
D2206	INPUT_VALIDATION_ERROR	—
D2208	OCT_FAILED	—
D2209	AFT_FAILED	—
D2210	AFTR_FAILED	—
D2211	REMOTE_VPP_ERROR	—
D2212	INVALID_ISSUER_COUNTRY_CODE	—
D2213	FAST_FUNDS_NOT_ENABLED	—
D2214	INTERNAL_ERROR	—
D2215	ACNL_FAILED	—
D2216	ReceiverLimitExceeded	—
D2800	Invalid FCS ID	—
D2801	Invalid Voucher Serial Number	—
D2802	Invalid Voucher Approval Code	—
D2803	Electronics Benefit Transactions cannot contain Fee or Tax	—
D2998	PreFraudScout Decline	Transaction is declined in Pre Fraud rules.
D2999	General Card Auth Decline	This is a general decline error.
D3001	Invalid Bank Routing Number	Invalid routing number in the request message.
D3002	Invalid Bank Account Number	The bank account number in the request message is invalid.
D3003	Invalid MICR Data	The MICR data in the request message is invalid.
D3004	Invalid Account Type	The account type in the request message is invalid.
D3005	Invalid Check Type	The check type in the request message is invalid.
D3006	Invalid Amount	The amount for a transaction is invalid.
D3007	Missing Signature	—
D3008	Missing Endorsement	—
D3009	Invalid Check Date	The date format in the request message is invalid.
D3010	Car Lar Mismatch	Mismatch between the check amount written in numbers (courtesy amount) and letters (legal amount) provided on check image.
D3011	CallNox Timeout	—
D3012	Duplicate Check	—
D3013	Blocked Account	The account provided in transaction is blocked.
D3014	Blocked Check	The check provided in transaction is blocked.
D3015	Cannot Process Image	—
D3016	Invalid Check Number	The check number in the request message is invalid.
D3017	Bank Account Closed	The bank account does not exist.
D3018	Decline NSF	—
D3019	Check Image Decline	—
D3020	Invalid SEC	—
D3101	Maker Check Return Stop Pay Limit Exceeded	—
D3102	Maker Check Return No Auth Limit Exceeded	—
D3103	Maker Check Return No Settlement Limit Exceeded	—
D3104	Maker Check Return NSF/Other Limit Exceeded	—
D3105	Maker Check Return Limit Exceeded	—
D3106	Customer Check Return Stop Pay Limit Exceeded	—
D3107	Customer Check Return No Auth Limit Exceeded	—
D3108	Customer Check Return No Settlement Limit Exceede	—
D3109	Customer Check Return NSF/Other Limit Exceeded	—
D3110	Customer Check Return Limit Exceeded	—
D3111	Check Image Processing Error	—
D3112	Customer Check Cashing Limit Exceeded	—
D3200	Record(s) Processed Successfully	—
D3201	Duplicate Custom Fields Not Allowed.	Duplicate Custom Field Not Allowed.
D3202	Item code already exists.	Item code already exists.
D3203	Custom Field Type cannot be modified during update.	Custom Field Type cannot be modified during update.
D3204	Could not find Product for Update.	Product is not registered in the system.
D3205	Could not find Product for Removal.	Product is not registered in the system.
D3206	Unidentified Tax Category	Tax Category is not set in our system.
D3207	Some Record(s) Processed Successfully	—
D3208	No Records Processed	No records are processed further.
D3211	Parsing Failed	Issue with request parameter.
D3212	Product Enroll Fail at Merchant Level	Merchant level data is not added or updated in the system.
D3213	Item code not provided	The item code in the request message is invalid.
D3214	Product Enroll Fail at Merchant Custom Level	Merchant level custom data is not added and updated in the system.
D3215	Product Enroll Fail at Global Level	The UPC level data is not added and updated in our system.
D3216	Product Removal Failed	Product Removal Failed.
D3217	No Tax Category Found	No Tax Category Found.
D3218	Category already exists	—
D3219	Invalid Category Code	—
D3220	Modifier already exists	—
D3221	Invalid Modifier Code	—
D3222	Variation already exists	—
D3223	Invalid Variation	—
D3224	Invalid Product Code	—
D3225	Duplicate Variation Option Fields Not Allowed	—
D3226	Discount already exists	—
D3227	Start Date should be current date or future date	—
D3228	End Date should be current date or future date	—
D3229	Invalid Discount Code	—
D3230	No Product found for given search criteria.	No product is found for given search criteria.
D3231	End Date should be greater than Start Date	—
D3232	Discount amount should be less than Max Discount amount	—
D3233	Discount percentage should be less than 100	—
D3234	Max Discount amount should be less than Discount Qualifying amount	—
D3235	Discount Code already removed	—
D3236	Already Associated	—
D3237	Invalid role	—
D3238	Invalid Operation	—
D3239	Role Already Exist	—
D3240	Operation Type Already Exist	—
D3241	Role does not Exist	—
D3242	Role can not be Deleted	—
D3243	Default Role can not be Modified	—
D3250	Invalid modifierOptionDetails	Invalid modifierOptionDetails
D3253	Order service date can not be a previous date	—
E3254	Order creation failed	—
E3255	OrderID not found	—
E3256	Order updation failed	—
E3257	Order can not be modified	—
D3259	Invalid modifier categoryCode	Invalid modifier categoryCode
D3260	Invalid product categoryCode	Invalid product categoryCode
D3264	currentPaymentSequenceNumber should be less than and equal totalPaymentCount	The currentPaymentSequenceNumber value entered does not meet the required criteria.
D3999	Check Auth Decline	—
D4000	Invalid content, one of {encodedCardData, keyedCardData, returnTransactionData} group is required	—
E4001	Invalid Source Country Code	—
E4002	Invalid Source Currency Code	—
E4003	Invalid Destination Location	—
E4004	Invalid Destination Currency Code	—
E4005	Invalid Source Agent	—
E4006	Invalid Destination Agent	—
E4007	Invalid Conversion Rate	—
E4008	Invalid Fee	—
E4009	Missing/Invalid Amount	—
E4010	Missing/Invalid Payout Amount	—
E4011	Invalid MTCN	—
E4012	Duplicate transaction ( Same amount/ Account ).	—
E4050	Missing /Invalid Sender Name	—
E4051	Invalid Sender ID Type	—
E4052	Invalid Sender ID	—
E4053	Invalid Sender Address	—
E4054	Invalid Sender phone number	—
E4055	Missing /Invalid Receiver Name	—
E4056	Invalid Receiver ID Type	—
E4057	Invalid Receiver ID	—
E4058	Invalid Receiver Address	—
E4059	Invalid Receiver phone number	—
E4060	Missing / Invalid Input	—
E4999	General Money Transfer Decline	—
E5000	Invalid Money order Number.	—
E5001	Invalid Amount.	—
E5002	Missing Payee Name.	—
D5201	Invalid Page size in the request	—
D5202	Invalid Report column name for requested report	—
D5203	Invalid date range, redefine your search	—
D5204	Invalid search column for requested report	—
D5205	Invalid optional column for requested report	—
D5206	Invalid Report column name for requested report	—
D5207	Invalid/Expired Report data identifier	—
D5208	Invalid search column value for requested report	—
D5209	No data found, please redefine your search	—
D5210	One or more duplicate columns used for search, sort or for optional columns	—
D5211	Invalid search condition, transactionID is required	—
D5212	Invalid search condition, productCode is required	—
D5213	Service is temporarily unavailable.Please try later	—
E5213	Service is temporarily unavailable.Please try later	—
D5214	Invalid search condition, dateRange is required	—
E5500	Invalid Payroll Info	—
E5599	General Payroll Decline.	—
E5999	General Money order Decline	—
E6000	Missing /Invalid Name	—
E6001	Invalid ID Type	—
E6002	Invalid ID Number	—
E6004	Invalid Address	The address provided in the transaction is invalid.
E6005	Invalid phone number	The phone number provided in the transaction is Invalid.
E6006	Invalid SSN	The SSN provided in the transaction is Invalid.
E6007	Invalid DOB	The DOB provided in the transaction is Invalid.
E6008	Missing/Invalid Gender	—
E6009	Missing/Invalid customer Image	—
E6010	Missing/Invalid ID Image	—
E6011	Missing/Invalid Finger Print Image	—
E6012	Biometric Auth failure	—
E6013	BFD failed	—
E6014	OTP failed	—
E6050	Duplicate Enrollment	The Customer is enrolled. Verify if the request is send twice for the same customer.
E6051	OFAC Match	—
E6052	Blocked Customer	—
E6053	Blocked Biometrics	—
E6054	Declined Score below threshold.	—
E6055	Customer Not Enrolled.	The customer code provided in request is not registered.
E6056	Financial Account Not Enrolled.	—
E6057	Customer requested stop of specific recurring payment	Customers request to stop recurring payments.
E6058	Customer requested stop of all recurring payments from specific merchant	Customers request to stop recurring payments from specific merchant.
E6059	Missing Customer ID/External Customer Number	Customer ID or external customer number is not provided in request.
E6060	Inactive Customer	Inactive Customer
E6061	Invalid UID	UID number provided in request is invalid.
E6062	Incorrect or No Card Indicator Value	—
E6063	Customer Group Name already exists	—
E6064	Invalid Customer Group code	—
E6065	Customer Code already associated	—
E6066	Invalid Customer Code	—
E6067	Search criteria not found.	The search request does not include any search criteria fields.The search criteria includes the firstName, lastName, paymentInstrumentID, or customerID fields.
E6068	External Customer number is already available.	—
E6069	Invalid Search Criteria	—
E6071	Customer modification not allowed, payment is in process.	The application is unable to delete a customer record while a recurring transaction for the customer is processing.
E6072	Transaction is in process. Please try again after some time.	Simultaneous actions cannot be performed on the same customer record. The application is unable to perform edits on a customer record while the record is in use.
E6100	Inactive Customer	Inactive Customer.
E6901	Duplicate Schedule Billing Reference Number	Duplicate schedule billing reference number.
E6902	Payment Count Cannot be Greater than Processed Count	Payment count cannot be greater than processed count.
E6903	Next start date cannot be earlier than Current Date	Next start date cannot be earlier than current date.
E6904	Schedule cannot be added without a Payment Methods (i.e. Card, Account...)	—
E6905	Schedule not found	—
E6906	Invalid Schedule string	—
E6999	General Customer Auth Decline	General declined.
D7000	Record not found	The transaction requested is not available.
E7001	Invalid User ID	The user Id provided in request message is invalid.
E7002	Record Not Found.	The Transaction is not present in the system.
E7003	User Locked. Call CSR	—
E7004	Invalid Security Question/Answer	Invalid security question and answer.
E7005	User Already Logged in	User Already Logged in try after some time.
E7006	Your Password has Expired, Please change the password.	Change your password.
E7007	User Inactive. Call CSR	—
E7008	Operator Not Found	The user ID is not registered in the system.
E7009	Expired Client Password	The client password is expired.
E7010	Invalid Host ID	The Host Id provided in the request message is invalid.
E7011	Client Authentication Failed	This message may occur for more than one reason. 1. The manifest included in the request is not configured properly. 2. The Domain Key included in the request manifest is expired. 3. The Host Password included in the request is expired.
E7012	Invalid user or password	The User id and password is invalid.
D7013	Multiple users with same email. Enter Login ID	—
E7013	Multiple users with same email. Enter Login ID	There are multiple users with the same email ID. Enter your login ID.
E7014	Invalid Manifest	Manifest provided in the request message is invalid.
E7015	Invalid Transaction Key	The transaction key provided in the request message is invalid.
E7016	Invalid UserID or EmailID	—
D7017	User Modification Request Failed	—
E7018	The provided authentication credentials are not correct	—
E7019	Duplicate Questions/answers not allowed	—
E7020	The question cannot be same as any of the answers	—
E7021	Unable to process, retry with terminalNumber	—
E7022	Unable to process, retry with profileName or profileID	—
E7023	Unable to find profile	—
E7024	Security question expired, please fetch a new question	—
E7027	Unable to process, retry with userID	Multiple entries found for the merchantID and emailID search criteria used.
E7100	General Login Decline	General Login Decline.
E7101	User_ID already exists	User_ID already exists.
E7102	Operation not allowed	Operation not allowed.
E7103	Operator not Register/Present	Operator is not Register or Present in the system.
E7104	Last active admin operator in the system	The last Active Admin operator in the system. At least one Admin operator should be active for a merchant.
E7105	Admin operator cannot change his own status or type	The Admin operator cannot change his own profile details.
E7106	Not allowed to add Administrator	The operator is not allowed to add Admin operator.
E7107	Input Password does not adhere to complexity norms	The Input Password does not adhere to complexity norms.
E7108	New password must not match previous password. Please enter a unique new password	The new password must not match previous password. Please enter a unique new password.
E7109	Suspended/Inactive User	The User Id provided in request is Suspended or Inactive. Please reactivate to perform transaction.
E7110	Invalid password length	The password length must be between 8 and 20 characters.
E7111	Parameter validation Error	—
E7112	User already exists	—
E7113	User Credential not active	—
E7114	Security question not set for user	—
E7200	General User Admin Decline	General User Admin Decline.
E7201	Client not registered to our system.	The client domain name or unique ID is not registered.
E7202	Invalid Client Key	The client key is invalid. Re-enter the correct key and resubmit the transaction.
E7203	Client Validity Expired, Please re-register	The client validity is expired. Re-register the domain or the unique ID.
E7204	Invalid merchant details	—
E7251	Invalid one time password	The one time password is invalid. Re-enter the correct password and resubmit the transaction.
E7252	Duplicate one time password	The one time password is a duplicate. Re-enter the correct password and resubmit the transaction.
E7253	One time password validity expired	The one time password has expired. Generate a new password and resubmit the transaction.
E7254	Host Operator not allowed	The host operator is not allowed.
E7255	Operator is not Host	The operator ID for this transaction is invalid.
E7256	Token services cannot be enabled until the merchant account is set up with a token zone	Tokenization service is not enabled for the merchant.
E7257	Tokenization service not enabled	Tokenization service not enabled for the merchant.
E7259	De-tokenization service not enabled	De-tokenization service is not enabled for the merchant.
E7260	De-tokenization UnSuccessful	The token is invalid. Resubmit with a valid token number.
E7261	Tokenization UnSuccessful	Service is not available. Resubmit the transaction.
D7500	record not found (backend)	The record was not found.
D7501	Chargeback Protection is not allowed	The transaction is not eligible for Chargeback Protection.
E8000	Customer not found	Customer is not register in our system.
E8001	Customer not enrolled	Customer is not register in our system.
E8002	Customer Declined	Customer enrollment declined.
E8003	Customer Locked	Customer is locked in system.
E8004	Invalid user or password	Invalid user or password.
E8005	Credit Limit Reached	Max Credit Limit Reached.
E8006	Local Opt Out	Local Opt Out.
E8007	Invalid Message	Invalid Message
E8008	Globally Opted Out phone number	Globally Opted Out phone number
F8009	Invalid Email	Invalid Email
E8900	System Error	System Error.
E8999	General Notify Decline.	General Notify Decline.
D9000	Amount Limit Exceeded	Amount Limit Exceeded for transaction.
D9001	Transaction count Limit Exceeded	Transaction count Limit Exceeded.
D9002	Device activity Limit Exceeded	Device activity Limit Exceeded.
D9003	Amount per days Limit Exceeded	Amount per days Limit Exceeded.
D9004	Excluded Customer	Customer is excluded to perform transaction at this merchant.
E9005	Invalid Cashback amount	Cash back amount provided in request is invalid. Cash back should always be less then transaction amount.
E9006	Cashback Amount is not allowed for this type of transaction	Cashback Amount is not allowed for this type of transaction.
D9007	Maximum Line Items Exceeded Maximum Line Items Limit Exceeded	—
D9008	BC limit not set for merchant. BC limit not set for merchant.	—
D9009	BC buffer percent was not set for merchant. BC buffer percent was not set for merchant	—
D9010	Invalid Transaction_Info/Service_Code.	The error occurs in the scenarios as follows: 1-Service code is missing in the request. 2-Service code is invalid. 3-Service code is inadequate for this type of transaction.
D9011	Net Balance is less than zero	—
D9012	Invalid Merchant_Info/Agent_Chain_Number must be 6 bytes	—
D9013	Invalid Transaction type Invalid Transaction type	—
D9014	Merchant Per Transaction Deposit Limit Exceeded Transaction Deposit Limit Exceeded	—
D9015	Head Quarter merchant not found. Head Quarter merchant not found.	—
D9018	No Valid Data Found,Please Generate Token First.	—
D9019	Invalid Token	—
D9020	Invalid Transaction_Info/SubServiceCode	The error occurs in the scenarios as follows: 1- Sub service code is missing in request. 2- Sub service code is invalid. 3- Sub service code is inadequate for this type of transaction.
D9021	Invalid Transaction_Info/Type.	The error occurs in the scenarios as follows: 1-Type is missing in request. 2-Type is invalid. 3-Type is inadequate for this type of transaction.
D9022	Invalid Transaction_Info/Transaction_ID	Transaction ID is expected in request for this transaction. Re-enter the Transaction ID, and resend the transaction.
D9030	Invalid Device_Info/Device_Type	Device is inadequate to do this type of transaction.
D9040	Invalid Processor_Info/Acquirer_Institute must be 6 bytes	Acquirer_Institute must be 6 bytes.
D9050	Invalid Processor_Info/Proc_Merchant_Id must be 12 bytes	Proc_Merchant_Id must be 12 bytes.
D9070	Invalid Processor_Info/Processor_Term must be 4 bytes	Processor_Term must be 4 bytes.
D9080	Invalid Processor_Info/Store_Number must be 4 bytes	Store_Number must be 4 bytes.
D9090	Invalid Merchant_Info/MerchantType	The merchant name is invalid or is not present.
D9091	Invalid Merchant_Info/Name	—
D9092	Invalid Merchant_Info/City	—
D9093	Invalid Merchant_Info/State	—
D9094	Invalid Merchant_Info/TimeZone must be 3 bytes	—
D9096	Invalid Transaction_Info/Time_Stamp must be [MMDDYY HHMMSS]	—
D9100	Fee Configuration Level must be mentioned	—
D9101	Fee not configured	—
D9110	Invalid Merchant_Info/SICCODE must be 4 bytes.	—
D9111	Invalid Processor_Info/Sequence_Number must be 4 bytes	—
D9120	Invalid Card_Info/PIN	—
D9130	Invalid Transaction_Info/Country_Code must be at least 2 bytes.	—
D9140	Invalid Card_Info/Type	—
D9210	Invalid Card_Info/PIN	—
D9211	Invalid Card_Info/Token	—
D9212	Invalid Card_Info/KSN must be at least 16 chars	—
D9240	Invalid Merchant_Info/Agent_Bank_Number must be 6 bytes.	—
D9250	Invalid Merchant_Info/Agent_Chain_Number must be 6 bytes	—
D9260	Invalid Processor_Info/Batch_Number must be 3 bytes	—
D9270	Invalid Merchant_Info/Reimburse_Attr must be 1 byte	—
D9280	Invalid Merchant_Info/ABA_Number must be 9 bytes	—
D9282	Invalid Merchant_Info/Settle_Agent_Number must be 4 bytes	—
D9283	Check Out date can not be less than or equal to Check In date	—
D9284	Transaction amount should not be greater than authorized amount	—
D9286	Invalid CheckoutID	The checkOutID provided is incorrect. Provide the correct checkOutID.
D9287	Duplicate card sequence number	—
E9288	Invalid Wallet Identifier Format	—
E9289	Encoded Data is not allowed with checkoutID	—
D9290	Invalid Transaction_Info/Orig_Purchase_Date must be MMDDHHMM	—
E9291	Keyed Card Data is not allowed with checkoutID	—
E9292	Mandatory Tags are missing	—
E9293	Card Type not supported for requeted service	—
E9294	terminalData {terminalCapability, terminalOperatingEnvironment, cardholderAuthenticationMethod, terminalAuthenticationCapability, terminalOutputCapability,maxPinLength} group is required	—
E9295	cardholderAuthenticationMethod must be PIN	—
D9500	Encryption services not enabled for the device	Encryption services are not enabled for the device.
D9501	Encryption service requested not enabled for the device	The device has encryption service but the encryption service requested is not enabled.
D9502	Encryption method could not be determined	The device is configured with more than one encryption service. The request does not indicate which service to use.
D9503	Decryption unsuccessful	The decryption failed.
D9504	Invalid Format Id	—
D9505	Product Details is required to perform this action	—
D9510	Invalid Encryption Type	An invalid encryption type was included in the request.
D9511	A unique KSN not generated or not sent in request	The application was unable to generate or submit the key serial number.
D9610	Data Parsing fail	Data parsing failed.
D9611	Encrypted Data not generated or not sent in request	Encrypted data was not received from the host or the application was unable to include this data in the response.
F9900	XSD Format Error	XSD Format Error
F9901	Format Error field details	Format Error field details
F9902	Group encodedCardData is not allowed with cardDataSource value MANUAL	—
F9903	Group encodedCardData is not allowed with cardDataSource value PHONE	—
F9904	Group encodedCardData is not allowed with cardDataSource value EMAIL	—
F9905	Group encodedCardData is not allowed with cardDataSource value INTERNET	—
F9906	Group keyedCardData is not allowed with cardDataSource value SWIPE	—
F9907	Invalid cardDataSource for requested service.	—
F9908	Sum of elements of group additionalCharges should not be greater than transactionAmount.	—
F9909	cashTendered must not be less than transactionAmount	—
F9910	lastChipRead is Mandatory with Fallback Swipe (Icc Terminal Error) transaction	—
F9911	lastchipRead is not Allowed with Fallback Swipe (Empty Candidate List) transaction	—
F9912	Invalid content, one of {track1Data, track2Data, track3Data} is required	—
F9913	Invalid content, {encodedCardData, keyedCardData or swipedCardData} is not Allowed with Chip Card	—
F9914	emvFallbackCondition is Mandatory with Fallback Swipe transaction	—
F9915	voidReason is Mandatory for Chip Card transaction	—
F9916	Fallback Swipe allowed with track2Data only	—
F9917	Invalid emvTags, {9F1F or 9F20 or 57 or 5A}	Tags 9F1F, 9F20, 57 and 5A are not allowed if encryptionType is VOLTAGE
F9918	Invalid content, {track1Data, track3Data, emulatedTrackData} is not Allowed with Chip Card and encryptionType	track1Data, track3Data, and emulatedTrackData are not allowed if encryptionType is VOLTAGE

Other Errors

Error Description	Reason	Location
"Unable to decode the Model"	The Json you sent doesn’t match a valid input	Any endpoint.
“The (entity) could not be saved because of an unmanaged exception”	An unknown reason didn’t allow the system to save the entity. Please contact support.	Any endpoint
“Update (entity) did not finish correctly because of an unmanaged exception”	An unknown reason didn’t allow the system to update the entity. Please contact support.	Any endpoint
“The (entity) could not be retrieved because of an unmanaged exception”	An unknown reason didn’t allow the system to retrieve the entity. Please contact support.	Any endpoint
“No Devices were found for the given User/Merchant relationship”	You sent a device GUID that does not belong to a merchant administrated by the logged user. Please try with a different GUID.	Any transaction endpoint
“No Merchant was found for the current User”	You sent a device GUID that does not belong to a merchant administrated by the logged user. Please try with a different GUID.	Any transaction endpoint
“Invalid Routing Number: invalid digit”	You sent and invalid Routing Number. Please try with a different one.	Create Bank Clearing
“Invalid Routing Number: digit check failed”	You sent and invalid Routing Number. Please try with a different one.	Create Bank Clearing
“An error occurred while executing Transaction General Check”	There is some inconsistence between your devices, Merchant Processor accounts and Merchants. Please contact support.	Any transaction endpoint.
“Invalid Device GUID”	You sent a device GUID that does not exist at all. Please try with a different GUID.	Any transaction endpoint.
“BankAccount reference not found.”	You sent an invalid BankAccount GUID. Please try with a different GUID.	Create Bank Clearing.
“At least one of SSN4 or DateOfBirth are required.”	You attempted to create a bank clearing without providing SSN4 or Date of Birth of the bank account owner. Please provide any of those two.	Create Bank Clearing.
The DriverLicenseState and DriverLicenseNumber fields are required.	You didn’t provide Driver License State nor Driver License Number.	Create Bank Clearing.
“The transaction was not originated in any device of the current user.”	You are trying to void or refund a sale or bank clearing that was run on a device that is not administrated by the logged user.	Void Bank Clearing, Refund Bank Clearing, Void Sale, Refund Sale
“There was a database error”	There was some inconsistence on the database, please contact support.	Any endpoint.
“The related clearing is not settled. It can be voided only”	You attempted to refund a not settled bank clearing.	Refund Bank Clearing.
“The related clearing is already voided”	You attempted to void or refund an already voided Bank Clearing.	Void Bank Clearing, Refund Bank Clearing.
“The related clearing is already returned”	You attempted to void or refund an already refunded Bank Clearing.	Void Bank Clearing, Refund Bank Clearing.
“The related clearing was not processed, therefore it cannot be voided”	You attempted to void or refund a Bank Clearing that didn’t run successfully.	Void Bank Clearing, Refund Bank Clearing.
“Invalid (entity) GUID”	You attempted to void or refund a Bank Clearing or a Sale or to capture an Auth Only using an invalid Guid.	Capture Auth Only, Void Sale, Refund Sale, Void Bank Clearing, Refund Bank Clearing.
“No (entity) could be found for the given Id”	You attempted to updated or retrieve an entity using an invalid Guid.	Any endpoint.
“Credit Cards not allowed for this processor”	You attempted to run a Sale or Auth Only on a Merchant Processor Account that is Debit Only.	Create Auth Only, Create Sale.
“Debit Cards not allowed for this processor”	You attempted to run a Sale or Auth Only on a Merchant Processor Account that is Credit Only.	Create Auth Only, Create Sale.
“The (transaction) could not be processed correctly. Error code (error code). Error message: (error message)”	The transaction didn’t run for reason provided by the processor. If you have any question regarding this error, please contact support.	Any transaction endpoint.
“No open batch”	For some reason, there was no open batch when you attempted to run a sale or auth only. Please contact support.	Create Auth Only, Create Sale.
“Invalid CardDataSource”	You provided an invalid card data source.	Create Auth Only, Create Sale.
“The (transaction) amount must be greater than zero”	You provided a negative or zero amount for the transaction.	Any transaction endpoint.
“The (transaction) could not be fetched because of an unmanaged exception”	Something when wrong when trying to retrieve the entity. Please contact support.	Any endpoint.
“There is an approved Capture for this AuthOnly already”	You attempted to capture an already captured Auth Only.	Create Capture.
“The referenced AuthOnly and this Capture devices are not from the same MerchantAccount”	You attempted to capture an AuthOnly using a device guid belonging to a different merchant processor account.	Create Capture.
“The Capture AuthOnlyGuid value does not have matching results.”	You attempted to capture an AuthOnly using an invalid Auth Only Guid.	Create Capture.
“There is no Batch for the given guid.”	For some reason, there was no open batch when you attempted to run the transaction. Please contact support.	Any transaction endpoint.
“Only one of Bank Account or Card can be used.”	You sent both, a Credit Card and a Bank Account, when trying to create a Recurring Billing	Create Recurring Billing.
“The device hierarchy and settings could not be loaded”	Something is wrong with the merchant processor account of the device you provided. Please contact support.	Create Recurring Billing.
“The current Merchant Processor Account does not allow Tokenization. Tokenization is required to create Recurring Billings.”	You provided a device guid belonging to a merchant processor account that does not have Tokenization activated.	Create Recurring Billing.
“The setup of this device does not allow this operation. Processor Transaction Type is not Card nor ACH”	You provided a Credit Card for an ACH Merchant Processor Account or a Bank Account for a Credit Card Merchant Processor Account.	Create Recurring Billing.
“Required data for a Recurring Billing with Card are: FirstName, LastName, Email and Phone”	You’re missing at least one of First Name, Last Name, Email or Phone when trying to create a Recurring Billing using a credit card.	Create Recurring Billing.
“An Email is required for a Recurring Billing with ACH”	You’re missing e-mail address when trying to create a Recurring Billing using a Bank Account	Create Recurring Billing.
“There are no payments to be generated for the given parameters (StartDate, EndDate, PaymentCount, Interval, IntervalValue)”	You sent a combination of parameters that didn’t result in any possible payment.	Create Recurring Billing.
“Invalid Card or Bank Account”	You provided an invalid credit card or an invalid bank account when trying to create a recurring billing.	Create Recurring Billing.
“Customer data not present”	You provided a Credit Card or Bank Account without the customer’s information.	Create Recurring Billing.
“Invalid Interval. The 'every' value must be the only value.”	You sent both, an “every” interval and a list of custom dates	Create Recurring Billing.
“Invalid Interval/IntervalValue”	You provided an invalid combination of the interval and its values.	Create Recurring Billing.
“An error occurred while parsing the CustomDates”	At least one of the custom dates you provided is not properly formatted	Create Recurring Billing.
“There is a date in the CustomDates smaller than the StartDate”	At least one of the custom dates you provided is previous to the StartDate you provided.	Create Recurring Billing.
“The EndDate must be greater than the greatest CustomDate”	At least one of the custom dates you provided is posterior to the EndDate you provided.	Create Recurring Billing.
“EndDate must be submitted for CustomDates”	You provided a list of CustomDates but not an EndDate	Create Recurring Billing.
“Invalid InertervalValue: this interval does not allow values”	You selected an interval that does not require interval values.	Create Recurring Billing.
“Invalid Interval, you must explicit an IntervalValue”	You selected an interval that requires IntervalValue and you did not send it.	Create Recurring Billing.
“Invalid Interval”	You sent a wrong Interval name.	Create Recurring Billing.
“End Date must be after start date”	You sent an End Date that is posterior to the Start Date you sent	Create Recurring Billing.
“The Start Date cannot be earlier than today”	You sent a Start Date previous to the current date.	Create Recurring Billing.
“Just one of End Date or Payment Count values are required, not both”	You sent both “EndDate” and “PaymentCount”. Please send one or the other one, but not the both together.	Create Recurring Billing.
“Either one of End Date or Payment Count values are needed”	You didn’t send “EndDate” neither “PaymentCount”. Please send at least one of them.	Create Recurring Billing.
“The Payment Count value must be greater than 0”	You sent PaymentCount with a value equal or less than 0	Create Recurring Billing.
“The current status of the Recurring Billing is final and does not allow any updates.”	The Recurring Billing finished on scheduled, was deactivated or wasn’t created correctly so its status cannot be change.	Update Recurring Billing.
“Invalid Status”	You sent a wrong status name.	Any Update endpoint.
“Invalid Amount, it cannot be 0. If you wish to cancel the Recurring Billing, set the status to Deactivated”	You sent Amount with a 0 value.	Update Recurring Billing.
“A database related error occurred B.RBB.04”	Something went wrong when trying to retrieve the scheduled payments. Please contact support.	Get Recurring Billing.
“Either the SaleGuid or SaleReferenceNumber are required”	You didn’t send SaleGuid neither SaleReferenceNumber. Please send one of them.	Create Return.
“You can't return a sale run more than 180 days ago”	You attempted to return a sale that was run 180 days ago.	Create Return.
“The Return Amount must be greater than zero”	You sent Amount with a value equal or less than 0	Create Return.
“Original Amount exceeded”	You attempted to return an amount greater than the original sale amount	Create Return.
“Sale has been voided”	You attempted to return a voided sale.	Create Return.
“Sale has not been settled”	You attempted to return a sale of which batch has not been closed.	Create Return.
“The referenced Sale and this Return devices are not from the same MerchantAccount”	You sent a device guid belonging to a merchant processor account different from the one where the sale was run.	Create Return.
“The current invoice status does not allow a payment”	Invoice was already paid, cancelled or has not been sent yet so it cannot be paid.	Create Sale.
“The sale amount does not match the invoice amount”	You sent and Invoice Guid, but the sale amount does not match the amount of that invoice.	Create Sale.
“The calculated amount after Discount and/or ServiceFee and GrossAmount does not match the Amount value”	You sent GrossAmount and Discount and/or ServiceFee, but the amount you sent does not match the result of Amount=GrossAmount-Discount+ServiceFee	Create Sale.
“If Discount and/or ServiceFee are submitted, the GrossAmount value is required”	You sent Discount and or ServiceFee but you didn’t send GrossAmount.	Create Sale.
“Unable to find the device where the original sale was run.”	You’re trying to charge a fee (or to reattempt a sale) over sale we cannot find the device where it ran. Please contact support.	Charge Fee, Reattempt sale.
“There are no active Fee Charger devices for your Merchant Processor Account”	You’re trying to charge a fee but you haven’t setup a Fee Charger device yet.	Charge Fee.
“Unable to charge fee for sale”	System was not able to charge the fee for the selected sale for some unknown reason. Please contact support.	Charge Fee.
“Unable to run sale again”	System was not able to run the selected sale again for some unknown reason. Please contact support.	Reattempt sale.
“Original Sale not found”	You sent an invalid Sale Guid	Reattempt sale.
“Card for original Sale not found”	We were not able to find the card used on the original sale. Please contact support.	Reattempt sale.
“Tax Rate submitted without declaring Tax Type”	You sent TaxRate but not TaxType.	Create Sale, Create AuthOnly, Create Capture.
“Tax Rate submitted without declaring Tax Amount”	You sent TaxRate but not TaxAmount.	Create Sale, Create AuthOnly, Create Capture.
“An error occurred while saving the EnhancedData”	Something went wrong when trying to save tax information. Please contact support.	Create Sale, Create AuthOnly, Create Capture.
“An error occurred while retrieving the EnhancedData”	Something went wrong when trying to get tax information. Please contact support.	Get Sale, Get AuthOnly, Get Capture.
“The underlying Sale was not processed correctly. A Tip Adjustment cannot be made”	You attempted to add a tip to a sale that didn’t run successfully.	Create Tip Adjustment.
“The TipAdjustment could not be processed correctly B.TA.C01”	Something went wrong when trying to add the tip to the sale. Please contact Support.	Create Tip Adjustment.
“The Sale belongs to a closed batch. Tip Adjustments can only be made on open batches B.TA.C02”	You attempted to create a tip for a sale that is already settled.	Create Tip Adjustment.
“Sale not found B.TA.C03”	You sent an invalid Sale Guid	Create Tip Adjustment.
“Invalid Device GUID B.TA.C04”	You sent an invalid Device Guid.	Create Tip Adjustment.
“Card Verification does not allow Swiped requests. B.VB.C06”	You sent track1 and/or track2. Please send a keyed card.	Create Verify.
“Card Verification does not allow EMV requests. B.VB.C07”	You sent EMV data. Please send a keyed card.	Create Verify.
“There is no card match for the given Token. B.VB.C01”	You sent a tokenized card but we were not able to find the original card number.	Create Verify.
“The Verify could not be processed correctly. B.VB.C05”	The Verify didn’t run successfully for an unknown reason. Please contact support.	Create Verify.
“One of SaleGuid, AuthOnlyGuid, ReturnGuid, SaleReferenceNumber, AuthOnlyReferenceNumber or ReturnReferenceNumber fields is required”	You didn’t say any Guid or Reference Number of the transaction you want to void.	Create Void.
“Only one of SaleGuid, AuthOnlyGuid, ReturnGuid, SaleReferenceNumber, AuthOnlyReferenceNumber or ReturnReferenceNumber fields can be accepted”	You sent more than one Guid belonging to different kind of transactions.	Create Void.
“The AuthOnly cannot be voided because it has been captured already”	You attempted to void an AuthOnly that has been already captured. Please try voiding the Sale generated instead.	Create Void.
“No device found for the underlying transaction”	No active device was found for the transaction you’re trying to void.	Create Void.
“Sale cannot be voided because it was not processed”	You attempted to void a sale that didn’t run successfully.	Create Void.
“AuthOnly cannot be voided because it was not processed”	You attempted to void an auth only that didn’t run successfully.	Create Void.
“Return cannot be voided because it was not processed”	You attempted to void a return that didn’t run successfully.	Create Void.
“Transaction already settled”	You attempted to void a transaction of which batch has already been closed	Create Void.
“No open batch available”	For some reason, there is no open batch to process your transaction. Please contact support.	Any Create Transaction endpoint.
“Expiration date is required if the Card number is being sent. B.CB.GS01”	You sent a Card Number but no expiration date.	Create Sale, Create AuthOnly, Create Recurring Billing, Create Verify.
“Expiration date is required if the Card is being swiped. B.CB.GS02”	You sent track1 and/or track2 but no expiration date.	Create Sale, Create AuthOnly.
“The current Merchant Processor Account does not allow Swiped transactions. B.CB.GS03”	You provided a Device Guid that belongs to a Merchant Processor Account that does not allow swiped transactions. Please try with a different device Guid.	Create Sale, Create Auth Only.
“The current Merchant Processor Account does not allow EMV transactions. B.CB.GS04”	You provided a Device Guid that belongs to a Merchant Processor Account that does not allow EMV transactions. Please try with a different device Guid.	Create Sale, Create Auth Only.
“For EMV, required fields are EMVTags and ExpirationDate B.CB.GS05”	You’re missing either EmvTags or ExpirationDate fields (or both) when trying to run an EMV transaction.	Create Sale, Create Auth Only.
“Tags missing B.CB.GS06”	You’re missing at least one required tag for an EMV transaction.	Create Sale, Create Auth Only.
“Unexpected error: Card without token.”	We were not able to tokenize the card. Please contact support.	Create Sale, Create AuthOnly, Create Recurring Billing, Create Verify.
“The Card tokenization could not be processed.”	Processor were not able to tokenize the card. Please contact support.	Create Sale, Create AuthOnly, Create Recurring Billing, Create Verify.
“Card number, track1data or track2data missing”	You didn’t say any of cardNumber, track1data or track2data. Please provide at least one of them.	Create Sale, Create AuthOnly, Create Recurring Billing, Create Verify.
“Invalid DriverLicenseState name”	You provided a wrong short name for Driver License State	Create Bank Clearing, Create Bank Account.
“As a Credit Card device, the ProcessorId, ProcessorOperatingUserId and ProcessorPassword data are required.”	You’re missing at least one of ProcessorId, ProcessorOperating UserId or ProcessorPassword	Create Device.
“As an ACH device, the ProcessorLocationId data is required.”	You’re missing ProcessorLocationId	Create Device.
“As an ACH device, the TerminalNumber data is required.”	You’re missing TerminalNumber.	Create Device.
“Only one Fee Charger active device is allowed per Merchant Processor Account”	You’re trying to create a device with FeeCharger=true for a Merchant Processor Account that already has an active Fee Charger Device	Create Device.
“Only one Mobile active device is allowed per Merchant Processor Account”	You’re trying to create a device with IsMobile=true for a Merchant Processor Account that already has an active Mobile Device.	Create Device.
“In order to create a Virtual Terminal, the Merchant Processor Account where you're attempting to create this device must have setup an Auto Close Batch time.”	You’re trying to create a device with IsVirtualTerminal=true for a Merchant Processor Account that hasn’t set an Auto Close Batch time yet.	Create Device.
“The processor failed to return the Device Parameters. B.DB.04”	Processor was not able to return the device data. Please contact support.	Create Device.
“An error occurred while requesting the processor parameters for this device. B.DB.02”	System was not able retrieve device data from the processor. Please contact support.	Create Device.
“An error occurred while requesting the processor parameters for this device. B.DB.03”	Something went wrong when system sent device parameters to processor. Please contact support.	Create Device.
“Device updated. Device status changed to Paused because of an error.”	Device was updated, but something went wrong so it was paused. Please contact support.	Create Device.
“There are no active Fee Charger devices for your Merchant Processor Account”	No active device with FeeCharger=true was found.	Charge Fee.
“checkIpIsAllowed failed to check if endpoint is allowed to be run from IP”	You tried to run an endpoint that is not allowed to be run from your IP address.	Protected endpoints.
“The user does not have permission to do this”	You attempted to run an endpoint that is not allowed for your user profile.	Any endpoint.
“A server error has occurred. The operation could not be finished.”	A general error occurred. Please contact support.	Any endpoint.
“Hosted Payment Page Request expired”	You attempted to see the preview or to confirm the transaction of a Hosted Payment Page request of which token has already expired.	HostedPaymentPageRequests – Get Preview, HostedPaymentPageRequests – Confirm Transaction
“Hosted Payment Page Request TempToken already used”	You attempted to see the preview or to confirm the transaction of a Hosted Payment Page request of which token has already been used.	HostedPaymentPageRequests – Get Preview, HostedPaymentPageRequests – Confirm Transaction
“SendDate cannot be earlier than today”	You sent a SendDate previous to current date.	Create Invoice.
“PaymentDate cannot be earlier than today”	You sent a PaymentDate previous to CurrentDate	Create Invoice.
“Send Status not allowed”	You sent a SendSatus different from “Draft” or “Scheduled To be Sent”	Create Invoice.
“Invalid SendStatus”	You sent a wrong SendStatus	Create Invoice.
“Invalid PaymentTerm”	You sent a wrong PaymentTerm	Create Invoice.
“Forbidden SendStatus”	You’re trying to update the SendStatus of an invoice that has been already sent and cannot be updated.	Update Invoice.
“Invalid PaymentStatus”	You sent a wrong PaymentStatus	Update Invoice.
“A database related error occurred B.Iv.01”	We were not able to retrieve the invoice because of a database error. Plase contact support.	Get Invoice
“The current invoice status does not allow modifications”	Invoice has been already sent and cannot be updated.	Update Invoice, Update Invoice Detail
“The current detail is deleted, no changes are allowed”	Invoice Detail has been deleted and cannot be updated.	Update Invoice Detail.
“A database related error occurred B.IvD.01”	Invoice Detail or Invoice Reminder could not be retrieved because of a database error. Please contact support.	Get Invoice Detail, Get Invoice Reminder.
“For a custom reminder, date is required”	You sent a customized reminder but you didn’t include the reminder’s date.	Create Invoice Reminder.
“The current invoice payment status does not allow a new reminder”	Invoice is already paid and a new reminder cannot be created.	Create Invoice Reminder.
“Reminder date cannot be earlier than send date”	You attempted to generate a reminder of which date is previous to the send date of the invoice.	Create Invoice Reminder.
“Reminder date cannot be earlier than today”	You attempted to generate a reminder of which date is previous to current date.	Create Invoice Reminder.
“For this invoice there is an active reminder for this date already”	You attempted to generate a reminder of which date is the same one another active reminder for the same invoice has.	Create Invoice Reminder.
“The reminder is completed, it cannot be updated”	You’re trying to update a reminder that has already been executed.	Update Invoice Reminder.
“Days not specified”	Something went wrong when trying to calculate the date of the reminder. Please try with a different value.	Create Invoice Reminder, Update Invoice Reminder.
“Invalid Parent Iso Number”	You provided a wrong Iso Number for ParentIso	Create Iso
“Iso Fees and Discount rate can be null or zero, but cannot be negative”	You sent a negative amount for at least one of the fees.	Create Iso
“User does not have the Merchant Admin role assigned.”	You assigned as merchant’s admin a user that does not have the Merchant Admin Role	Create Merchant
“Merchant Processor Account Fees and Discount rate can be null or zero, but cannot be negative”	You sent a negative amount for at least one of the fees.	Create Merchant Processor Account
“AutoClose is available for Credit Card only”	You attempted to set “AutoClose=true” for an ACH Merchant Processor Account.	Create Merchant Processor Account, Update Merchant Processor Account
“Subisos cannot setup fees lower than those established by its Parent Iso”	You attempted to create or update a merchant processor account and setup fees lower than the ones your parent iso charges.	Create Merchant Processor Account, Update Merchant Processor Account
“Invalid context. Allowed values are: Invoice, i, RecurringBilling, rb”	You sent an invalid context	Get Merchant Product, Get Merchant Product List
“A database related error occurred B.MPB.01”	Something went wrong at the database level when trying to retrieve something related with merchant product.	Get Merchant Product, Get Merchant Product List, Get Merchant Product List Detail.
“The authenticated user does not have permission to perform this operation.”	Your user role does not have permission to run the endpoint you’re pointing to. Please try with a different endpoint or contact support to get a new role.	Any endpoint.
“Invalid State name”	You sent a wrong US State short name.	Any endpoint.
“Invalid Invoice Customer”	You sent a wrong InvoiceCustomer Guid	Create Invoice, Update Invoice.
“Iso number not found”	You sent a wrong Iso Number	Register Account
“Unable to remove Merchant Admin Profile. User is still admin of the following merchants:”	You’re trying to remove the Merchant Admin profile to a user who is still admin of some merchants. Remove the user from the admin list on each of the merchants listed	Update User Role
“Unable to decode the Model”	You sent a wrong Json for the endpoint you pointed to	Any endpoint.
“Invalid ModelState”	You sent a wrong Json for the endpoint you pointed to	Any endpoint.
“NoResultFound204”	You sent a search or called a Get All endpoint that generated no results	Any get all endpoint, Any search endpoint.
“Unable to reach entity”	You sent an invalid Guid	Any get endpoint.
“Wrong emailType”	You sent an invalid e-mail address	Resend Email.
“Invalid TempToken”	You sent a wrong temporal token	HostedPaymentPageRequests – Confirm Transaction
“Operation is only available for Sandbox url”	You attempted to create a user using an endpoint only available for Sandbox	Create User
“Iso is not active.”	You sent an Iso Number belonging to an inactive iso	Register Account.
“Username does not exist”	You sent a username that does not exist at all	Reset Password Request.
“Key expired”	You attempted to reset a password using a key that is expired.	Reset Password.
“Key does not exist”	You attempted to reseat a password using a key that does not exist at all.	Reset Password.
“Invalid State”	You sent a wrong US State short name.	Any endpoint.
“Invalid Status”	You sent a wrong status name.	Any endpoint.

Extracted from the published SurePay reference. 62 endpoints across 24 groups. Ask for sandbox credentials to run them.