1. Home
  2. PAYCode
  3. BULK PAYCODE
  4. Bulk Paycode Batch Status

Bulk Paycode Batch Status

A bulk Token batch status message is a request to inquire about the status of the bulk token already generated. Please request the context URL from Interswitch.

7.1 Bulk Token Batch Status Request (Sent from Third-party)
The following describes the important element required to be sent for a Cancel Token request.

S/N Data Element (DE)   Description
1 referenceId Mandatory Original Transaction Ref used in token generation call. E.g. 324555
2 frontEndPartner Mandatory Front End Partner ID sent in token generation call

 

Sample Request

GET  {context}/pwm/bulk/tokens/comprehensive/status?referenceId=1234566&frontEndPartner=455

Content-Type: application/json

[Other HTTP headers]…

 

7.2 Bulk Token Batch Status Response (Sent from Interswitch)

The following describes the important data element required for a Bulk Token Batch Status response.

S/N Data Element (DE) Description
1 summary Parent element for batchReference, numberOfsuccessful,numberOfFailed,amountOfFailed,amountOfSuccessful
2 batchReference This is the unique referenceId used in the bulk token request message.
3 numberOfSuccessful This shows the number of tokens successfully generated
4 numberOfFailed This shows the number of tokens that failed during generation
5 amountOfFailed This sums up the amount in the failed tokens
6 amountOfSuccessful This sums up the amount in the successful tokens
7 successful This is the parent element to surcharge, amount, beneficiaryNumber, oneTimePin of the successful tokens
8 Failed This is the parent element to surcharge, amount, beneficiaryNumber, oneTimePin of the failed tokens

 

Successful Response

        HTTP Status Code:  200

 

{

“summary”: {

“batchReference”: “123456”,

“numberOfSuccessful”: “10”,

“numberOfFailed”: “0”,

“amountOfFailed”: “0”,

“amountOfSuccessful”: “4300000”

},

“successful”: [

{

“surcharge”: “”,

“amount”: “400000”,

“beneficiaryNumber”: “08021111111”,

“oneTimePin”: “4321”

},

{

“surcharge”: “”,

“amount”: “300000”,

“beneficiaryNumber”: “08021111112”,

“oneTimePin”: “1234”

},

{

“surcharge”: “”,

“amount”: “500000”,

“beneficiaryNumber”: “08021111113”,

“oneTimePin”: “1234”

},

{

“surcharge”: “”,

“amount”: “400000”,

“beneficiaryNumber”: “08021111114”,

“oneTimePin”: “1234”

},

{

“surcharge”: “”,

“amount”: “300000”,

“beneficiaryNumber”: “08021111115”,

“oneTimePin”: “1234”

},

{

“surcharge”: “”,

“amount”: “500000”,

“beneficiaryNumber”: “08021111116”,

“oneTimePin”: “1234”

},

{

“surcharge”: “”,

“amount”: “500000”,

“beneficiaryNumber”: “08021111117”,

“oneTimePin”: “1234”

},

{

“surcharge”: “”,

“amount”: “400000”,

“beneficiaryNumber”: “08021111118”,

“oneTimePin”: “1234”

},

{

“surcharge”: “”,

“amount”: “500000”,

“beneficiaryNumber”: “08021111119”,

“oneTimePin”: “1234”

},

{

“surcharge”: “”,

“amount”: “500000”,

“beneficiaryNumber”: “08021111110”,

“oneTimePin”: “1234”

}

]

}

 

Unsuccessful Response

HTTP Status Code: 401

 

{

“errors”: [

{

“code”: “10904”,

“message”: “No record of batch with provided reference Id – 123456778 for the front end partner – 455”

}

],

“error”: {

“code”: “10904”,

“message”: “No record of batch with provided reference Id – 123456778 for the front end partner – 455”

}

}

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Was this article helpful to you? Yes 1 No

How can we help?