Jump to

• Request
• Response

Adds a new intbks

post

/api/1.0/service/intbks

This endpoint is used to create an internal transfer.

Request

Supported Media Types

• application/json

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

Request Body that contains data required for creating a new intbks

Root Schema : VanTbInternalTransfersServiceSaveDTO

Type: object

Match All

Show Source

• object VanTbInternalTransfersServiceSaveDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "bookingRefNo":{
                    "type":"string",
                    "description":"Booking Reference Number.Auto-generated.Need not be input"
                },
                "bookingDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date of Booking"
                },
                "valueDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Value Date"
                },
                "txnBranch":{
                    "type":"string",
                    "description":"Real Account Branch"
                },
                "sourceCode":{
                    "type":"string",
                    "description":"Source Code"
                },
                "sourceRefNo":{
                    "type":"string",
                    "description":"Source Reference Number"
                },
                "realCustomerNo":{
                    "type":"string",
                    "description":"Real Customer Number"
                },
                "realAccountNo":{
                    "type":"string",
                    "description":"Real Account Number"
                },
                "realAccountBrn":{
                    "type":"string",
                    "description":"Real Account Branch"
                },
                "exchRate":{
                    "type":"number",
                    "description":"Exchange Rate"
                },
                "remarks":{
                    "type":"string",
                    "description":"Customer narrative information received from External System or User can also enter remarks",
                    "minLength":0,
                    "maxLength":4000
                },
                "drCr":{
                    "type":"string",
                    "description":"Debit Credit Indicator"
                },
                "txnVirtualAccountNo":{
                    "type":"string",
                    "description":"Transaction Virtual Account Number"
                },
                "offsetVirtualAccountNo":{
                    "type":"string",
                    "description":"Offset Virtual Account Number"
                },
                "txnVirtualAccountCcy":{
                    "type":"string",
                    "description":"Transaction Virtual Account Currency"
                },
                "offsetVirtualAccountCcy":{
                    "type":"string",
                    "description":"Offset Virtual Account Currency"
                },
                "txnAmount":{
                    "type":"number",
                    "description":"Transaction Amount"
                },
                "offsetAmount":{
                    "type":"number",
                    "description":"Offset Amount"
                },
                "txnTrnCode":{
                    "type":"string",
                    "description":"Transaction Code"
                },
                "offsetTrnCode":{
                    "type":"string",
                    "description":"Offset Transaction Code"
                },
                "originalRefNo":{
                    "type":"string",
                    "description":"Original Reference Number"
                }
            },
            "required":[
                "offsetVirtualAccountNo",
                "offsetVirtualAccountCcy",
                "txnVirtualAccountNo",
                "txnVirtualAccountCcy",
                "drCr",
                "realAccountNo",
                "txnBranch",
                "txnAmount",
                "txnTrnCode",
                "offsetTrnCode",
                "realCustomerNo",
                "valueDate"
            ]
        }
    ]
}

Nested Schema : VanTbInternalTransfersServiceSaveDTO-allOf[0]

Type: object

Show Source

• bookingDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Date of Booking
• bookingRefNo(optional): string
  Booking Reference Number.Auto-generated.Need not be input
• drCr: string
  Debit Credit Indicator
• exchRate(optional): number
  Exchange Rate
• offsetAmount(optional): number
  Offset Amount
• offsetTrnCode: string
  Offset Transaction Code
• offsetVirtualAccountCcy: string
  Offset Virtual Account Currency
• offsetVirtualAccountNo: string
  Offset Virtual Account Number
• originalRefNo(optional): string
  Original Reference Number
• realAccountBrn(optional): string
  Real Account Branch
• realAccountNo: string
  Real Account Number
• realCustomerNo: string
  Real Customer Number
• remarks(optional): string
  Minimum Length: 0

  Maximum Length: 4000

  Customer narrative information received from External System or User can also enter remarks
• sourceCode(optional): string
  Source Code
• sourceRefNo(optional): string
  Source Reference Number
• txnAmount: number
  Transaction Amount
• txnBranch: string
  Real Account Branch
• txnTrnCode: string
  Transaction Code
• txnVirtualAccountCcy: string
  Transaction Virtual Account Currency
• txnVirtualAccountNo: string
  Transaction Virtual Account Number
• valueDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Value Date

{
    "type":"object",
    "properties":{
        "bookingRefNo":{
            "type":"string",
            "description":"Booking Reference Number.Auto-generated.Need not be input"
        },
        "bookingDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date of Booking"
        },
        "valueDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Value Date"
        },
        "txnBranch":{
            "type":"string",
            "description":"Real Account Branch"
        },
        "sourceCode":{
            "type":"string",
            "description":"Source Code"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Source Reference Number"
        },
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer Number"
        },
        "realAccountNo":{
            "type":"string",
            "description":"Real Account Number"
        },
        "realAccountBrn":{
            "type":"string",
            "description":"Real Account Branch"
        },
        "exchRate":{
            "type":"number",
            "description":"Exchange Rate"
        },
        "remarks":{
            "type":"string",
            "description":"Customer narrative information received from External System or User can also enter remarks",
            "minLength":0,
            "maxLength":4000
        },
        "drCr":{
            "type":"string",
            "description":"Debit Credit Indicator"
        },
        "txnVirtualAccountNo":{
            "type":"string",
            "description":"Transaction Virtual Account Number"
        },
        "offsetVirtualAccountNo":{
            "type":"string",
            "description":"Offset Virtual Account Number"
        },
        "txnVirtualAccountCcy":{
            "type":"string",
            "description":"Transaction Virtual Account Currency"
        },
        "offsetVirtualAccountCcy":{
            "type":"string",
            "description":"Offset Virtual Account Currency"
        },
        "txnAmount":{
            "type":"number",
            "description":"Transaction Amount"
        },
        "offsetAmount":{
            "type":"number",
            "description":"Offset Amount"
        },
        "txnTrnCode":{
            "type":"string",
            "description":"Transaction Code"
        },
        "offsetTrnCode":{
            "type":"string",
            "description":"Offset Transaction Code"
        },
        "originalRefNo":{
            "type":"string",
            "description":"Original Reference Number"
        }
    },
    "required":[
        "offsetVirtualAccountNo",
        "offsetVirtualAccountCcy",
        "txnVirtualAccountNo",
        "txnVirtualAccountCcy",
        "drCr",
        "realAccountNo",
        "txnBranch",
        "txnAmount",
        "txnTrnCode",
        "offsetTrnCode",
        "realCustomerNo",
        "valueDate"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created intbks

Body ()

Root Schema : VanTbInternalTransfersResponseWrapperDTO

Type: object

Show Source

• data(optional): object VanTbInternalTransfersServiceDTO
• messages(optional): object VanTbInternalTransfersServiceResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/VanTbInternalTransfersServiceResponseDto"
        },
        "data":{
            "$ref":"#/definitions/VanTbInternalTransfersServiceDTO"
        }
    }
}

Nested Schema : VanTbInternalTransfersServiceDTO

Type: object

Match All

Show Source

• object VanTbInternalTransfersServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "bookingRefNo":{
                    "type":"string",
                    "description":"Booking Reference Number.Auto-generated.Need not be input"
                },
                "bookingDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date of Booking"
                },
                "valueDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Value Date"
                },
                "txnBranch":{
                    "type":"string",
                    "description":"Real Account Branch"
                },
                "sourceCode":{
                    "type":"string",
                    "description":"Source Code"
                },
                "sourceRefNo":{
                    "type":"string",
                    "description":"Source Reference Number"
                },
                "realCustomerNo":{
                    "type":"string",
                    "description":"Real Customer Number"
                },
                "realAccountNo":{
                    "type":"string",
                    "description":"Real Account Number"
                },
                "exchRate":{
                    "type":"number",
                    "description":"Exchange Rate"
                },
                "remarks":{
                    "type":"string",
                    "description":"Customer narrative information received from External System or User can also enter remarks",
                    "minLength":0,
                    "maxLength":4000
                },
                "transactionStatus":{
                    "type":"string",
                    "description":"Transaction Status"
                },
                "authStatus":{
                    "type":"string",
                    "description":"Auth Status"
                },
                "drCr":{
                    "type":"string",
                    "description":"Debit Credit Indicator"
                },
                "txnVirtualAccountNo":{
                    "type":"string",
                    "description":"Transaction Virtual Account Number"
                },
                "offsetVirtualAccountNo":{
                    "type":"string",
                    "description":"Offset Virtual Account Number"
                },
                "txnVirtualAccountCcy":{
                    "type":"string",
                    "description":"Transaction Virtual Account Currency"
                },
                "offsetVirtualAccountCcy":{
                    "type":"string",
                    "description":"Offset Virtual Account Currency"
                },
                "txnAmount":{
                    "type":"number",
                    "description":"Transaction Amount"
                },
                "offsetAmount":{
                    "type":"number",
                    "description":"Offset Amount"
                },
                "txnTrnCode":{
                    "type":"string",
                    "description":"Transaction Code"
                },
                "offsetTrnCode":{
                    "type":"string",
                    "description":"Offset Transaction Code"
                },
                "originalRefNo":{
                    "type":"string",
                    "description":"Original Reference Number"
                },
                "checkerDtStamp":{
                    "type":"string",
                    "description":"DateStamp of Authorization"
                },
                "makerDtStamp":{
                    "type":"string",
                    "description":"DateStamp of Making of the Transaction"
                },
                "checkerId":{
                    "type":"string",
                    "description":"User id of Authorizer"
                },
                "makerId":{
                    "type":"string",
                    "description":"User id of Maker"
                }
            },
            "required":[
                "offsetVirtualAccountNo",
                "offsetVirtualAccountCcy",
                "txnVirtualAccountNo",
                "txnVirtualAccountCcy",
                "drCr",
                "realAccountNo",
                "txnBranch",
                "txnAmount",
                "txnTrnCode",
                "offsetTrnCode",
                "realCustomerNo",
                "valueDate"
            ]
        }
    ]
}

Nested Schema : VanTbInternalTransfersServiceResponseDto

Type: object

Show Source

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

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

Nested Schema : VanTbInternalTransfersServiceDTO-allOf[0]

Type: object

Show Source

• authStatus(optional): string
  Auth Status
• bookingDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Date of Booking
• bookingRefNo(optional): string
  Booking Reference Number.Auto-generated.Need not be input
• checkerDtStamp(optional): string
  DateStamp of Authorization
• checkerId(optional): string
  User id of Authorizer
• drCr: string
  Debit Credit Indicator
• exchRate(optional): number
  Exchange Rate
• makerDtStamp(optional): string
  DateStamp of Making of the Transaction
• makerId(optional): string
  User id of Maker
• offsetAmount(optional): number
  Offset Amount
• offsetTrnCode: string
  Offset Transaction Code
• offsetVirtualAccountCcy: string
  Offset Virtual Account Currency
• offsetVirtualAccountNo: string
  Offset Virtual Account Number
• originalRefNo(optional): string
  Original Reference Number
• realAccountNo: string
  Real Account Number
• realCustomerNo: string
  Real Customer Number
• remarks(optional): string
  Minimum Length: 0

  Maximum Length: 4000

  Customer narrative information received from External System or User can also enter remarks
• sourceCode(optional): string
  Source Code
• sourceRefNo(optional): string
  Source Reference Number
• transactionStatus(optional): string
  Transaction Status
• txnAmount: number
  Transaction Amount
• txnBranch: string
  Real Account Branch
• txnTrnCode: string
  Transaction Code
• txnVirtualAccountCcy: string
  Transaction Virtual Account Currency
• txnVirtualAccountNo: string
  Transaction Virtual Account Number
• valueDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Value Date

{
    "type":"object",
    "properties":{
        "bookingRefNo":{
            "type":"string",
            "description":"Booking Reference Number.Auto-generated.Need not be input"
        },
        "bookingDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date of Booking"
        },
        "valueDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Value Date"
        },
        "txnBranch":{
            "type":"string",
            "description":"Real Account Branch"
        },
        "sourceCode":{
            "type":"string",
            "description":"Source Code"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Source Reference Number"
        },
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer Number"
        },
        "realAccountNo":{
            "type":"string",
            "description":"Real Account Number"
        },
        "exchRate":{
            "type":"number",
            "description":"Exchange Rate"
        },
        "remarks":{
            "type":"string",
            "description":"Customer narrative information received from External System or User can also enter remarks",
            "minLength":0,
            "maxLength":4000
        },
        "transactionStatus":{
            "type":"string",
            "description":"Transaction Status"
        },
        "authStatus":{
            "type":"string",
            "description":"Auth Status"
        },
        "drCr":{
            "type":"string",
            "description":"Debit Credit Indicator"
        },
        "txnVirtualAccountNo":{
            "type":"string",
            "description":"Transaction Virtual Account Number"
        },
        "offsetVirtualAccountNo":{
            "type":"string",
            "description":"Offset Virtual Account Number"
        },
        "txnVirtualAccountCcy":{
            "type":"string",
            "description":"Transaction Virtual Account Currency"
        },
        "offsetVirtualAccountCcy":{
            "type":"string",
            "description":"Offset Virtual Account Currency"
        },
        "txnAmount":{
            "type":"number",
            "description":"Transaction Amount"
        },
        "offsetAmount":{
            "type":"number",
            "description":"Offset Amount"
        },
        "txnTrnCode":{
            "type":"string",
            "description":"Transaction Code"
        },
        "offsetTrnCode":{
            "type":"string",
            "description":"Offset Transaction Code"
        },
        "originalRefNo":{
            "type":"string",
            "description":"Original Reference Number"
        },
        "checkerDtStamp":{
            "type":"string",
            "description":"DateStamp of Authorization"
        },
        "makerDtStamp":{
            "type":"string",
            "description":"DateStamp of Making of the Transaction"
        },
        "checkerId":{
            "type":"string",
            "description":"User id of Authorizer"
        },
        "makerId":{
            "type":"string",
            "description":"User id of Maker"
        }
    },
    "required":[
        "offsetVirtualAccountNo",
        "offsetVirtualAccountCcy",
        "txnVirtualAccountNo",
        "txnVirtualAccountCcy",
        "drCr",
        "realAccountNo",
        "txnBranch",
        "txnAmount",
        "txnTrnCode",
        "offsetTrnCode",
        "realCustomerNo",
        "valueDate"
    ]
}

Nested Schema : codes

Type: array

Show Source

• Array of: object VanTbInternalTransfersServiceResponseCode

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

Nested Schema : VanTbInternalTransfersServiceResponseCode

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

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