Jump to

• Request
• Response

Get All Payments for Account After Specified Date

get

/dmpayment-service/payments

This endpoint is used to get all payments for an account after a specified date.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountId: string
  Account ID.
• date: string
  Date.

Header Parameters

• appId: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• contentType(optional): string
  The content type of request or response body.
• userId: string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns collection of payment details.

Body ()

Root Schema : DmPaymentDTOCollection

Type: object

The Collection of payment DTO

Show Source

• data(optional): array data

{
    "description":"The Collection of payment DTO",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmPaymentDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object DmPaymentDTO
  DmPayment model

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

Nested Schema : DmPaymentDTO

Type: object

DmPayment model

Show Source

• accountId(optional): string
  The account Id of the Payment
• origXrefNo(optional): string
  The origXref Number of the Payment
• transactionAmt(optional): number
  The transaction Amount of the Payment
• transactionCurrCd(optional): string
  The transaction Currency code of the DmPayment
• transactionDttm(optional): string
  The transaction Date and Time of the Payment
• transactionTypeFlg(optional): string
  The transaction Type Flag of the Payment
• xrefNo(optional): string
  The xref Number of the Payment

{
    "description":"DmPayment model",
    "type":"object",
    "properties":{
        "accountId":{
            "description":"The account Id of the Payment",
            "type":"string"
        },
        "xrefNo":{
            "description":"The  xref Number of the Payment",
            "type":"string"
        },
        "transactionDttm":{
            "description":"The transaction Date and Time of the Payment",
            "type":"string"
        },
        "transactionCurrCd":{
            "description":"The transaction Currency code of the DmPayment",
            "type":"string"
        },
        "transactionAmt":{
            "description":"The transaction Amount of the Payment",
            "type":"number"
        },
        "transactionTypeFlg":{
            "description":"The transaction Type Flag of the Payment",
            "type":"string"
        },
        "origXrefNo":{
            "description":"The origXref Number of the Payment",
            "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