Jump to

• Request
• Response

Update the Payment status after allocation

post

/service/v1/allocationStatus

This endpoint updates the Payment status after allocation.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  App Id
• branchCode: string
  branchCode
• userId: string
  user id for SMS

Body ()

Request Body to update allocation amount & status

Root Schema : AllocationRequestDto

Type: object

Allocation request Dto

Show Source

• allocationAmt(optional): number
  Allocation Amount
• allocationStatus(optional): string
  Allocation Status
• paymentRefNo(optional): string
  Payment reference number
• reconAction(optional): string
  Recon Action
• reconTxnRefNo(optional): string
  Recon Txn Reference No

{
    "description":"Allocation request Dto",
    "type":"object",
    "properties":{
        "paymentRefNo":{
            "type":"string",
            "description":"Payment reference number"
        },
        "allocationStatus":{
            "type":"string",
            "description":"Allocation Status"
        },
        "allocationAmt":{
            "type":"number",
            "description":"Allocation Amount"
        },
        "reconAction":{
            "type":"string",
            "description":"Recon Action"
        },
        "reconTxnRefNo":{
            "type":"string",
            "description":"Recon Txn Reference No"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns Ok response

400 Response

Bad Request

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