Jump to

• Request
• Response

Get count of valid remittanceids per identifier for a given customer

get

/service/remitters/downloadremitter/{realCustomerNo}/{virtualIdentifier}

This endpoint is used to download valid remittance ids for a given customer and identifier.

Request

Supported Media Types

• application/json

Path Parameters

• realCustomerNo: string
  Real Customer No of remittance list id
• virtualIdentifier: string
  Virtual identifier

Header Parameters

• sourceCode: string
  Source Code

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : RemitterIdDownloadCollection

Type: object

Collection of Remitter download.

Show Source

• data(optional): object data
• messages(optional): object RemitterIdServiceResponseDto

{
    "description":"Collection of Remitter download.",
    "type":"object",
    "properties":{
        "data":{
            "type":"object",
            "items":{
                "$ref":"#/definitions/RemitterIdDownloadDTO"
            }
        },
        "messages":{
            "$ref":"#/definitions/RemitterIdServiceResponseDto"
        }
    }
}

Nested Schema : data

Type: object

Show Source

• Array of: object RemitterIdDownloadDTO

{
    "type":"object",
    "items":{
        "$ref":"#/definitions/RemitterIdDownloadDTO"
    }
}

Nested Schema : RemitterIdServiceResponseDto

Type: object

Show Source

• codes(optional): array codes
• status(optional): string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RemitterIdServiceResponseCode"
            }
        }
    }
}

Nested Schema : RemitterIdDownloadDTO

Type: object

Show Source

• realCustomerNo(optional): string
  Real Customer
• remitterData(optional): string
  remitter details for the real customer and identifier
• virtualIdentifier(optional): string
  Virtual Identifier

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "description":"Real Customer",
            "type":"string"
        },
        "virtualIdentifier":{
            "description":"Virtual Identifier",
            "type":"string"
        },
        "remitterData":{
            "type":"string",
            "description":"remitter details for the real customer and identifier"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object RemitterIdServiceResponseCode

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

Nested Schema : RemitterIdServiceResponseCode

Type: object

Show Source

• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        }
    }
}

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