Get Issuance Job

curl https://api.thanxsandbox.com/partner/issuance_jobs/job_xyz789?merchant_id={merchant_id} \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}'

{
  "issuance_job": {
    "id": "job_xyz789",
    "campaign_id": "camp_abc123",
    "variant_id": "var_treat1",
    "state": "completed",
    "total_count": 2,
    "processed_count": 2,
    "success_count": 1,
    "failure_count": 1,
    "progress_percent": 100,
    "created_at": "2025-06-15T10:30:00Z",
    "started_at": "2025-06-15T10:30:05Z",
    "completed_at": "2025-06-15T10:30:15Z",
    "summary": {
      "success_count": 1,
      "failure_count": 1,
      "failures": [
        {
          "identifier_index": 1,
          "identifier_type": "phone",
          "error": "User not found"
        }
      ]
    }
  }
}

GET

partner

issuance_jobs

:id

curl https://api.thanxsandbox.com/partner/issuance_jobs/job_xyz789?merchant_id={merchant_id} \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}'

{
  "issuance_job": {
    "id": "job_xyz789",
    "campaign_id": "camp_abc123",
    "variant_id": "var_treat1",
    "state": "completed",
    "total_count": 2,
    "processed_count": 2,
    "success_count": 1,
    "failure_count": 1,
    "progress_percent": 100,
    "created_at": "2025-06-15T10:30:00Z",
    "started_at": "2025-06-15T10:30:05Z",
    "completed_at": "2025-06-15T10:30:15Z",
    "summary": {
      "success_count": 1,
      "failure_count": 1,
      "failures": [
        {
          "identifier_index": 1,
          "identifier_type": "phone",
          "error": "User not found"
        }
      ]
    }
  }
}

Scope required: rewards.issue

This endpoint returns the current status of a reward issuance job. Use this to poll for completion after initiating an issuance via Issue Rewards. When the job reaches the completed state, a summary field is included with success and failure counts. If any issuances failed, the summary includes a failures array with details about each failure.

Parameters

string

required

Issuance job ID

string

required

Merchant ID

Response

string

Issuance job ID

string

Campaign ID

string

Variant ID

string

Job state: pending, processing, completed, or failed

integer

Total number of identifiers submitted

integer

Number of identifiers processed so far

integer

Number of rewards successfully issued

integer

Number of failed issuances

integer

Completion percentage (0-100)

datetime

Job creation timestamp (ISO8601)

datetime

Processing start timestamp (ISO8601), null if not started

datetime

Processing completion timestamp (ISO8601), null if not completed

hash

Completion summary (only present when state is completed)

Show summary

integer

Number of rewards successfully issued

integer

Number of failed issuances

array

Failure details

Show failure

integer

Position in the original identifiers array

string

Identifier type (email or phone)

string

Error message describing the failure

curl https://api.thanxsandbox.com/partner/issuance_jobs/job_xyz789?merchant_id={merchant_id} \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}'

{
  "issuance_job": {
    "id": "job_xyz789",
    "campaign_id": "camp_abc123",
    "variant_id": "var_treat1",
    "state": "completed",
    "total_count": 2,
    "processed_count": 2,
    "success_count": 1,
    "failure_count": 1,
    "progress_percent": 100,
    "created_at": "2025-06-15T10:30:00Z",
    "started_at": "2025-06-15T10:30:05Z",
    "completed_at": "2025-06-15T10:30:15Z",
    "summary": {
      "success_count": 1,
      "failure_count": 1,
      "failures": [
        {
          "identifier_index": 1,
          "identifier_type": "phone",
          "error": "User not found"
        }
      ]
    }
  }
}

⌘I

Merchant & Partner API

Reference

Get Issuance Job

Parameters

Response

​Parameters

​Response

Parameters

Response