payment.intent.set_provider_ref

Persist the provider’s opaque ref + next_action on the live attempt of a pending intent (after the isolated invoke).

• Scope: public
• System: no
• Reachable from: an ANONYMOUS face — no credential, and never /v1/commands/*. Which path serves it is not derivable from the registry; see the anonymous faces.
• Events: none — It writes the PSP’s own id back onto an intent already announced by payment.initiated — a correlation reference, not a change of state. The outcome events (approved/rejected) carry what a consumer acts on.

Input (JSON Schema)

{
  "properties": {
    "charge_plan": {
      "properties": {
        "installment_amount": {
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991,
          "type": "integer"
        },
        "installments": {
          "maximum": 9007199254740991,
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "installments",
        "installment_amount"
      ],
      "type": "object"
    },
    "next_action": {
      "properties": {
        "data": {
          "additionalProperties": {},
          "propertyNames": {
            "type": "string"
          },
          "type": "object"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "data"
      ],
      "type": "object"
    },
    "payment_id": {
      "minLength": 1,
      "type": "string"
    },
    "provider_ref": {
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "payment_id",
    "provider_ref",
    "next_action"
  ],
  "type": "object"
}

Result (200)

{
  "additionalProperties": false,
  "properties": {
    "payment_id": {
      "type": "string"
    }
  },
  "required": [
    "payment_id"
  ],
  "type": "object"
}

Errors

validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)