View Remittance Instruction

To view or to check the status of the instruction you can call the endpoint ‘Get remittance instruction’.

Below are the steps to view remittance instruction:

• Call endpoint Get Remittance Instruction to view the instruction; here {instructionId} is the instruction Id you received from the ‘create instruction’ response.

Remittance instructions can have the following statuses: PENDING, INVALID, PROCESSING, COMPLETE & FAILED

o   PENDING – the remittance instruction is yet to be picked up for processing o PROCESSING – the remittance instruction has been acknowledged and is being processed

o   COMPLETE – the remittance instruction has been accepted and processed  o INVALID – the remittance instruction is invalid (please check and correct request data used while creating instruction)

o   FAILED – the remittance instruction has failed; retry using create remittance endpoint as mentioned in Create Remittance Instruction and if the issue persists, please contact the support team

Please note: if the remittance instruction fails no transactions in that instruction will be processed.           

Use Case Scenarios

• Below is a sample response for an instruction with a status of PENDING

{
    "instructionId": "4de4fb6a-2e50-40de-907d-5079e3c594b5",
    "remittableTransactionIds": [
        "10037607.1",
        "10037608.2"
    ],
    "remittanceDate": "2023-08-04T00:00:00Z",
    "status": "PENDING",
    "createdAt": "2023-08-04T13:07:46.457Z",
    "createdBy": "Pay360:10172109@test.com",
    "lastUpdatedAt": "2023-08-04T13:07:47.22Z"
}

• Below is a sample response for an instruction with a status of PROCESSING

{
    "instructionId": "4de4fb6a-2e50-40de-907d-5079e3c594b5",
    "remittableTransactionIds": [
        "10037607.1",
        "10037608.2"
    ],
    "remittanceDate": "2023-08-04T00:00:00Z",
    "status": "PROCESSING",
    "createdAt": "2023-08-04T13:07:46.457Z",
    "createdBy": "Pay360:10172109@test.com",
    "lastUpdatedAt": "2023-08-04T13:07:47.22Z"
}

• Below is a sample response for an instruction with a status of COMPLETE

{
    "instructionId": "4de4fb6a-2e50-40de-907d-5079e3c594b5",
    "remittableTransactionIds": [
        "10037607.1",
        "10037608.2"
    ],
    "remittanceDate": "2023-08-04T00:00:00Z",
    "status": "COMPLETE",
    "createdAt": "2023-08-04T13:07:46.457Z",
    "createdBy": "Pay360:10172109@test.com",
    "lastUpdatedAt": "2023-08-04T13:07:47.22Z"
}

• Below is a sample response for an instruction with a status of INVALID

{
    "instructionId": "5df4fb6a-2e50-40de-907d-5079e3c594b5",
    "remittableTransactionIds": [
        "10037607",
        "10037608"
    ],
    "remittanceDate": "2023-08-04T00:00:00Z",
    "status": "INVALID",
    "createdAt": "2023-08-04T13:07:46.457Z",
    "createdBy": "Pay360:10172109@test.com",
    "validateReason": "Either of the transactions are not present in Evolve",
or "Remittance Date for either of the transaction already exist"
or “Remittance date provided for the transaction(s) should be greater than or equal to the earliest settlement date”       
"lastUpdatedAt": "2023-08-04T13:07:47.22Z"
}

• Below is a sample response for an instruction with a status of FAILED

{
    "instructionId": "0945e28b-04f1-4807-977a-811b7427a48b",
    "remittableTransactionIds": [
        "10037601.1",
        "10037602.1"
    ],
    "remittanceDate": "2023-08-04T00:00:00Z",
    "status": "FAILED",
    "createdAt": "2023-08-04T13:07:46.457Z",
    "createdBy": "Pay360:10172109@test.com",
    "lastUpdatedAt": "2023-08-04T13:07:47.22Z"
}