Transaction Specifications (POST)

Transaction Specifications (POST)


POST json/Transaction/Specifications

Returns the specifications of the specified services

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

Request information

Body Parameters

TransactionRequest

Name Type Description
Services Collection of TransactionRequestSpecificationRequestedService

Request formats

{
  "Services": [
    {
      "Name": "sample string 1",
      "Version": 1
    },
    {
      "Name": "sample string 1",
      "Version": 1
    }
  ]
}

Response information

Name Type Description
BasicFields Collection of TransactionRequestSpecificationResponseFieldDescription
Services Collection of TransactionRequestSpecificationRequestedService
CustomParameters Collection of CustomParameterDefinition

Response formats

{
  "BasicFields": [
    {
      "Attributes": [
        {
          "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"
            }
          ],
          "Name": "sample string 1",
          "DataType": 0,
          "List": 0,
          "MaxLength": 2,
          "Required": true,
          "Description": "sample string 4"
        },
        {
          "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"
            }
          ],
          "Name": "sample string 1",
          "DataType": 0,
          "List": 0,
          "MaxLength": 2,
          "Required": true,
          "Description": "sample string 4"
        }
      ],
      "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"
        }
      ],
      "Name": "sample string 1",
      "DataType": 0,
      "Required": true,
      "Description": "sample string 4"
    },
    {
      "Attributes": [
        {
          "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"
            }
          ],
          "Name": "sample string 1",
          "DataType": 0,
          "List": 0,
          "MaxLength": 2,
          "Required": true,
          "Description": "sample string 4"
        },
        {
          "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"
            }
          ],
          "Name": "sample string 1",
          "DataType": 0,
          "List": 0,
          "MaxLength": 2,
          "Required": true,
          "Description": "sample string 4"
        }
      ],
      "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"
        }
      ],
      "Name": "sample string 1",
      "DataType": 0,
      "Required": true,
      "Description": "sample string 4"
    }
  ],
  "Services": [
    {
      "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"
    },
    {
      "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"
    }
  ],
  "CustomParameters": [
    {
      "Description": "sample string 1",
      "DataType": 0,
      "Name": "sample string 2"
    },
    {
      "Description": "sample string 1",
      "DataType": 0,
      "Name": "sample string 2"
    }
  ]
}

Was this article helpful?