Get Job Status

Partner API

GET/v1/partner/payments/jobs/:jobId

Fetches the aggregate status of a bulk payment job submitted via Create Payments — counts by outcome, pagination, and per-item records.

Auth

Header: x-api-key

Use the bank-provisioned partner API key for authentication.

Usage Notes

Header: x-api-key
Read-only job tracking API — poll after the 202 response from Create Payments
status is the job-level outcome (queued, processing, completed_success, completed_partial, completed_rejected, failed_system, cancelled) — distinct from each record's item-level outcome (accepted, rejected, queued, processing, cancelled)

Request Fields

jobIdstringrequired

Job identifier returned in the 202 response from Create Payments, used as the path parameter.

pagestringoptional

Optional page number for the records array (starts at 1).

limitstringoptional

Optional page size for the records array (max 1000, default 100).

x-api-keystringrequired

Partner API key passed in the request header.

GET /v1/partner/payments/jobs/550e8400-e29b-41d4-a716-446655440000
x-api-key: fp_test_51H8xKlMnOpQrStUv

Sample Success Response

{
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed_partial",
  "counts": {
    "total": 2,
    "created": 2,
    "rejected": 0,
    "pending-approval": 1,
    "approved": 0,
    "paid": 1,
    "failed": 0
  },
  "pagination": {
    "page": 1,
    "limit": 100,
    "total": 2
  },
  "records": [
    {
      "transactionId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "outcome": "accepted",
      "rejectionCode": null,
      "rejectionMessage": null,
      "routingState": "paid"
    },
    {
      "transactionId": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "outcome": "accepted",
      "rejectionCode": null,
      "rejectionMessage": null,
      "routingState": "pending_approval"
    }
  ]
}

Sample Error Response

{
  "type": "object_not_found_error",
  "title": "The requested object was not found.",
  "detail": "Job not found.",
  "status": 404
}