Jump to

• Request
• Response

Create the new manual allocation transaction

post

/service/v1/initiateManualAlloc

This endpoint creates new manual allocation transaction for the provided Payments and Virtual account numbers.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  Application id
• branchCode: string
  Branch Code
• userId: string
  User id

Body ()

Request Body to create manual allocation transaction

Root Schema : ManualAllocServiceCollection

Type: object

Collection manual allocation transactions

Show Source

• action(optional): string
• autoAuth(optional): string
• corporateId(optional): string
• reconCategory(optional): string
• reconTxnCollection(optional): array reconTxnCollection
• reconTxnRefNo(optional): string

{
    "description":"Collection manual allocation transactions",
    "type":"object",
    "properties":{
        "reconCategory":{
            "type":"string"
        },
        "autoAuth":{
            "type":"string"
        },
        "corporateId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "reconTxnRefNo":{
            "type":"string"
        },
        "reconTxnCollection":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ManualAllocServiceDto"
            }
        }
    }
}

Nested Schema : reconTxnCollection

Type: array

Show Source

• Array of: object ManualAllocServiceDto
  each manual allocation detail

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

Nested Schema : ManualAllocServiceDto

Type: object

each manual allocation detail

Show Source

• counterpartyId(optional): string
• extSysRefNo(optional): string
• manualAllocList(optional): array manualAllocList

{
    "description":"each manual allocation detail",
    "type":"object",
    "properties":{
        "extSysRefNo":{
            "type":"string"
        },
        "counterpartyId":{
            "type":"string"
        },
        "manualAllocList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ManualAllocationDto"
            }
        }
    }
}

Nested Schema : manualAllocList

Type: array

Show Source

• Array of: object ManualAllocationDto
  each manual allocation deatail

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

Nested Schema : ManualAllocationDto

Type: object

each manual allocation deatail

Show Source

• allocationList(optional): array allocationList
• drCrIndicator(optional): string
• extPaymentRefNo(optional): string
• paymentAmount(optional): string
• paymentCcy(optional): string
• paymentRefNo(optional): string

{
    "description":"each manual allocation deatail",
    "type":"object",
    "properties":{
        "paymentRefNo":{
            "type":"string"
        },
        "extPaymentRefNo":{
            "type":"string"
        },
        "drCrIndicator":{
            "type":"string"
        },
        "paymentCcy":{
            "type":"string"
        },
        "paymentAmount":{
            "type":"string"
        },
        "allocationList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AllocationDto"
            }
        }
    }
}

Nested Schema : allocationList

Type: array

Show Source

• Array of: object AllocationDto
  each allocation deatail

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

Nested Schema : AllocationDto

Type: object

each allocation deatail

Show Source

• allocationAccount(optional): string
• allocationAmount(optional): number

{
    "description":"each allocation deatail",
    "type":"object",
    "properties":{
        "allocationAccount":{
            "type":"string"
        },
        "allocationAmount":{
            "type":"number"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Successfully saved data

Body ()

Root Schema : ResponseServiceDto

Type: object

each recon txn deatail

Show Source

• errorCodes(optional): array errorCodes
• reconTxnList(optional): array reconTxnList
• reconTxnRefNo(optional): string
• txnStatus(optional): string

{
    "description":"each recon txn deatail",
    "type":"object",
    "properties":{
        "reconTxnRefNo":{
            "type":"string"
        },
        "txnStatus":{
            "type":"string"
        },
        "reconTxnList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseServiceCode"
            }
        },
        "errorCodes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorResponseServiceCode"
            }
        }
    }
}

Nested Schema : errorCodes

Type: array

Show Source

• Array of: object ErrorResponseServiceCode

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

Nested Schema : reconTxnList

Type: array

Show Source

• Array of: object ResponseServiceCode

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

Nested Schema : ErrorResponseServiceCode

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

Nested Schema : ResponseServiceCode

Type: object

Show Source

• allocationTxnList(optional): array allocationTxnList
• errorCodes(optional): array errorCodes
• extSysRefNumber(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "extSysRefNumber":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "allocationTxnList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AllocationResponse"
            }
        },
        "errorCodes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorResponseServiceCode"
            }
        }
    }
}

Nested Schema : allocationTxnList

Type: array

Show Source

• Array of: object AllocationResponse

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

Nested Schema : errorCodes

Type: array

Show Source

• Array of: object ErrorResponseServiceCode

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

Nested Schema : AllocationResponse

Type: object

Show Source

• allocAccount(optional): string
• allocStatus(optional): string
• errorCodes(optional): array errorCodes
• intAllocRefNumber(optional): string

{
    "type":"object",
    "properties":{
        "intAllocRefNumber":{
            "type":"string"
        },
        "allocAccount":{
            "type":"string"
        },
        "allocStatus":{
            "type":"string"
        },
        "errorCodes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorResponseServiceCode"
            }
        }
    }
}

Nested Schema : errorCodes

Type: array

Show Source

• Array of: object ErrorResponseServiceCode

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

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