Jump to

• Request
• Response

Get all valid payment interface

get

/paymentinterface

This endpoint is used to get all valid payment interface maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat(optional): string
• externalSystemDetailsId(optional): string
• externalSystemId(optional): string
• includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• recordStat(optional): string
• serviceName(optional): string
• templateName(optional): string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : LmxTmInterfaceMasterCollection

Type: object

Collection of interface.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of interface.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTmInterfaceMasterDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LmxTmInterfaceMasterDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LmxTmInterfaceMasterDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : LmxTmInterfaceMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmxTmInterfaceMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "externalSystemDetailsId":{
                    "type":"string",
                    "description":""
                },
                "externalSystemId":{
                    "type":"string",
                    "description":""
                },
                "externalSystemName":{
                    "type":"string",
                    "description":""
                },
                "serviceName":{
                    "type":"string",
                    "description":""
                },
                "templateName":{
                    "type":"string",
                    "description":""
                },
                "LmxTmInterfaceDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmxTmInterfaceDetailsDTO"
                    }
                },
                "LmxTmInterfaceServiceDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmxTmInterfaceServiceDetailsDTO"
                    }
                },
                "LmxTmInterfaceEventDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmxTmInterfaceEventDetailsDTO"
                    }
                }
            },
            "required":[
                "externalSystemDetailsId"
            ]
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmxTmInterfaceMasterDTO-allOf[1]

Type: object

Show Source

• externalSystemDetailsId: string
• externalSystemId(optional): string
• externalSystemName(optional): string
• LmxTmInterfaceDetailsDTO(optional): array LmxTmInterfaceDetailsDTO
• LmxTmInterfaceEventDetailsDTO(optional): array LmxTmInterfaceEventDetailsDTO
• LmxTmInterfaceServiceDetailsDTO(optional): array LmxTmInterfaceServiceDetailsDTO
• serviceName(optional): string
• templateName(optional): string

{
    "type":"object",
    "properties":{
        "externalSystemDetailsId":{
            "type":"string",
            "description":""
        },
        "externalSystemId":{
            "type":"string",
            "description":""
        },
        "externalSystemName":{
            "type":"string",
            "description":""
        },
        "serviceName":{
            "type":"string",
            "description":""
        },
        "templateName":{
            "type":"string",
            "description":""
        },
        "LmxTmInterfaceDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTmInterfaceDetailsDTO"
            }
        },
        "LmxTmInterfaceServiceDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTmInterfaceServiceDetailsDTO"
            }
        },
        "LmxTmInterfaceEventDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTmInterfaceEventDetailsDTO"
            }
        }
    },
    "required":[
        "externalSystemDetailsId"
    ]
}

Nested Schema : LmxTmInterfaceDetailsDTO

Type: array

Show Source

• Array of: object LmxTmInterfaceDetailsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LmxTmInterfaceDetailsDTO"
    }
}

Nested Schema : LmxTmInterfaceEventDetailsDTO

Type: array

Show Source

• Array of: object LmxTmInterfaceEventDetailsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LmxTmInterfaceEventDetailsDTO"
    }
}

Nested Schema : LmxTmInterfaceServiceDetailsDTO

Type: array

Show Source

• Array of: object LmxTmInterfaceServiceDetailsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LmxTmInterfaceServiceDetailsDTO"
    }
}

Nested Schema : LmxTmInterfaceDetailsDTO

Type: object

Show Source

• id(optional): string
• interfaceMasterId(optional): string
• parameterName(optional): string
• parameterValue(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "interfaceMasterId":{
            "type":"string",
            "description":""
        },
        "parameterName":{
            "type":"string",
            "description":""
        },
        "parameterValue":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : LmxTmInterfaceEventDetailsDTO

Type: object

Show Source

• eventCode(optional): string
• eventDescription(optional): string
• id(optional): string
• interfaceMasterId(optional): string

{
    "type":"object",
    "properties":{
        "eventCode":{
            "type":"string",
            "description":""
        },
        "eventDescription":{
            "type":"string",
            "description":""
        },
        "id":{
            "type":"string",
            "description":""
        },
        "interfaceMasterId":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : LmxTmInterfaceServiceDetailsDTO

Type: object

Show Source

• id(optional): string
• interfaceMasterId(optional): string
• parameterName(optional): string
• parameterValue(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "interfaceMasterId":{
            "type":"string",
            "description":""
        },
        "parameterName":{
            "type":"string",
            "description":""
        },
        "parameterValue":{
            "type":"string",
            "description":""
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top