Receipt.from

Creates a Receipt from the given parameters.

Usage

import { Receipt } from 'mppx'
 
const receipt = Receipt.from({
  method: 'tempo',
  reference: '0x...',
  status: 'success',
  timestamp: new Date().toISOString(),
})

Return type

type ReturnType = Receipt

A validated Receipt object.

Parameters

externalId (optional)

• Type: string

External reference ID echoed from the Credential payload.

fundingCurrency (optional)

• Type: string

Currency actually debited to fund the payment, when known.

method

• Type: string

Payment method used (for example, "tempo", "stripe").

parameters

reference

• Type: string

Method-specific reference (for example, transaction hash).

status

• Type: 'success'

Payment status.

subscriptionId (optional)

• Type: string

Server-issued subscription identifier for recurring payments.

timestamp

• Type: string

RFC 3339 settlement timestamp.