Create TransactionRequest (OTPP)

Creates a TransactionRequest (OTPP).

If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID (see notes below).


URL:

https://<FQDN>/v2/clients/<ClientIDISO>/transactionrequests


Request:

JSON Name Value Required Default Description Choice
type String
4 characters
Either pull or push
R Transaction Type
user1 String
1-15 characters
O User1
user2 String
1-15 characters
O User2
currency String
3 digits
O 840 ISO 4217 Currency Number
amount String
Amount
R Transaction Amount
customer
object
Hide Object
R Customer
name
object
Hide Object
R Name
first String R First Name
last String R Last Name
address
object
Hide Object
O Address
line1 String R Address Line 1
line2 String O Address Line 2
city String R City
state String
2-character code
R State Code
zipcode String R Zip Code
country String
3-digit code
R 840 ISO 3166-1 Country Code
callback
object
Hide Object
O Callback, contact TabaPay
type String R URL
value String R URL String

Sample Requests:

Pack your Request, the following Samples shown here are unpacked only for human readability:
{
  "type": "pull",
  "user1": "123456789",
  "amount": "1000.00",
  "customer":
  {
    "name":
    {
      "first": "TabaPay",
      "last": "Inc",
    },
    "address":
    {
      "line1": "605 Ellis Street",
      "line2": "Suite 110",
      "city": "Mountain View",
      "state": "CA",
      "zipcode": "94043",
    }
  }
}

-----
With Callback:
  {
    "type": "pull",
    "user1": "123456789",
    "amount": "1000.00",
    "customer":
    {
      "name":
      {
        "first": "TabaPay",
        "last": "Inc",
      },
      "address":
      {
        "line1": "605 Ellis Street",
        "line2": "Suite 110",
        "city": "Mountain View",
        "state": "CA",
        "zipcode": "94043",
      }
    },
    "callback":
    {
      "type": "URL",
      "value": "https://somewhere.com"
    }
  }

Response:

Status Codes:

Status Code Description
200 OK A Transaction is created and processing is completed.

See Status Codes for other possible Status Codes that might be returned.


Response Data:

JSON Name Value Description Status Code
200 Other
SC Integer
3-digit code
HTTP Status Code O
EC String
1 or 8 characters
Internal Error Code O
EM String Error Message O O
otppID String
22 characters
TransactionRequestID
(OTPPID)
link String
URL
URL

Sample response:

{
  "SC": 200,
  "EC": "0",
  "otppid": "TabaPay_OTPPID_22Chars",
  "link": "https://link/?ID=TabaPay_OTPPID_22Chars"
}

Notes:

For Clients who are an ISO (Independent Sales Organization), to specify your ClientID and a SubClientID, use the underscore character ("_") to separate the two values: <ClientID>_<SubClientID> where:

  • ClientID is your unique 22-character string and
  • SubClientID is an assigned 4, 6 or 8-digit value.

If using URL Callback, the Callback URL will get a POST Request with the following data:

{
  "request":
  {
    "amount": "1000.00",
    "card":
    {
      "last4": "1234",
      "expirationDate": "202512"
    },
    "user1":  "123456789",
    "name":
    {
      "first": "TabaPay",
      "last":  "Inc"
    },
    "address":
    {
      "line1":   "605 Ellis Street",
      "line2":   "Suite 110",
      "city":    "Mountain View",
      "state":   "CA",
      "zipcode": "94043",
    }
  },
  "response":
  {
    "SC":            "200",
    "EC":            "0",
    "transactionID": "TabaPay_TransactionID_",
    "network":       "Visa",
    "networkRC":     "00",
    "status":        "COMPLETED",
    "approvalCode":  "230402",
    "AVS":
    {
      "codeAVS":          "Y",
      "codeSecurityCode": "M"
    }
  }
}