API

Read original noncash gift intent by idempotency key

Generated from the checked-in source. Do not edit this reference by hand.

GET /api/v1/organizations/{organization}/billing/accounts/{currency}/grants/prepared/{key}

Explicit platform administration only. Exact company/currency/key read of saved intent and committed grant. Missing intent returns 404. Issued result contains original allocation; prepared means no matching grant in this snapshot, not proof an in-flight publication failed. Retry saved exact input with original key. Read creates no funds. Cache-Control no-store.

Operation: getPreparedCustomerBalanceGrant.

Authentication

Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.

[
  {
    "bearerAuth": []
  }
]

HTTP request

Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.

curl --fail-with-body -X GET "$NIU_ORIGIN/api/v1/organizations/{organization}/billing/accounts/{currency}/grants/prepared/{key}" \
  -H "Authorization: Bearer $NIU_BEARER_TOKEN"

Parameters

organization

Location: path. Required.

{
  "type": "string",
  "format": "uuid"
}

currency

Location: path. Required.

{
  "type": "string",
  "pattern": "^[A-Z]{3}$"
}

key

Location: path. Required.

{
  "type": "string",
  "format": "uuid"
}

Request body

No request body is declared.

Responses

HTTP 200

Durable intent state

Content type: application/json.

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "id",
        "idempotency_key",
        "currency",
        "amount_nanos",
        "reason",
        "created_at",
        "application_policy",
        "status",
        "result"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "idempotency_key": {
          "type": "string",
          "format": "uuid"
        },
        "currency": {
          "type": "string"
        },
        "amount_nanos": {
          "type": "string"
        },
        "reason": {
          "type": "string"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "application_policy": {
          "type": "string",
          "enum": [
            "future_only",
            "unpaid_credit_first"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "prepared",
            "issued"
          ]
        },
        "result": {
          "type": [
            "object",
            "null"
          ],
          "required": [
            "id",
            "application_policy",
            "applied_to_credit_nanos",
            "retained_for_future_consumption_nanos"
          ],
          "properties": {
            "application_policy": {
              "type": "string",
              "enum": [
                "future_only",
                "unpaid_credit_first"
              ]
            },
            "applied_to_credit_nanos": {
              "type": "string",
              "pattern": "^[0-9]+$"
            },
            "retained_for_future_consumption_nanos": {
              "type": "string",
              "pattern": "^[0-9]+$",
              "description": "Original grant amount retained for future consumption at issuance, not current spendable balance."
            },
            "id": {
              "type": "string",
              "format": "uuid"
            }
          }
        }
      }
    }
  }
}

HTTP 400

Invalid amount, currency or page

HTTP 401

Authentication required

HTTP 403

Platform administration required

HTTP 404

No saved intent for this company/currency/key

HTTP 409

Intent conflict, unknown company or invalid cursor

Behavior and supported scope

Supported scope: implemented