| POST | /quickpayments/qp-tokens | Creates a one-time use, short-lived, QuickPayments Token for use in a subsequent transaction. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| QuickPaymentsKey | model | string | Yes | The QuickPayments Key. |
| CardData | model | CardData | No | Contains card payment data for the QuickPayments Token. |
| CheckData | model | CheckData | No | Contains check payment data for the QuickPayments Token. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CardNumber | model | string | No | Credit card number used to uniquely identify the card owner’s account. |
| ExpirationDate | model | string | No | Credit card date of expiration in MMYY format. |
| Cvv | model | int? | No | Card verification number. Note: This parameter may be required depending on the merchant’s setup. |
| NameOnCard | model | string | No | Name of the cardholder, as displayed on the card |
| Pin | model | string | No | The encrypted PIN-block returned by the PIN pad. The transaction will fail if an unencrypted PIN is used. Note: This information is not required for PIN-less debit transactions. |
| KeySerialNumber | model | string | No | PIN pad serial number used in managing DUKPT PIN pads. This is required for all transactions where a pin is present |
| Token | model | string | No | A value generated by the gateway for payment data which has been previously stored. The format of the value depends on the format selected when the payment method was originally stored. |
| EmvData | model | string | No | The TLV (tag-length-value) string provided by the certified, emv-capable terminal. This value should not be modified before transmission. |
| TrackData | model | string | No | The magnetic stripe/track data read from a swiped transaction. If the card reader is capable of reading both track 1 and track 2, only track 2 should be provided. |
| EncryptedTrack1Data | model | string | No | The encrypted magnetic stripe/track 1 data read from a secure reader |
| EncryptedTrack2Data | model | string | No | The encrypted magnetic stripe/track 2 data read from a secure reader |
| EncryptedTrack3Data | model | string | No | The encrypted magnetic stripe/track 3 data read from a secure reader |
| IIN | model | string | No | The card IIN when using an encrypted magnetic stripe/track data read from a secure reader |
| ARQC | model | string | No | The encrypted ARQC generated from a secure reader chip-based transaction |
| EntryMode | model | EntryModes | No | The method in which card data was collected. This is used in conjunction with other properties of the transaction to determine the correct values for card and cardholder presence to send to the processor.Allowable Values
|
| CvPresence | model | CVPresence | No | The presence/status of the card verification number on the card and in the transactionAllowable Values
|
| Street | model | string | No | The billing address of the card. Used for AVS (address verification) if it is enabled for the merchant |
| ZipCode | model | string | No | The billing zip code of the card. Used for AVS (address verification) if it is enabled for the merchant |
| Phone | model | string | No | Card owner's phone number. |
| model | string | No | Card owner's email address. |
| unknown | |
| notApplicable | |
| manual | |
| unencryptedCardReaderSwipe | |
| encryptedCardReaderSwipe | |
| icc | |
| proximity | |
| fallback |
| none | |
| notSubmitted | |
| submitted | |
| illegible | |
| notPresent |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NameOnCheck | model | string | Yes | Name of the check owner |
| RoutingNumber | model | string | Yes | Uniquely identifies the bank holding funds. |
| AccountNumber | model | string | Yes | Uniquely identifies the check owner’s bank account. |
| CheckNumber | model | string | No | Uniquely identifies an individual’s check. |
| MICR | model | string | No | Magnetic Ink Character Recognition. Note: This input is required for processing check-present and consumer-present transactions. |
| DriversLicense | model | string | No | Check owner’s driver’s license number. |
| State | model | string | No | Check owner’s two-character state code. |
| SSN | model | string | No | Check owner's social security number. |
| DateOfBirth | model | string | No | Check owner's date of birth. |
| CheckType | model | CheckType | No | Identifies the type of check used in the transaction. |
| AccountType | model | CheckAccountType | No | Identifies the type of account used as a source of funds. |
| RawMICR | model | string | No | Raw Magnetic Ink Check Reader data line from the check reader. |
| BranchCity | model | string | No | City of the check owner's bank branch. |
| EmailAddress | model | string | No | Check owner's email address. |
| TelephoneNumber | model | string | No | Check owner's phone number. |
| Token | model | string | No | A value generated by the gateway for payment data which has been previously stored. The format of the value depends on the format selected when the payment method was originally stored. |
| Address | model | Address | No | Address data on the check holder. |
| SECCode | model | string | No | Sets the Standard Entry Class code for the transaction.Allowable Values
|
| Name | Value | |
|---|---|---|
| Personal | 1 | |
| Business | 2 |
| Name | Value | |
|---|---|---|
| Checking | 1 | |
| Savings | 2 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StreetAddress1 | model | string | Yes | The street address, max 50 chars |
| StreetAddress2 | model | string | No | The street address 2, max 50 chars |
| StreetAddress3 | model | string | No | The street address 3, max 50 chars |
| City | model | string | No | The city, max 50 chars |
| StateOrProvinceCode | model | string | Yes | The CHAR-2 USA state and CAN province codesAllowable Values
|
| PostalCode | model | string | Yes | The postal code, max 30 chars |
| CountryCode | model | string | Yes | The ISO Alpha-3 USA or CAN country codesAllowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| QuickPaymentsToken | model | string | No | The QuickPayments token added. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /quickpayments/qp-tokens HTTP/1.1
Host: syntch.simpay.net
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"QuickPaymentsKey":"String","CardData":{"CardNumber":"String","ExpirationDate":"String","Cvv":0,"NameOnCard":"String","Pin":"String","KeySerialNumber":"String","Token":"String","EmvData":"String","TrackData":"String","EncryptedTrack1Data":"String","EncryptedTrack2Data":"String","EncryptedTrack3Data":"String","IIN":"String","ARQC":"String","EntryMode":"unknown","CvPresence":"none","Street":"String","ZipCode":"String","Phone":"String","Email":"String"},"CheckData":{"NameOnCheck":"String","RoutingNumber":"String","AccountNumber":"String","CheckNumber":"String","MICR":"String","DriversLicense":"String","State":"String","SSN":"String","DateOfBirth":"String","CheckType":"Personal","AccountType":"Checking","RawMICR":"String","BranchCity":"String","EmailAddress":"String","TelephoneNumber":"String","Token":"String","Address":{"StreetAddress1":"String","StreetAddress2":"String","StreetAddress3":"String","City":"String","StateOrProvinceCode":"String","PostalCode":"String","CountryCode":"String"},"SECCode":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{Unable to show example output for type 'QuickPaymentsTokenResponse' using the custom 'csv' filter}No parameterless constructor defined for this object.