@spec attach_credential(map(), MPP.Credential.t()) :: map()

Attach a payment credential to JSON-RPC request params via _meta.

Parameters

• params - JSON-RPC request params map (value)
• credential - An MPP.Credential.t() struct (value)

Returns

Params map with _meta containing the credential (map)

Composes With

• extract_credential
• extract_challenges

# descripex:contract
%{
  params: %{
    params: %{description: "JSON-RPC request params map", kind: :value},
    credential: %{description: "An `MPP.Credential.t()` struct", kind: :value}
  },
  returns: %{
    type: :map,
    description: "Params map with `_meta` containing the credential"
  },
  composes_with: [:extract_credential, :extract_challenges]
}

@spec attach_receipt(map(), MPP.Receipt.t(), String.t()) :: map()

Attach a payment receipt to a JSON-RPC result map via _meta.

Parameters

• result - JSON-RPC result map (value)
• receipt - An MPP.Receipt.t() struct (value)
• challenge_id - The challenge ID this receipt fulfills (value)

Returns

Result map with _meta containing the receipt and challengeId (map)

Composes With

• extract_credential
• payment_required_error

# descripex:contract
%{
  params: %{
    result: %{description: "JSON-RPC result map", kind: :value},
    challenge_id: %{
      description: "The challenge ID this receipt fulfills",
      kind: :value
    },
    receipt: %{description: "An `MPP.Receipt.t()` struct", kind: :value}
  },
  returns: %{
    type: :map,
    description: "Result map with `_meta` containing the receipt and `challengeId`"
  },
  composes_with: [:extract_credential, :payment_required_error]
}

@spec credential_meta_key() :: String.t()

Metadata key for credentials in params._meta.

Returns

Key "org.paymentauth/credential" (string)

# descripex:contract
%{
  returns: %{type: :string, description: "Key `\"org.paymentauth/credential\"`"}
}

@spec extract_challenges(map()) ::
  {:ok, [MPP.Challenge.t()]} | {:error, :no_challenges | :invalid_challenge}

@spec extract_challenges(map()) :: {:error, :no_challenges}

@spec extract_challenges(map()) :: {:error, :invalid_challenge}

@spec extract_challenges(map()) ::
  {:ok, [MPP.Challenge.t()]} | {:error, :no_challenges | :invalid_challenge}

@spec extract_challenges(map()) ::
  {:ok, [MPP.Challenge.t()]} | {:error, :no_challenges | :invalid_challenge}

@spec extract_challenges(map()) :: {:error, :no_challenges}

Extract and parse payment challenges from a JSON-RPC error map.

Parameters

• error - JSON-RPC error map with data.challenges (value)

Returns

{:ok, [challenge]} or {:error, :no_challenges | :invalid_challenge} (tagged_tuple)

Errors

• :no_challenges
• :invalid_challenge

Composes With

• payment_required?
• payment_required_error

# descripex:contract
%{
  params: %{
    error: %{
      description: "JSON-RPC error map with `data.challenges`",
      kind: :value
    }
  },
  errors: [:no_challenges, :invalid_challenge],
  returns: %{
    type: :tagged_tuple,
    description: "`{:ok, [challenge]}` or `{:error, :no_challenges | :invalid_challenge}`"
  },
  composes_with: [:payment_required?, :payment_required_error]
}

@spec extract_credential(map()) ::
  {:ok, MPP.Credential.t()}
  | {:error, :no_credential | :invalid_credential | :invalid_challenge}

@spec extract_credential(map()) :: {:error, :invalid_credential}

@spec extract_credential(map()) :: {:error, :no_credential}

Extract a payment credential from JSON-RPC request params _meta.

Parameters

• params - JSON-RPC request params map with optional _meta containing a credential (value)

Returns

{:ok, credential} or {:error, :no_credential | :invalid_credential | :invalid_challenge} (tagged_tuple)

Errors

• :no_credential
• :invalid_credential
• :invalid_challenge

Composes With

• attach_credential
• attach_receipt

# descripex:contract
%{
  params: %{
    params: %{
      description: "JSON-RPC request params map with optional `_meta` containing a credential",
      kind: :value
    }
  },
  errors: [:no_credential, :invalid_credential, :invalid_challenge],
  returns: %{
    type: :tagged_tuple,
    description: "`{:ok, credential}` or `{:error, :no_credential | :invalid_credential | :invalid_challenge}`"
  },
  composes_with: [:attach_credential, :attach_receipt]
}

@spec payment_required?(map()) :: boolean()

@spec payment_required?(map()) :: boolean()

@spec payment_required?(map()) :: boolean()

@spec payment_required?(map()) :: false

Check whether a JSON-RPC error map indicates payment is required.

Parameters

• error - JSON-RPC error map with code field (value)

Returns

true if error code is -32042 (boolean)

# descripex:contract
%{
  params: %{
    error: %{description: "JSON-RPC error map with `code` field", kind: :value}
  },
  returns: %{type: :boolean, description: "`true` if error code is `-32042`"}
}

@spec payment_required_code() :: integer()

JSON-RPC error code for payment required (-32042).

Returns

Error code -32042 (integer)

# descripex:contract
%{returns: %{type: :integer, description: "Error code `-32042`"}}

@spec payment_required_error(MPP.Challenge.t() | [MPP.Challenge.t()]) :: map()

@spec payment_required_error([MPP.Challenge.t()]) :: map()

Build a JSON-RPC error map for payment required (-32042) with one or more challenges.

Parameters

• challenges - A single MPP.Challenge struct or a list of challenges (value)

Returns

JSON-RPC error map with code, message, and data containing httpStatus, challenges, and problem (map)

Composes With

• extract_challenges
• verification_failed_error

# descripex:contract
%{
  params: %{
    challenges: %{
      description: "A single `MPP.Challenge` struct or a list of challenges",
      kind: :value
    }
  },
  returns: %{
    type: :map,
    description: "JSON-RPC error map with `code`, `message`, and `data` containing `httpStatus`, `challenges`, and `problem`"
  },
  composes_with: [:extract_challenges, :verification_failed_error]
}

@spec payment_required_meta_key() :: String.t()

Metadata key for payment-required results in result._meta.

Returns

Key "org.paymentauth/payment-required" (string)

# descripex:contract
%{
  returns: %{
    type: :string,
    description: "Key `\"org.paymentauth/payment-required\"`"
  }
}

@spec receipt_meta_key() :: String.t()

Metadata key for receipts in result._meta.

Returns

Key "org.paymentauth/receipt" (string)

# descripex:contract
%{returns: %{type: :string, description: "Key `\"org.paymentauth/receipt\"`"}}

@spec verification_failed_code() :: integer()

JSON-RPC error code for verification failed (-32043).

Returns

Error code -32043 (integer)

# descripex:contract
%{returns: %{type: :integer, description: "Error code `-32043`"}}

@spec verification_failed_error(
  MPP.Challenge.t() | [MPP.Challenge.t()],
  MPP.Errors.t()
) :: map()

@spec verification_failed_error([MPP.Challenge.t()], MPP.Errors.t()) :: map()

Build a JSON-RPC error map for verification failed (-32043) with problem details.

Parameters

• challenges - A single MPP.Challenge struct or a list of challenges (value)
• problem - An MPP.Errors.t() struct with RFC 9457 problem details (value)

Returns

JSON-RPC error map with code, message, and data including problem details (map)

Composes With

• payment_required_error
• extract_challenges

# descripex:contract
%{
  params: %{
    problem: %{
      description: "An `MPP.Errors.t()` struct with RFC 9457 problem details",
      kind: :value
    },
    challenges: %{
      description: "A single `MPP.Challenge` struct or a list of challenges",
      kind: :value
    }
  },
  returns: %{
    type: :map,
    description: "JSON-RPC error map with `code`, `message`, and `data` including problem details"
  },
  composes_with: [:payment_required_error, :extract_challenges]
}