Account

Status of one agent top-up; credits it once Stripe reports it paid

Bearer API key, own key only. Returns the status of one agent-rail top-up by its Stripe PaymentIntent id. When Stripe reports the payment succeeded, this read credits it, through the same function the Stripe webhook uses: whichever arrives first credits the gross NOK amount Stripe records, and the other changes nothing, so polling can never credit twice. An unknown id, a malformed id, a non-agent payment and another key's payment all return the same 404 TOPUP_NOT_FOUND. While no agent payment rail is switched on, the route returns 404 PAYMENT_METHOD_NOT_ENABLED.

get/api/v1/payments/topups/{payment_intent_id}

Request

  • Base URL: https://www.apier.no
  • URL: https://www.apier.no/api/v1/payments/topups/{payment_intent_id}
  • Auth: HTTP bearer

Path parameters

payment_intent_idstring required

The Stripe PaymentIntent id of the payment (pi_…).

Response

The top-up's status. credited means the balance has been credited (exactly once); pending means Stripe has not settled it yet, so poll again; failed means the payment was cancelled and nothing was credited; under_review means Stripe took the payment but it could not be credited automatically and has been sent for manual reconciliation.

successtrue required

Example response

{
  "_meta": {
    "rulebook_version": "v1.0.0",
    "source": "apier.no",
    "data_source": "Brønnøysund Enhetsregisteret + Apier Universal Rulebook",
    "schema_version": "1.0.0",
    "legal_basis": "NLOD — public registry reuse",
    "response_timestamp": "2026-04-24T12:00:00.000Z",
    "response_hash": "sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
    "source_snapshot_id": "brreg-2026-04-24T02:00:00.000Z",
    "cost_nok": 0.5,
    "wallet_remaining_nok": 9.5,
    "spend_cap_remaining_nok": 12.5
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.