Get document status

Returns the status of a card operation using either request_id or docid.

Endpoint

GET /request/status

Query parameters

  • request_id (string) — Unique identifier for the request

  • docid (number) — Tracking document ID

circle-info

One of request_id or docid is required

Response (Block Operation)

Response (application/json)
{
  "type": "BLOCK",
  "status": "EXECUTED",
  "docid": 123456,
  "request_id": "request-id-12345",
  "block": {
    "san": "1234567890",
    "releasedBalance": 150.75,
    "currency": "USD"
  }
}

Response parameters (Block Operation)

  • type (string, BLOCK) — Operation type

  • status (string) — Actual status of the operation

  • docid (number) — Tracking document ID

  • request_id (string) — Request identifier provided in the request

  • block (object) — Block operation details

  • block.san (string) — Unique card identifier in the CinCin system

  • block.releasedBalance (decimal) — Balance released back to user account after blocking

  • block.currency (string) — Currency code

Response (Top-Up Operation)

Response Parameters (Top-Up Operation)

  • type (string) — Operation type

  • status (string) — Actual status of the operation

  • docid (number) — Tracking document ID

  • request_id (string) — Request identifier provided in the request

  • topup (object) — Top-up operation details

  • topup.san (string) — Unique card identifier in the CinCin system

  • topup.amount (decimal) — Amount added to the card

  • topup.currency (string) — Currency code

Response (Issue Operation)

Response Parameters (Issue Operation)

  • type (string) — Operation type

  • status (string) — Actual status of the operation

  • docid (number) — Tracking document ID

  • request_id (string) — Request identifier provided in the request

  • issue (object) — Issue operation details

  • issue.san (string) — Unique card identifier in the CinCin system

  • issue.pan (string) — Masked primary account number

  • issue.expYear (number) — Card expiration year

  • issue.expMonth (number) — Card expiration month (1 – 12)

  • issue.cvv (string) — Card Verification Value

  • issue.currency (string) — Card currency code

  • issue.initialBalance (decimal) — Initial funded balance of the card

  • issue.cardName (string) — Personalized card name

Response (Withdrawal Operation)

Response Parameters (Withdrawal Operation)

  • type (string) — Operation type

  • status (string) — Actual status of the operation

  • docid (number) — Tracking document ID

  • request_id (string) — Request identifier provided in the request

  • withdrawal (object) — Withdrawal operation details

  • withdrawal.san (string) — Unique card identifier in the CinCin system

  • withdrawal.amount (decimal) — Amount withdrawn from the card

  • withdrawal.currency (string) — Currency code

Operation types enum list

  • ISSUE — Card issuance

  • TOPUP — Card top-up

  • WITHDRAWAL — Card withdrawal

  • BLOCK — Card blocking

Status enum list

  • INPROCESS — Operation is being processed

  • EXECUTED — Operation completed successfully

  • DECLINED — Operation was declined for some reason

Last updated