Zero Dollar Auth
Description¶
The makeAPayment
endpoint is used to submit a Zero Dollar Auth payment request to a payment gateway. An "authorization" (auth) will be submitted for credit cards.
Requests can be done with a transaction type as ZERO_DOLLAR_AUTH
.
Request¶
Endpoint¶
/ui/v1/makeAPayment
Method¶
POST
Header¶
Content-Type: application/json
Authorization: Basic $TOKEN
Note
Replace $TOKEN
in the request with the base64-encoded username/password combination in the format username:password
.
Given a username of username
and a password of password
, the request header would appear as follows:
Content-Type: application/json
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Attributes¶
A • is a child element, • • is a grandchild element, • • • is a great-grandchild element.
ELEMENT | DESCRIPTION | FORMAT |
---|---|---|
money | Required Array index |
|
• amount | Required Payment amount |
10.00 The maximum Amount limit is 999,999.99 |
• currency | Required array index |
|
•• currencyCode | Required 3-character currency code |
Currency Codes |
paymentType | Required | |
• name | Required Name of Payment Type being used |
Payment Types |
consolidatedPayInfo | Required Array index |
|
• payments | Required Array index |
|
•• type | Required Type of payment method being used |
• creditcard • echeck • pinlessdebitcard • paypal |
•• paymentMethodType | Required Payment method type name |
Payment Method Types |
•• cardNetworkName | Conditional Applies to credit card and debit card payments only. Card network name |
Card Networks |
•• nameOnCard | Conditional Required for Realex Cardholder's name |
John Smith |
•• firstName | Conditional Required for CyberSource, PayPal Cardholder's first name |
John |
•• lastName | Conditional Required for CyberSource, PayPal Card holder's last name |
Smith |
•• cardNumber | Conditional Required for credit cards or PINless debit cards Credit/debit card number |
4111111111111111 |
•• expiryMonth | Conditional Required for credit cards or PINless debit cards 2-digit expiration month |
08 |
•• expiryYear | Conditional Required for credit cards or PINless debit cards 2-digit expiration year |
20 |
•• CVN | Conditional Required if Card Security Code validation is enabled CVV/CVN |
4 digits for American Express cards, 3 digits for others |
•• processDebitOrCredit | Conditional Required for PINless debit Whether a transaction will be processed as credit or debit |
• debit • credit |
•• subscriptionId | Conditional Required if using a saved/tokenized payment method Subscription ID |
1122334455667788 |
•• routingNumber | Conditional Required for eCheck Bank account's routing number |
0111111111 |
•• accountNumber | Conditional Required for eCheck Account Number |
1234567890 |
•• accountHolderName | Conditional Required for eCheck Account Holder Name |
John Smith |
•• bankName | Optional Optional for eCheck Bank name |
Test Bank |
•• accountType | Conditional Optional for eCheck Type of bank account |
Account Types |
•• dateOfBirth | Conditional Optional for eCheck Date of Birth of the Account Holder |
2000-04-13 |
•• driversLicenseNumber | Conditional Optional for eCheck Driver's License Number |
123123123 |
•• driversLicenseState | Conditional Optional for eCheck Driver's License State |
GA |
•• issueDate | Conditional Optional for Money Order Issue date for Money Order |
2023-04-06 |
•• checkNumber | Conditional Optional for Money Order |
1234567 |
•• moneyOrderNumber | Conditional Optional for Money Order |
123456789 |
•• billingAddress | Conditional Required if billing address validation is enabled Array index |
|
••• country | Conditional Required if billing address validation is enabled Billing address country which is a 3 character alpha code |
Country Code |
••• state | Conditional Required if billing address validation is enabled Billing address state which is a 2 character alpha code |
States/Provinces |
••• city | Conditional Required if billing address validation is enabled Billing address city |
Atlanta |
••• addressLine1 | Conditional Required if billing address validation is enabled Street address |
123 Maple Street |
••• addressLine2 | Optional Apartment/suite number |
Apt. 2A |
••• streetName | Optional Address that is related to the card used. when the selected country is Brazil |
e.g., Near XXXX |
••• streetNumber | Optional Address that is related to the card used. when the selected country is Brazil |
e.g., Near 1234 |
••• zipCode | Conditional Required if billing address validation is enabled Billing address ZIP/postal code |
12345 |
•• money | Required Amount |
10.00 or 1000 Include decimal (e.g., 10.00) for CyberSource, omit (e.g., 1000) for Realex |
•• currency | Required Array index |
|
••• currencyCode | Required 3-character currency code |
Currency Codes |
•• paymentGatewayType | Required Array index |
|
••• name | Required Name of payment gateway processing the payment |
Payment Gateways |
•• payWith | Required New or saved payment method |
• NEW_PAYMENT_METHOD • EXISTING_PAYMENT_METHOD |
Credit Card Payment¶
Request (New Payment Method)¶
{
"money": {
"amount": "",
"amountDue": "",
"currency": {
"currencyCode": "USD",
"isoNumericCode": "840"
}
},
"paymentType": {
"name": "SINGLE_PAYMENT"
},
"consolidatedPayInfo": {
"payments": [
{
"type": "creditcard",
"paymentMethodType": "CREDIT_CARD",
"cardNetworkName": "VISA",
"nameOnCard": "John Smith",
"firstName": "",
"lastName": "",
"companyName": "",
"cardNumber": "4788250000028291",
"expiryMonth": "04",
"expiryYear": "33",
"cvn": "123",
"cardSwipe": false,
"posKeyed": false,
"emvContact": false,
"geolocation": null,
"processDebitOrCredit": "",
"acceptCreditSurcharge": "",
"refundMethod": {
"name": "ORIGINAL_PAYMENT_METHOD"
},
"refundStatus": {
"name": "NONE"
},
"voidStatus": {
"name": "NONE"
},
"orderId": "",
"subscriptionId": null,
"reEnterAccountNumber": "",
"accountHolderName": "",
"dateOfBirth": "",
"driversLicenseNumber": "",
"driversLicenseState": null,
"billingAddress": {
"country": "USA",
"state": "GA",
"city": "Johns Creek",
"addressLine1": "4200 ABC Street",
"addressLine2": "",
"addressLine3": "",
"streetNumber": "",
"streetName": "",
"zipCode": "22222"
},
"money": {
"amount": "",
"currency": {
"currencyCode": "USD",
"isoNumericCode": "840"
}
},
"paymentGateway": {
"name": "CHASE_PAYMENTECH_NETCONNECT"
},
"payWith": "CARD_NOT_PRESENT",
"posTerminalId": "",
"arqcData": "",
"serialNumber": "",
"trackData1": "",
"trackData2": "",
"encryptedTrack1": "",
"encryptedTrack2": "",
"encryptedTrack": false,
"posEntryMode": {
"name": "MANUAL_ENTRY_WIRED"
},
"ksn": "",
"posDeviceType": {
"name": "NONE"
},
"authCode": "",
"convenienceFees": 0,
"channel": {
"id": "135"
},
"issueDate": "",
"checkNumber": "",
"moneyOrderNumber": "",
"storeCreditNumber": "",
"storeCreditPIN": "",
"fallbackMSR": false,
"identityType": {
"name": null
},
"identityNumber": "",
"reEnterIdentityNumber": "",
"processAsQRCode": false
}
]
},
"paymentCycle": null,
"transactionType": {
"name": "ZERO_DOLLAR_AUTH"
},
"ssoEnabledInd": "false",
"threeDSecurePaReq": "",
"threeDSecureURL": "",
"threeDSecureVISAPit": "",
"realexRequestId": "",
"threeDSecureEncodedMD": "",
"password": "password",
"paymentMethodName": "",
"invoiceNumber": "",
"salesOrderNumber": "",
"customerNumber": "",
"voidReason": "",
"refundReason": "",
"transactionCategory": {
"name": "CARD_NOT_PRESENT"
},
"paymentAction": {
"name": "ZERO_DOLLAR_AUTH"
},
"memo": "",
"addProfileAsPartOfAuthRequest": false,
"merchantId": "7",
"userRole": "MERCHANT_ADMIN",
"uiType": "",
"emailAddress": "user@user.com",
"reEnterEmailAddress": "user@user.com",
"mobileNumber": "",
"reEnterMobileNumber": "",
"textMessageType": {
"name": "SMS"
},
"mobileCountryCallingCodeId": 1,
"mobilePhoneCarrierType": {
"name": "UNKNOWN",
"emailDomain": ""
},
"id": "",
"createdUserId": "",
"disablePaymentType": false,
"disableAmount": false,
"digitalSignature": "iVBORw0KGgoAAAANSUhEUgAAAgUAAAB4CAYAAABiv4E7AAAAAXNSR0IArs4c6QAAC3VJREFUeF7t3W+ILWUdB/DvmXODiMQ/dY0gQcMKpCzsjwYSGmkooRgoFVHaiwrFUiL/Rxr5okwL+iMapJX2ooQwTAuhK6KQlZVdKqLAXmiZRmhRaHlmunNa2905c/bunt095+yZz3l5d+Z5Zj7P79z97fP85plekl3xIUCAAAECBDov0JMUdD4GABAgQIAAgaGApEAgECBAgAABApICMUCAAAECBAgsC5gpEA0ECBAgQICAmQIxQIAAAQIECJgpEAMECBAgQIBAQ8DygZAgQIAAAQIELB+IAQIECBAgQMDygRggQIAAAQIELB+IAQIECBAgQKBNQE2BuCBAgAABAgTUFIgBAgQIECBAQE2BGCBAgAABAgTUFIgBAgQIECBAQE2BGCBAgAABAgTGCig0FBwECBAgQIDAUEBSIBAIECBAgAABSYEYIECAAAECBJYFzBSIBgIECBAgQMBMgRggQIAAAQIEzBSIAQIECBAgQKAhYPlASBAgQIAAAQKWD8QAAQIECBAgYPlADBAgQIAAAQKWD8QAAQIECBAg0CagpkBcECBAgAABAmoKxAABAgQIECCgpkAMECBAgAABAmoKxAABAgQIECCgpkAMECBAgAABAmMFFBoKDgIECBAgQGAoICkQCAQIECBAgICkQAwQIECAAAECywJmCkQDAQIECBAgYKZADBAgQIAAAQJmCsQAAQIECBAg0BCwfCAkCBAgQIAAAcsHYoAAAQIECBCwfCAGCBAgQIAAAcsHYoAAAQIECBBoE1BTIC4IECBAgAABNQVigAABAgQIEFBTIAYIECBAgAABNQVigAABAgQIEFBTIAYIECBAgACBsQIKDQUHAQIECBAgMBSQFAgEAgQIECBAQFIgBggQIECAAIFlATMFooEAAQIECBAwUyAGCBAgQIAAATMFYoAAAQIECBBoCFg+EBIECBAgQICA5QMxQIAAAQIECFg+EAMECBAgQICA5QMxQIAAAQIECLQJqCkQFwQIECBAgICaAjFAgAABAgQIqCkQAwQIECBAgICaAjFAgAABAgQIqCkQAwQIECBAgMBYAYWGgoMAAQIECBAYCkgKBAIBAgQIECAgKRADBAgQIECAwLKAmQLRQIAAAQIECHRlpmDXCcmz9xhvAgQIECBAYG2BBZ8pKH6W5LVJ775kcKJgIECAAAECBMYLLHBSUFyZ5PLlWy9OMmPgq0CAAAECBDqZFNQ3XTya5NCl278kKa8VDAQIECBAgEC7wALPFAyTgseSvGjp1r+WlB8SCAQIECBAgEA3k4Lrkpy/dOvPJOURSZ4QDAQIECBAgMCowILPFOT1SfHjFbf90aT8ikAgQIAAAQIEupcU1EsI/1m+7eq7SXWWQCBAgAABAgQ6mRT09yTV8Uu3/q+kPNISgq8CAQIECBCQFNQCVydl/biiDwECBAgQILBCYNFrCurlg8Z+BfXdl88TBQQIECBAgMBqgQ4kBfU2x+XdjYE3W+CbQIAAAQIEGgIdSAqyOyn+1LjvurbgQNFAgAABAgQILAt0ISk4KCn+Uq8jmC0Q+gQIECBAYLxAF5KCxmOJKzHUFqzzy1HPtpyZlD9PsnLfh3We7jACBAgQ2AkCXUkKrk5y0eiA9M5IBnfshIGa3TX2z06q65PsWrqGW5LynNldj54JECBAYLsEOpIU9N+R1BsXjXzOS8obtwt3MdotHk7ystX3Ur4iyR8X4/7cBQECBAg8J9CRpKC+3eLxJAc3ht5Lktb+LjS3iV46uveeZPAdXyMCBAgQWCyBLiUFNyV57+jwqSsYH9LFJ5Nc0fj5Y0l52GJ9DdwNAQIECNQCHUoK+qcm1e0tw+4lSa3fheH+DvVbJl/T+LGaAv93ECBAYEEFOpQU5MCkf3JSfatltuC4JA8u6BhPeFvFF/a9I+K80ZN7pyeDOyds1GkECBAgMMcCXUoK6mHYnfRuTnont4yJXQ5Xoax8u+RzP+j9NBmckuSpOY5pl0aAAAECEwp0LSmon6yrp8VPS3J+i5nCwyFK79tJ/bhm89M7LRncNWGsOY0AAQIE5lygg0lBPSLD+oIvjz5qNxyta5Lysjkft228vKJ2+WBLB48k5RHb2LGmCRAgQGDGAh1NCobqb056F7b/RVy+KckvZjw2M+i+f2Z7zUV9KeUJSe6fwUXpkgABAgSmJNDlpKAmfnlSXJzkA6PeXXtUsf/+pLqhnkZpib0vJeWFU4pJ3RAgQIDAjAS6nhQssfe+31J8eH1SfmRG4zKDbodvktzd0vGnk/KqGVyQLgkQIEBgygKSgv+DF/9I8vzV/uXRSX475TGZdncvTYqPjym8vDEpWx5LnPYl6o8AAQIEpiEgKVhWPiopHmqgL/pjiockxb1JXtUSbH9Iyrcm+fM0AlEfBAgQIDB7AUnBqjEo6h38Vj6q+Pdk+PKfv81+qLb8Cg5fmiFoedKgujOpLk3ymy3vVYMECBAgMLcCkoLVQ3NsUty3+p8W8eU//Xcl1eeSvGQ0Muu3SVafSPK7uY1aF0aAAAEC2yIgKRhhLeoK/JVPI/w1KQ9P8sy2jMD0Gz0y6V2f9OpHDJufuobg8iRPTv+y9EiAAAECsxaQFLSOQHOL3+q2pHr3rAdra/ofu1th/TrkHySpCy59CBAgQKCDApKC9qTgmn1/LV+w4kd7k/KYnR0f9fbOg3PbN2vKTUnZtovhzr5lV0+AAAECGxKQFIzl6u9JquNX/HiHvxdh3AxB6ics6q2Nn9hQ5DiYAAECBBZOQFIwPilo2/J3Jz6iWD9l8Kl9hYNtyx/2IVi4r7QbIkCAwOQCkoI17York9SFdys+ZT178MDk5FM7s97C+X37agQ+Nrop0/AabknKc6Z2NToiQIAAgbkXkBSsPUT1X9l7Gm9TfCgp3zDHI3tw0n9bUn12zFsg60u/IikeSJ69Z47vw6URIECAwJQFJAX7BW+bLcitSXn2fk+dyQFFXTBY1wiM+ZRvSfKrJP+cyeXplAABAgTmVkBSsK6hKepfss3q/M8n5UXrOn1qB/XPTqqvrtHdTqyJmJqejggQINB1AUnB+iKgXkbY21ibfyTpnZ8M7lhfE9t9VP/UpPpGkgNHexruUviZJA9u91VonwABAgR2roCkYN1jV3wxyYcbhz+elO+cj8LDkfc21Jf6eNK7wKZE6x5kBxIgQKDTApKCDQ1/27P+vfuSwYkbambrD65nMu5Pcmij6W8m5cotm7e+Zy0SIECAwMIISAo2NpRHJ8VdLb98r0vKizfW1FYe3VYMWf0oqd6+lb1oiwABAgQWW0BSsOHxHVfMV5w0u0f8WmcwzpifeocNIzuBAAECBGYgICmYCL3fstvhsJjvrIma29xJRyXFQ6NNlId4udHmYJ1NgACBrglICiYe8eLXSV65+vTyjUl+OXGTE5048o6GupUd/p6GiSCcRIAAAQKbFJAUTAy46/ikrHc7XPm5Jikvm7jJDZ84fKfBpS2zBDNITjZ88U4gQIAAgTkTkBRsakCaf6VP+0mE4qkkL2jcgncabGpMnUyAAIHuCkgKNjX2rVsg7016VyWD2zfV9H5P7n0v6Z3SOOzppDwsyZP7Pd0BBAgQIECgISAp2FRI7DohKe8e08SzSfXDpLc3KW9L0lIMOGnnY/u9NikvmbRV5xEgQIBAtwUkBZsb/wOS4t4kr15HM/9OqvuT3k+S8utJfr+Oc+rxWWp710FJ9cKkOnbfToXnJjm4cb7iwnWAOoQAAQIExgtICjYdHWvOFqzV+tNJHk2qh5PigKUDB0mqfa82rmcZjkny3L+v4yp7pyeDO9dxoEMIECBAgECrgKRgawLjdUlxQ5L6F/kMPtMucJzBLeqSAAECBLZdQFKwtcQvTvon/W96vzpua5se11p1T1Lcmgxunk5/eiFAgACBRRX4L0P/X2hOEIl8AAAAAElFTkSuQmCC",
"agreeToPayInd": false,
"agreeToAcceptRefundInd": false,
"goodsAndServicesPurchaseType": {
"name": "SERVICE"
},
"checkInDate": "2024-01-04",
"checkOutDate": "2024-01-11",
"recurrenceEndDate": "",
"bookingNumber": "123123",
"groupName": "Conference",
"customerName": "John Smith",
"membershipNumber": "",
"merchantLocation": "LES ARCS PANORAMA",
"customerId": "",
"numberOfCards": "1",
"confirmationInd": false,
"productCode": null,
"geolocation": null,
"qualifiedHealthcareAmount": null,
"amountType": {
"name": "UNKNOWN"
},
"numberOfInstallments": null,
"gender": {
"name": "UNSPECIFIED"
},
"sameAsUserAddress": [
false,
false
]
}
Updated As Of Version 6.0.4.2