Encrypt receipt

Encrypt receipt

curl --request POST \
  --url https://api.digitalreceiptprotocol.org/api/v1/receipts/encrypt \
  --header 'Content-Type: application/json' \
  --data '
{
  "receipt": {
    "version": "1.0",
    "receiptId": "550e8400-e29b-41d4-a716-446655440003",
    "merchant": {
      "merchantId": "550e8400-e29b-41d4-a716-446655440004",
      "name": "Store Name",
      "address": {
        "street": "123 Main St",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "country": "US"
      },
      "taxId": "12-3456789",
      "logoUrl": "https://example.com/logo.png",
      "contactPhone": "+1-555-1234",
      "contactEmail": "[email protected]"
    },
    "transaction": {
      "transactionId": "550e8400-e29b-41d4-a716-446655440005",
      "datetime": "2025-12-15T12:30:00Z",
      "paymentMethod": "card",
      "timezone": "America/New_York",
      "cardDetails": {
        "last4": "4242",
        "brand": "visa",
        "expiryMonth": 12,
        "expiryYear": 2026
      },
      "authorizationCode": "AUTH123456"
    },
    "items": [
      {
        "lineItemId": "550e8400-e29b-41d4-a716-446655440006",
        "name": "Widget Pro",
        "quantity": 2,
        "unitPrice": 1999,
        "totalPrice": 3998,
        "sku": "SKU-001",
        "description": "Premium widget with advanced features",
        "category": "Electronics",
        "discounts": [
          {
            "name": "Holiday Sale",
            "type": "percentage",
            "value": 10,
            "amount": 400
          }
        ],
        "taxes": [
          {
            "name": "Sales Tax",
            "rate": 0.08,
            "amount": 288
          }
        ]
      }
    ],
    "summary": {
      "subtotal": 3998,
      "totalTax": 320,
      "totalDiscount": 400,
      "total": 4018,
      "currency": "USD",
      "itemCount": 1,
      "tipAmount": 100
    },
    "createdAt": "2025-12-15T12:35:00Z",
    "notes": "Thank you for shopping!",
    "returnPolicy": "30-day return policy",
    "loyaltyInfo": {
      "programName": "Rewards Program",
      "pointsEarned": 40,
      "pointsBalance": 1240,
      "memberNumber": "MEMBER123456"
    },
    "metadata": {}
  },
  "recipientIdentifier": {
    "type": "email",
    "value": "[email protected]"
  }
}
'

{
  "success": true,
  "data": {
    "version": "1.0",
    "receiptId": "550e8400-e29b-41d4-a716-446655440003",
    "keyId": "550e8400-e29b-41d4-a716-446655440000",
    "keyBundle": {
      "encryptedAesKey": "encrypted_aes_key_base64...",
      "keyId": "550e8400-e29b-41d4-a716-446655440000",
      "algorithm": "RSA-OAEP-256"
    },
    "ciphertext": "encrypted_receipt_ciphertext_base64...",
    "iv": "initialization_vector_base64...",
    "authTag": "auth_tag_base64...",
    "merchantId": "550e8400-e29b-41d4-a716-446655440004",
    "transactionId": "550e8400-e29b-41d4-a716-446655440005",
    "createdAt": "2025-12-15T12:35:00Z",
    "expiresAt": "2025-12-16T12:35:00Z",
    "isEscrowed": false,
    "escrowKeyId": null
  }
}

POST

api

receipts

encrypt

Encrypt receipt

curl --request POST \
  --url https://api.digitalreceiptprotocol.org/api/v1/receipts/encrypt \
  --header 'Content-Type: application/json' \
  --data '
{
  "receipt": {
    "version": "1.0",
    "receiptId": "550e8400-e29b-41d4-a716-446655440003",
    "merchant": {
      "merchantId": "550e8400-e29b-41d4-a716-446655440004",
      "name": "Store Name",
      "address": {
        "street": "123 Main St",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "country": "US"
      },
      "taxId": "12-3456789",
      "logoUrl": "https://example.com/logo.png",
      "contactPhone": "+1-555-1234",
      "contactEmail": "[email protected]"
    },
    "transaction": {
      "transactionId": "550e8400-e29b-41d4-a716-446655440005",
      "datetime": "2025-12-15T12:30:00Z",
      "paymentMethod": "card",
      "timezone": "America/New_York",
      "cardDetails": {
        "last4": "4242",
        "brand": "visa",
        "expiryMonth": 12,
        "expiryYear": 2026
      },
      "authorizationCode": "AUTH123456"
    },
    "items": [
      {
        "lineItemId": "550e8400-e29b-41d4-a716-446655440006",
        "name": "Widget Pro",
        "quantity": 2,
        "unitPrice": 1999,
        "totalPrice": 3998,
        "sku": "SKU-001",
        "description": "Premium widget with advanced features",
        "category": "Electronics",
        "discounts": [
          {
            "name": "Holiday Sale",
            "type": "percentage",
            "value": 10,
            "amount": 400
          }
        ],
        "taxes": [
          {
            "name": "Sales Tax",
            "rate": 0.08,
            "amount": 288
          }
        ]
      }
    ],
    "summary": {
      "subtotal": 3998,
      "totalTax": 320,
      "totalDiscount": 400,
      "total": 4018,
      "currency": "USD",
      "itemCount": 1,
      "tipAmount": 100
    },
    "createdAt": "2025-12-15T12:35:00Z",
    "notes": "Thank you for shopping!",
    "returnPolicy": "30-day return policy",
    "loyaltyInfo": {
      "programName": "Rewards Program",
      "pointsEarned": 40,
      "pointsBalance": 1240,
      "memberNumber": "MEMBER123456"
    },
    "metadata": {}
  },
  "recipientIdentifier": {
    "type": "email",
    "value": "[email protected]"
  }
}
'

{
  "success": true,
  "data": {
    "version": "1.0",
    "receiptId": "550e8400-e29b-41d4-a716-446655440003",
    "keyId": "550e8400-e29b-41d4-a716-446655440000",
    "keyBundle": {
      "encryptedAesKey": "encrypted_aes_key_base64...",
      "keyId": "550e8400-e29b-41d4-a716-446655440000",
      "algorithm": "RSA-OAEP-256"
    },
    "ciphertext": "encrypted_receipt_ciphertext_base64...",
    "iv": "initialization_vector_base64...",
    "authTag": "auth_tag_base64...",
    "merchantId": "550e8400-e29b-41d4-a716-446655440004",
    "transactionId": "550e8400-e29b-41d4-a716-446655440005",
    "createdAt": "2025-12-15T12:35:00Z",
    "expiresAt": "2025-12-16T12:35:00Z",
    "isEscrowed": false,
    "escrowKeyId": null
  }
}

Body

application/json

receipt

object

required

Show child attributes

receipt.version

string

required

Receipt schema version

Example:

"1.0"

receipt.receiptId

string<uuid>

required

Example:

"550e8400-e29b-41d4-a716-446655440003"

receipt.merchant

object

required

Show child attributes

receipt.merchant.merchantId

string<uuid>

required

Example:

"550e8400-e29b-41d4-a716-446655440004"

receipt.merchant.name

string

required

Example:

"Store Name"

receipt.merchant.address

object

Show child attributes

receipt.merchant.address.street

string

Example:

"123 Main St"

receipt.merchant.address.city

string

Example:

"New York"

receipt.merchant.address.state

string

Example:

"NY"

receipt.merchant.address.postalCode

string

Example:

"10001"

receipt.merchant.address.country

string

Example:

"US"

receipt.merchant.taxId

string

Example:

"12-3456789"

receipt.merchant.logoUrl

string<uri>

Example:

"https://example.com/logo.png"

receipt.merchant.contactPhone

string

Example:

"+1-555-1234"

receipt.merchant.contactEmail

string<email>

Example:

"[email protected]"

receipt.transaction

object

required

Show child attributes

receipt.transaction.transactionId

string<uuid>

required

Example:

"550e8400-e29b-41d4-a716-446655440005"

receipt.transaction.datetime

string<date-time>

required

Example:

"2025-12-15T12:30:00Z"

receipt.transaction.paymentMethod

enum<string>

required

Available options:

card,

cash,

mobile_wallet,

bank_transfer,

other

Example:

"card"

receipt.transaction.timezone

string

Example:

"America/New_York"

receipt.transaction.cardDetails

object

Show child attributes

receipt.transaction.cardDetails.last4

string

Last 4 digits of the card

Example:

"4242"

receipt.transaction.cardDetails.brand

enum<string>

Available options:

visa,

mastercard,

amex,

discover,

other

Example:

"visa"

receipt.transaction.cardDetails.expiryMonth

integer

Required range: 1 <= x <= 12

Example:

12

receipt.transaction.cardDetails.expiryYear

integer

Example:

2026

receipt.transaction.authorizationCode

string

Example:

"AUTH123456"

receipt.items

object[]

required

Show child attributes

receipt.items.lineItemId

string<uuid>

required

Example:

"550e8400-e29b-41d4-a716-446655440006"

receipt.items.name

string

required

Example:

"Widget Pro"

receipt.items.quantity

number

required

Example:

2

receipt.items.unitPrice

integer

required

Price in smallest currency unit (cents)

Example:

1999

receipt.items.totalPrice

integer

required

Total price in smallest currency unit (cents)

Example:

3998

receipt.items.sku

string | null

Example:

"SKU-001"

receipt.items.description

string | null

Example:

"Premium widget with advanced features"

receipt.items.category

string | null

Example:

"Electronics"

receipt.items.discounts

object[]

Show child attributes

receipt.items.discounts.name

string

Example:

"Holiday Sale"

receipt.items.discounts.type

enum<string>

Available options:

percentage,

fixed

Example:

"percentage"

receipt.items.discounts.value

number

Percentage (0-100) or fixed amount in cents

Example:

10

receipt.items.discounts.amount

integer

Discount amount in cents

Example:

400

receipt.items.taxes

object[]

Show child attributes

receipt.items.taxes.name

string

Example:

"Sales Tax"

receipt.items.taxes.rate

number

Tax rate as decimal (0.08 = 8%)

Example:

0.08

receipt.items.taxes.amount

integer

Tax amount in cents

Example:

288

receipt.summary

object

required

Show child attributes

receipt.summary.subtotal

integer

required

Subtotal in cents

Example:

3998

receipt.summary.totalTax

integer

required

Total tax in cents

Example:

320

receipt.summary.totalDiscount

integer

required

Total discount in cents

Example:

400

receipt.summary.total

integer

required

Grand total in cents

Example:

4018

receipt.summary.currency

string

required

ISO 4217 currency code

Example:

"USD"

receipt.summary.itemCount

integer

required

Example:

1

receipt.summary.tipAmount

integer | null

Tip amount in cents

Example:

100

receipt.createdAt

string<date-time>

required

Example:

"2025-12-15T12:35:00Z"

receipt.notes

string | null

Example:

"Thank you for shopping!"

receipt.returnPolicy

string | null

Example:

"30-day return policy"

receipt.loyaltyInfo

object

Show child attributes

receipt.loyaltyInfo.programName

string

Example:

"Rewards Program"

receipt.loyaltyInfo.pointsEarned

integer

Example:

40

receipt.loyaltyInfo.pointsBalance

integer

Example:

1240

receipt.loyaltyInfo.memberNumber

string

Example:

"MEMBER123456"

receipt.metadata

object

recipientIdentifier

object

required

Show child attributes

recipientIdentifier.type

enum<string>

required

Available options:

email,

phone,

national_id,

bank_account

Example:

"email"

recipientIdentifier.value

string

required

Example:

"[email protected]"

Response

Receipt encrypted successfully

success

boolean

Example:

true

data

object

Show child attributes

data.version

string

Example:

"1.0"

data.receiptId

string<uuid>

Example:

"550e8400-e29b-41d4-a716-446655440003"

data.keyId

string<uuid>

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.keyBundle

object

Show child attributes

data.keyBundle.encryptedAesKey

string

Base64-encoded RSA-encrypted AES key

Example:

"encrypted_aes_key_base64..."

data.keyBundle.keyId

string<uuid>

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.keyBundle.algorithm

enum<string>

Available options:

RSA-OAEP-256

Example:

"RSA-OAEP-256"

data.ciphertext

string

Base64-encoded AES-GCM encrypted receipt

Example:

"encrypted_receipt_ciphertext_base64..."

data.iv

string

Base64-encoded initialization vector

Example:

"initialization_vector_base64..."

data.authTag

string

Base64-encoded GCM authentication tag

Example:

"auth_tag_base64..."

data.merchantId

string<uuid>

Example:

"550e8400-e29b-41d4-a716-446655440004"

data.transactionId

string<uuid>

Example:

"550e8400-e29b-41d4-a716-446655440005"

data.createdAt

string<date-time>

Example:

"2025-12-15T12:35:00Z"

data.expiresAt

string<date-time> | null

Example:

"2025-12-16T12:35:00Z"

data.isEscrowed

boolean

True if encrypted with escrow key (user not onboarded)

Example:

false

data.escrowKeyId

string<uuid> | null

Escrow key ID if isEscrowed is true

Example:

null

Get escrow public key Decrypt receipt

⌘I

Getting Started

Health

Onboarding

Keys

Receipts

Transactions

Body

Response