Category links

API Links

Get AVS Authorization Details

Action: POST

Endpoint: /api/CoreCredit/Authorizations/GetAVSAuthDetail

Use this API to retrieve the AVS (address verification service) detail received for a transaction by using the transaction ID. This API can fetch the cardholder's registered address information, the calculated AVS data received from the scheme, and other information, including AVS results.

Request fields details
Fields Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

TransactionID

int64

Mandatory

Transaction Number for transaction being posted. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:23654789

Sample request body
{
  "Source": "WEB",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "TransactionID": 182797938
}
Response fields details
Fields Description

CardholderAddress

List Address details of a customer.

CalculatedAVSData

string

Address information calculated basis Product setup for an AVS Transaction. Valid Values:0-9, a-z Example:1012

Allowable Values:

20

ReceivedAVSData

string

Address information received via AVS Transaction. Valid Values:0-9, a-z Example:HNo. 10 1st street block 2

Allowable Values:

40

ReceivedZIPCode

string

Zip Code received in AVS transaction. Valid Values:0-9 Example:40093

Allowable Values:

9

AVSResult

string

AVS transaction decision basis product setup and analysis of received and calculated AVS data. Example:N[Neither address nor postal code matches]

Allowable Values:

100

Sample response body

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "CardholderAddress": {
      "AddressLine1": "12 High Street Road",
      "AddressLine2": "Near Downtown Lane",
      "PostalCode": "42135",
      "Country": "United States",
      "State": "Georgia",
      "County": null,
      "City": "Norcross",
      "POBoxNumber": null
    },
    "CalculatedAVSData": "655",
    "ReceivedAVSData": "12450",
    "ReceivedZIPCode": "97224",
    "AVSResult": "N-Neither address nor postal code matches"
  }
}