Payment Initiation — Proposed Guide

Payment Initiation: This hypothetical operation would request a separately authorized payment intent for an eligible reimbursement. An accepted intent…

Overview

This hypothetical operation would request a separately authorized payment intent for an eligible reimbursement. An accepted intent must not be presented as a settled transaction.

Key concepts

Bind the request to the authorized reimbursement version, instrument reference and idempotency key. Record a distinct attempt identifier.

Implementation considerations

The path is illustrative and unavailable. A future implementation requires independent financial controls, provider approval and explicit production activation.

Proposed API behavior

POST /v1/reimbursements/{reimbursement_id}/payment-intents is an illustrative design for this topic. Path and field names may change before implementation. Access would require an authorized organization context and operation-specific permission; no public API or authorization grant is available here.

Static example requests

# Proposed request text only; this reserved host is not a live API.
curl -X POST 'https://api.remizen.example/v1/reimbursements/reimb_example_123/payment-intents' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: operation_example_123' \
  --data '{
  "payment_method_id": "payment_method_example_123",
  "version": 1
}'

Fictional response example

{
  "data": {
    "reimbursement_id": "reimb_example_123",
    "payment_method_id": "payment_method_example_123",
    "version": 1,
    "id": "reimb_example_123",
    "organization_id": "org_example_123",
    "expense_ids": [
      "exp_example_123"
    ],
    "amount_minor": 12550,
    "currency": "USD",
    "status": "draft"
  },
  "meta": {
    "request_id": "req_example_123",
    "reference_only": true
  }
}

Illustrative error case

Review this failure case in context: The path is illustrative and unavailable. A future implementation requires independent financial controls, provider approval and explicit production activation.

{
  "error": {
    "code": "validation_error",
    "message": "The proposed payment initiation operation requires review of its input or authorization.",
    "request_id": "req_example_123"
  }
}

Proposed data types

Related documentation