Skip to main content
POST
/
api
/
v1
/
receipts
/
encrypt
Encrypt receipt
curl --request POST \
  --url https://api.digitalreceiptprotocol.org/api/v1/receipts/encrypt \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "1.0",
  "receiptId": "rcpt_abc123def456",
  "merchantId": "merch_kitchenmart_001",
  "merchantName": "KitchenMart",
  "merchantStreet": "456 Commerce Ave",
  "merchantCity": "San Francisco",
  "merchantState": "CA",
  "merchantPostalCode": "94103",
  "merchantCountry": "US",
  "merchantTaxId": "98-7654321",
  "merchantContactEmail": "[email protected]",
  "transactionId": "txn_550e8400e29b41d4a716",
  "transactionDate": "2025-12-18T10:30:00Z",
  "transactionTimezone": "America/Los_Angeles",
  "paymentMethod": "card",
  "cardLast4": "4242",
  "cardBrand": "visa",
  "currency": "USD",
  "subtotal": 10997,
  "taxAmount": 962,
  "totalAmount": 11959,
  "items": [
    {
      "lineItemId": "item_001",
      "name": "Stainless Steel Mixing Bowl Set",
      "quantity": 1,
      "unitPrice": 2999,
      "totalPrice": 2999,
      "category": "Kitchen Essentials",
      "taxes": [
        {
          "name": "Sales Tax",
          "rate": 0.0875,
          "amount": 262
        }
      ]
    },
    {
      "lineItemId": "item_002",
      "name": "Non-Stick Frying Pan",
      "quantity": 2,
      "unitPrice": 3999,
      "totalPrice": 7998,
      "category": "Cookware",
      "taxes": [
        {
          "name": "Sales Tax",
          "rate": 0.0875,
          "amount": 700
        }
      ]
    }
  ],
  "mockItems": false,
  "recipientHashedPan": "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
}
'
{
  "success": true,
  "data": {
    "version": "1.0",
    "receiptId": "rcpt_abc123def456",
    "keyId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "keyBundle": {
      "encryptedAesKey": "base64_encrypted_aes_key_here...",
      "keyId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "algorithm": "RSA-OAEP-256"
    },
    "ciphertext": "base64_encrypted_receipt_data_here...",
    "iv": "base64_initialization_vector...",
    "authTag": "base64_authentication_tag...",
    "merchantId": "merch_kitchenmart_001",
    "transactionId": "txn_550e8400e29b41d4a716",
    "createdAt": "2025-12-18T10:30:00Z",
    "isEscrowed": false
  }
}

Body

application/json

Flattened receipt structure with recipient identifier

version
string
default:1.0
required
receiptId
string
default:550e8400-e29b-41d4-a716-446655440003
required
merchantId
string
default:550e8400-e29b-41d4-a716-446655440004
required
merchantName
string
default:KitchenMart
required
transactionId
string
default:550e8400-e29b-41d4-a716-446655440005
required
transactionDate
string<date-time>
default:2025-12-18T10:30:00Z
required
currency
string
default:USD
required
recipientHashedPan
string
required

Hashed PAN of the recipient

Example:

"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"

merchantStreet
string
default:456 Commerce Ave
merchantCity
string
default:San Francisco
merchantState
string
default:CA
merchantPostalCode
string
default:94103
merchantCountry
string
default:US
merchantTaxId
string
default:98-7654321
merchantContactEmail
string
transactionTimezone
string
default:America/Los_Angeles
paymentMethod
string
default:card
cardLast4
string
default:4242
cardBrand
string
default:visa
subtotal
integer
default:2000
taxAmount
integer
default:0
totalAmount
integer
default:2000
items
object[]
mockItems
boolean
default:true

If true and items are empty, generates mock line items

Response

Receipt encrypted successfully

success
boolean
Example:

true

data
object