Jump to

• Request
• Response

Adds a new txn

post

/service/txns

This endpoint is used to add a new transaction.

Request

Supported Media Types

• application/json

Body ()

Request Body that contains data required for creating a new txn

Root Schema : VatRequestMastServiceDTO

Type: object

Show Source

• sourceCode: string
• sourceReferenceNo(optional): string
• vatRequestDetServiceDTO: array vatRequestDetServiceDTO

{
    "type":"object",
    "properties":{
        "sourceCode":{
            "type":"string"
        },
        "sourceReferenceNo":{
            "type":"string"
        },
        "vatRequestDetServiceDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VatRequestDetServiceDTO"
            }
        }
    },
    "required":[
        "sourceCode",
        "vatRequestDetServiceDTO"
    ]
}

Nested Schema : vatRequestDetServiceDTO

Type: array

Show Source

• Array of: object VatRequestDetServiceDTO

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

Nested Schema : VatRequestDetServiceDTO

Type: object

Show Source

• addlText(optional): string
  Minimum Length: 0

  Maximum Length: 4000

  Customer narrative information received from External System or User can also enter the addl text
• amtInTxnAccCcy(optional): number
• blkReleaseStatus(optional): string
  Maximum Length: 1

  Pattern: [P,F]
• ddaOffset(optional): string
• drCrInd: string
  Maximum Length: 1

  Pattern: [D,C]
• ecaOrBlockRefNo(optional): string
• exchRate(optional): number
• forceDebit(optional): string
  Maximum Length: 1

  Default Value: N

  Pattern: [Y,N]
• reconRefNo(optional): string
• txnAccount: string
• txnAccountBrn: string
  Maximum Length: 3
• txnAccountCcy(optional): string
  Maximum Length: 3
• txnAmount: number
• txnCcy: string
  Maximum Length: 3
• txnCode: string
• valueDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

{
    "type":"object",
    "properties":{
        "drCrInd":{
            "type":"string",
            "maxLength":1,
            "pattern":"[D,C]"
        },
        "txnAccount":{
            "type":"string"
        },
        "txnAccountBrn":{
            "type":"string",
            "maxLength":3
        },
        "txnCcy":{
            "type":"string",
            "maxLength":3
        },
        "txnAccountCcy":{
            "type":"string",
            "maxLength":3
        },
        "amtInTxnAccCcy":{
            "type":"number"
        },
        "txnAmount":{
            "type":"number"
        },
        "txnCode":{
            "type":"string"
        },
        "valueDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "exchRate":{
            "type":"number"
        },
        "reconRefNo":{
            "type":"string"
        },
        "addlText":{
            "type":"string",
            "description":"Customer narrative information received from External System or User can also enter the addl text",
            "minLength":0,
            "maxLength":4000
        },
        "ecaOrBlockRefNo":{
            "type":"string"
        },
        "ddaOffset":{
            "type":"string"
        },
        "forceDebit":{
            "type":"string",
            "maxLength":1,
            "pattern":"[Y,N]",
            "default":"N"
        },
        "blkReleaseStatus":{
            "type":"string",
            "maxLength":1,
            "pattern":"[P,F]"
        }
    },
    "required":[
        "drCrInd",
        "txnAccount",
        "txnAccountBrn",
        "txnCcy",
        "txnAmount",
        "txnCode"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created txn

Body ()

Root Schema : TransactionResponseDTOWrapper

Type: object

Show Source

• messages(optional): object ResponseDto
• transactionData(optional): object TransactionMasterDTO

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "transactionData":{
            "$ref":"#/definitions/TransactionMasterDTO"
        }
    }
}

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 : TransactionMasterDTO

Type: object

Match All

Show Source

• allOf ResourceSupport
• object TransactionMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/ResourceSupport"
        },
        {
            "type":"object",
            "properties":{
                "keyId":{
                    "type":"string"
                },
                "txnRefNo":{
                    "type":"string"
                },
                "sourceCode":{
                    "type":"string"
                },
                "sourceReferenceNo":{
                    "type":"string"
                },
                "bookingDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
                },
                "initiationDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
                },
                "authStatus":{
                    "type":"string"
                },
                "transactionStatus":{
                    "type":"string"
                },
                "originalReferenceNo":{
                    "type":"string"
                },
                "checkerDtStamp":{
                    "type":"string",
                    "format":"date"
                },
                "checkerId":{
                    "type":"string"
                },
                "makerDtStamp":{
                    "type":"string",
                    "format":"date"
                },
                "makerId":{
                    "type":"string"
                },
                "transactionDetailsDTOList":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/TransactionDetailsDTO"
                    }
                }
            }
        }
    ]
}

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

Nested Schema : ResourceSupport

Match All

Show Source

• object ResourceSupport-allOf[0]
  Discriminator: resource_type

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

Nested Schema : ResourceSupport-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : TransactionMasterDTO-allOf[1]

Type: object

Show Source

• authStatus(optional): string
• bookingDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• checkerDtStamp(optional): string(date)
• checkerId(optional): string
• initiationDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• keyId(optional): string
• makerDtStamp(optional): string(date)
• makerId(optional): string
• originalReferenceNo(optional): string
• sourceCode(optional): string
• sourceReferenceNo(optional): string
• transactionDetailsDTOList(optional): array transactionDetailsDTOList
• transactionStatus(optional): string
• txnRefNo(optional): string

{
    "type":"object",
    "properties":{
        "keyId":{
            "type":"string"
        },
        "txnRefNo":{
            "type":"string"
        },
        "sourceCode":{
            "type":"string"
        },
        "sourceReferenceNo":{
            "type":"string"
        },
        "bookingDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "initiationDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "authStatus":{
            "type":"string"
        },
        "transactionStatus":{
            "type":"string"
        },
        "originalReferenceNo":{
            "type":"string"
        },
        "checkerDtStamp":{
            "type":"string",
            "format":"date"
        },
        "checkerId":{
            "type":"string"
        },
        "makerDtStamp":{
            "type":"string",
            "format":"date"
        },
        "makerId":{
            "type":"string"
        },
        "transactionDetailsDTOList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionDetailsDTO"
            }
        }
    }
}

Nested Schema : transactionDetailsDTOList

Type: array

Show Source

• Array of: object TransactionDetailsDTO

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

Nested Schema : TransactionDetailsDTO

Type: object

Show Source

• accountType(optional): string
• addlText(optional): string
  Minimum Length: 0

  Maximum Length: 4000

  Customer narrative information received from External System or User can also enter the addl text
• amtInRealAccCcy(optional): number
• amtInTxnAccCcy(optional): number
• blkReleaseStatus(optional): string
  Maximum Length: 1

  Pattern: [P,F]
• ddaOffset(optional): string
• drCrInd(optional): string
• ecaOrBlockRefNo(optional): string
• entrySerialNo(optional): number
• exchRate(optional): number
• excRateTxccyRaccy(optional): number
• forceDebit(optional): string
• id(optional): string
• realAccCcy(optional): string
• realAccClass(optional): string
• realAccountBrn(optional): string
• realAccountNo(optional): string
• realCustomerNo(optional): string
• reconRefNo(optional): string
• reportingInfo(optional): string
• skipDDAEntries(optional): string
• txnAccount(optional): string
• txnAccountBrn(optional): string
• txnAccountCcy(optional): string
• txnAmount(optional): number
• txnCcy(optional): string
• txnCode(optional): string
• txnMasterId(optional): string
• txnRefNo(optional): string
• valueDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "txnMasterId":{
            "type":"string"
        },
        "txnRefNo":{
            "type":"string"
        },
        "entrySerialNo":{
            "type":"number"
        },
        "drCrInd":{
            "type":"string"
        },
        "txnAccount":{
            "type":"string"
        },
        "txnAccountBrn":{
            "type":"string"
        },
        "txnCcy":{
            "type":"string"
        },
        "txnAmount":{
            "type":"number"
        },
        "txnCode":{
            "type":"string"
        },
        "valueDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "txnAccountCcy":{
            "type":"string"
        },
        "amtInTxnAccCcy":{
            "type":"number"
        },
        "exchRate":{
            "type":"number"
        },
        "realAccCcy":{
            "type":"string"
        },
        "amtInRealAccCcy":{
            "type":"number"
        },
        "realAccClass":{
            "type":"string"
        },
        "excRateTxccyRaccy":{
            "type":"number"
        },
        "reconRefNo":{
            "type":"string"
        },
        "addlText":{
            "type":"string",
            "description":"Customer narrative information received from External System or User can also enter the addl text",
            "minLength":0,
            "maxLength":4000
        },
        "reportingInfo":{
            "type":"string"
        },
        "accountType":{
            "type":"string"
        },
        "realAccountNo":{
            "type":"string"
        },
        "realAccountBrn":{
            "type":"string"
        },
        "ecaOrBlockRefNo":{
            "type":"string"
        },
        "ddaOffset":{
            "type":"string"
        },
        "forceDebit":{
            "type":"string"
        },
        "skipDDAEntries":{
            "type":"string"
        },
        "blkReleaseStatus":{
            "type":"string",
            "maxLength":1,
            "pattern":"[P,F]"
        },
        "realCustomerNo":{
            "type":"string"
        }
    }
}

400 Response

Bad request error, the server is unable to process the request.

401 Response

Unauthorized request error, invalid credentials.

403 Response

Request denied, no permission to access the request.

405 Response

Request denied, invalid input.

500 Response

Internal server error.

Back to Top