Jump to

• Request
• Response

Fetch messages

get

/service/statement/fetch

This endpoint is used to fetch messages for a customer for a period.

Request

Supported Media Types

• application/json

Query Parameters

• accountBranch(optional): string
  Account Branch
• accountNo(optional): string
  Virtual Account Number
• entityId(optional): string
  Entity Id
• fromDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  From Date
• msgType(optional): string
  Message Type MT<> & CAMT<>
• realCustomer(optional): string
  Real Customer Number
• toDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  To Date

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns list of messages

Headers

• Location: string

Body ()

Root Schema : MessageOutDTOCollection

Type: object

Collection of SWIFT / CAMT messages.

Show Source

• data(optional): array data
• messages(optional): object ResponseDto

{
    "description":"Collection of SWIFT / CAMT messages.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MessageOutDTO"
            }
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object MessageOutDTO
  SWIFT / CAMT message

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

Nested Schema : ResponseDto

Type: object

Show Source

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

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

Nested Schema : MessageOutDTO

Type: object

SWIFT / CAMT message

Show Source

• branch(optional): string
• branchDate(optional): string
• id(optional): string
• makerDtStamp(optional): string(date)
• makerId(optional): string
• message(optional): string
• msgType(optional): string
• parentReferenceNo(optional): string
• referenceNo(optional): string
• virtualAccountNo(optional): string
• virtualEntityId(optional): string
  Virtual Entity id for accounts

{
    "description":"SWIFT / CAMT message",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "branch":{
            "type":"string"
        },
        "branchDate":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "msgType":{
            "type":"string"
        },
        "parentReferenceNo":{
            "type":"string"
        },
        "referenceNo":{
            "type":"string"
        },
        "virtualAccountNo":{
            "type":"string"
        },
        "makerId":{
            "type":"string"
        },
        "makerDtStamp":{
            "type":"string",
            "format":"date"
        },
        "virtualEntityId":{
            "description":"Virtual Entity id for accounts",
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• 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"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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