Verify
Verify (Check Payment Method) transaction can have two purposes:
- To check the validity of the payment method provided, e.g. the credit card validation
- To generate a token without processing an actual Authorization or Deposit transaction
Verify transaction request parameters must include:
- Amount = 0,00
- credit card information
In case the transaction request Tokenization values are either Internal or External, the gateway will return a response including a new "PaymentMethodToken": "Token". Save the token and use it with all subsequent transactions instead of credit card information.
Go to Tokenization chapter for more information on Tokenization.
if a customer changes their credit card information, a new token should be issued and credit card must be validated as well.
Request Parameters
| Name | Type | Optionality | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. Must be greater than 0. | |||||||||||||||||||||
| accountOwnerId | string | optional | Credit Card Account Owner ID. MaxLength(50) | |||||||||||||||||||||
| amount | decimal | ✓ | Transaction amount. Value ≥ 0 (2 decimal places) | |||||||||||||||||||||
| billingAddress | object | optional | User Billing Address data object. | |||||||||||||||||||||
| billingOverride | object | optional | Data object that contains an array of billingFee objects. | |||||||||||||||||||||
| creditCard | object | conditional | Credit Card data object. Required if payment method = creditcard. | |||||||||||||||||||||
| ach | object | conditional | ACH data object. required if payment method = ACH. | |||||||||||||||||||||
| currency | enum | ✓ | currencyTypeId. Available Values:
| |||||||||||||||||||||
| merchantData | object | optional | Merchant Data data object. | |||||||||||||||||||||
| entryMode | integer | optional | Nullable Transaction entry mode numerical value. | |||||||||||||||||||||
| paymentMethod | enum | ✓ | paymentMethodTypeId. Available Values:
| |||||||||||||||||||||
| processorData | object | optional | Processor Data data object. | |||||||||||||||||||||
| subAccountId | integer | ✓ | Sub-Account identifier. Value ≥ 0 | |||||||||||||||||||||
| terminalId | string | optional | Terminal identifier. MaxLength(20) | |||||||||||||||||||||
| transactionMethod | enum | optional | transactionMethodiId. Available Values:
| |||||||||||||||||||||
| type | enum | ✓ | transactionTypeId. Available Values:
|
//Verify request example
{
"accountId": "Platform Account Id",
"accountOwnerId": "СС Account Owner ID",
"amount": 13,
"billingAddress": {
"addressLine": "Address",
"city": "City Name",
"country": "USA",
"email": "email@mail.com",
"phoneNumber": "12346879",
"state": "FL",
"zipPostalCode": "123465798"
},
"billingOverride": [
{
"fixedAmount": "feeFixedAmount",
"id": "objectId",
"percentageAmount": "feePercentageAmount",
"sourceId": "feeSourceIdentifier",
"sourceType": "BillingAccountId",
"targetId": "feeTargetIdentifier",
"targetType": "BillingAccountId",
"reverse": "true",
"billingAmount": "billingAmountValue"
}
],
"creditCard": {
"number": "4111111111111111",
"expirationDate": "1225",
"nameOnCard": "Eleanor Johansson",
"type": "Visa",
"cvv": "123"
},
"currency": "USD",
"merchantData": {
"freeText": "string",
"transactionDate": "dateTime",
"transactionDescription": "string",
"transactionId": "string"
},
"entryMode": "2",
"paymentMethod": "CreditCard",
"processorData": {
"dynamicDescriptor": "01919Z"
},
"subAccountId": "Sub-Account Id",
"terminalId": "string",
"transactionMethod": "RegularTransaction",
"type": "Verify"
}