Back to neotek ↗Get Sandbox Access

BulkPaymentStatus

GEThttps://test.api.neotek.sa/b2b-unified/va/v1/bulk-payments/status/{fileReference}

Sandbox URL · in Production call https://api.neotek.sa

Where a submitted VA batch got to, with one entry per payment.

Path parameters:

ParameterRequiredDescription
fileReferenceRequiredthe composite reference from the submit response, including the appended scheme

Query parameters:

ParameterRequiredDescription
bankCodeRequiredalways RJHISARI

Headers:

ParameterRequiredDescription
authorizationRequiredBearer <ACCESS_TOKEN>
x-app-idRequiredyour application id
cURL
curl -G 'https://test.api.neotek.sa/b2b-unified/va/v1/bulk-payments/status/{fileReference}' \  --header 'authorization: Bearer <ACCESS_TOKEN>' \  --header 'x-app-id: <APP_ID>' \  -d 'bankCode=RJHISARI'

Response

JSON
{  "success": true,  "code": "SUCCESS",  "message": "Bulk payment status retrieved successfully",  "fileReference": "VAPAY20260513001~SCHEME001",  "fileStatus": "COMPLETED",  "payments": [    {      "transactionReference": "TXN001",      "paymentStatus": "PAYMENT_STATUS_COMPLETED",      "statusDescription": "Payment processed successfully",      "otherBankRef": "OB20260513000001"    }  ]}

Poll until fileStatus is terminal. While the batch is processing fileStatus may be PENDING, and individual payments may show PAYMENT_STATUS_IN_PROGRESS — which is not terminal — or PAYMENT_STATUS_FAILED.

Errors — every B2B failure carries a category that determines the HTTP status; see Statements → Errors.