Jump to

• Request
• Response

Retrieves the default payment instruction by ID

get

/service/lmm/defaultPaymentInstruction/{id}

This endpoint is used to get the default payment instruction by ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  Id of the user that needs to be fetched

Query Parameters

• version(optional): string
  Id of the user that needs to be fetched

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the defaultPaymentInstruction based on given id.

Body ()

Root Schema : LmmTmDefaultPaymentInstructionWrapperDTO

Type: object

Show Source

• data(optional): object LmmTmDefaultPaymentInstructionDTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/LmmTmDefaultPaymentInstructionDTO"
        }
    }
}

Nested Schema : LmmTmDefaultPaymentInstructionDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmDefaultPaymentInstructionDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "hostCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "description":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "customerName":{
                    "type":"string",
                    "description":"",
                    "maxLength":105
                },
                "LmmTmDefaultPaymentInstructionTemplateDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmmTmDefaultPaymentInstructionTemplateDTO"
                    }
                }
            }
        }
    ]
}

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 : LmmTmDefaultPaymentInstructionDTO-allOf[1]

Type: object

Show Source

• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• customerName(optional): string
  Maximum Length: 105
• description(optional): string
  Maximum Length: 100
• hostCode(optional): string
  Maximum Length: 36
• LmmTmDefaultPaymentInstructionTemplateDTO(optional): array LmmTmDefaultPaymentInstructionTemplateDTO

{
    "type":"object",
    "properties":{
        "hostCode":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "description":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":"",
            "maxLength":105
        },
        "LmmTmDefaultPaymentInstructionTemplateDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmDefaultPaymentInstructionTemplateDTO"
            }
        }
    }
}

Nested Schema : LmmTmDefaultPaymentInstructionTemplateDTO

Type: array

Show Source

• Array of: object LmmTmDefaultPaymentInstructionTemplateDTO

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

Nested Schema : LmmTmDefaultPaymentInstructionTemplateDTO

Type: object

Show Source

• ddaEntity(optional): string
  Maximum Length: 36
• ddaFromToAccount(optional): string
  Maximum Length: 36
• defaultPaymentInstructionId(optional): string
  Maximum Length: 36
• id(optional): string
  Maximum Length: 36
• templateName(optional): string
  Maximum Length: 50
• transferType(optional): string
  Maximum Length: 36

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "defaultPaymentInstructionId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "ddaFromToAccount":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "ddaEntity":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "transferType":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "templateName":{
            "type":"string",
            "description":"",
            "maxLength":50
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top