Transaction Specifications (GET)

Transaction Specifications (GET)


GET json/Transaction/Specification/{serviceName}?serviceVersion={serviceVersion}

This returns the specification of the specified service

The authentication of this JSON API is based on a standard HMAC Authentication implementation.

Request information

URI Parameters

Name Type Description
serviceName string
serviceVersion integer

Body Parameters

None.

Response information

TransactionRequestSpecificationResponseServiceDescription

Name Type Description
Name string
Version integer
Description string
SupportedCurrencies Collection of Currency
Actions Collection of TransactionRequestSpecificationResponseActionDescription
{
  "SupportedCurrencies": [
    {
      "IsoNumber": 1,
      "Code": "sample string 2",
      "Name": "sample string 3"
    },
    {
      "IsoNumber": 1,
      "Code": "sample string 2",
      "Name": "sample string 3"
    }
  ],
  "Actions": [
    {
      "Name": "sample string 1",
      "Type": 0,
      "Default": true,
      "Description": "sample string 3",
      "RequestParameters": [
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        },
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        }
      ],
      "ResponseParameters": [
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        },
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        }
      ],
      "OriginalTransactionReferenceDescriptions": [
        {
          "Type": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Type": 0,
      "Default": true,
      "Description": "sample string 3",
      "RequestParameters": [
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        },
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        }
      ],
      "ResponseParameters": [
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        },
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        }
      ],
      "OriginalTransactionReferenceDescriptions": [
        {
          "Type": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Name": "sample string 2",
          "Description": "sample string 3"
        }
      ]
    }
  ],
  "Name": "sample string 1",
  "Version": 2,
  "Description": "sample string 3"
}

Was this article helpful?