Fetch a Receipt

Overview

Retrieve the details of a previously created Receipt, including all itemized products, amount breakdowns, delivery methods, and the hosted receipt URL.

Resource Access

User Permissions: Admin users only
Endpoint: GET /receipts/\{receipt_id}

Arguments

Parameter	Type	Required	Description
receipt_id	string	Yes (path)	The unique ID of the Receipt
entity_id	string	Yes (query)	The ID of the Transfer or Authorization the receipt was generated for

Example Request

curl -X GET \
  'https://api.ahrvo.network/payments/na/receipts/RCreceiptExample123?entity_id=TRtransferExample123' \
  -u username:password \
  -H 'Content-Type: application/json'

Example Response

{
  "id": "RCreceiptExample123",
  "created_at": "2023-12-10T14:30:00Z",
  "updated_at": "2023-12-10T14:30:00Z",
  "amount": 6100,
  "currency": "USD",
  "type": "BUYER",
  "send_receipt_to_buyer": true,
  "receipt_url": "https://receipts.ahrvo.network/RCreceiptExample123",
  "entity_details": {
    "id": "TRtransferExample123",
    "type": "TRANSFER"
  },
  "merchant_details": {
    "id": "MUmerchantExample456",
    "business_name": "Acme Electronics"
  },
  "payment_instrument_details": {
    "type": "PAYMENT_CARD",
    "brand": "VISA",
    "masked_number": "************1111",
    "expiration_month": 12,
    "expiration_year": 2025
  },
  "requested_delivery_methods": [
    {
      "type": "EMAIL",
      "destinations": ["customer@example.com"]
    },
    {
      "type": "SMS",
      "destinations": ["+15555551234"]
    }
  ],
  "items": [
    {
      "name": "Wireless Headphones",
      "description": "Premium noise-cancelling wireless headphones",
      "quantity": 1,
      "image_details": {
        "primary_image_url": "https://example.com/images/headphones.jpg",
        "alternative_image_urls": [
          "https://example.com/images/headphones-alt1.jpg",
          "https://example.com/images/headphones-alt2.jpg"
        ]
      },
      "price_details": {
        "sale_amount": 3500,
        "currency": "USD",
        "price_type": "SALE",
        "regular_amount": 4500
      }
    },
    {
      "name": "Headphone Case",
      "description": "Protective carrying case",
      "quantity": 1,
      "price_details": {
        "sale_amount": 1500,
        "currency": "USD"
      }
    }
  ],
  "amount_breakdown": {
    "subtotal_amount": 5000,
    "shipping_amount": 500,
    "estimated_tax_amount": 450,
    "discount_amount": 250,
    "tip_amount": 300,
    "additional_buyer_charges": {
      "convenience_amount": 100,
      "surcharge_amount": 0
    }
  },
  "additional_details": [
    {
      "name": "Invoice Number",
      "value": "INV-2023-12345"
    },
    {
      "name": "Order Number",
      "value": "ORD-789456"
    },
    {
      "name": "Return Policy",
      "value": "30-day money back guarantee"
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/receipts/RCreceiptExample123"
    },
    "transfer": {
      "href": "https://api.ahrvo.network/payments/na/transfers/TRtransferExample123"
    },
    "merchant": {
      "href": "https://api.ahrvo.network/payments/na/merchants/MUmerchantExample456"
    },
    "delivery_attempts": {
      "href": "https://api.ahrvo.network/payments/na/receipts/RCreceiptExample123/delivery_attempts"
    }
  }
}

Additional Information

Entity ID Requirement: The entity_id query parameter is required to fetch a receipt
- Must match the Transfer or Authorization ID used when creating the receipt
- Provides additional security and validation
- Prevents unauthorized access to receipts
Receipt URL: The receipt_url field provides a hosted web page
- Shareable link that displays the full receipt
- Works in any browser without authentication
- Useful for sharing with customers or customer service
- Typically valid for 90+ days
- Can be embedded in emails or shared via SMS
Receipt Type: Indicates who the receipt is for
- BUYER: Customer-facing receipt (most common)
- MERCHANT: Merchant's copy for record-keeping
- PLATFORM: Platform/marketplace copy for accounting
Entity Details: Links the receipt to the original transaction
- entity_details.id: The Transfer or Authorization ID
- entity_details.type: Either "TRANSFER" or "AUTHORIZATION"
- Use this to look up the original transaction details
Merchant Details: Business information displayed on receipt
- business_name: The merchant's business name
- id: The merchant's ID in the system
- May include additional fields like address, phone, website
Payment Instrument Details: Masked payment information
- For Cards:
  - type: "PAYMENT_CARD"
  - brand: VISA, MASTERCARD, AMEX, DISCOVER, etc.
  - masked_number: Last 4 digits only (e.g., ************1111)
  - expiration_month and expiration_year
- For Bank Accounts:
  - type: "BANK_ACCOUNT"
  - account_type: CHECKING or SAVINGS
  - masked_number: Last 4 digits of account number
- Never includes full card numbers or sensitive data (PCI compliant)
Items Array: Itemized product list
- Each item includes:
  - name: Product name
  - description: Optional product description
  - quantity: Number of items purchased
  - image_details: Product images (primary and alternative URLs)
  - price_details: Sale amount, currency, price type, regular amount
- Useful for:
  - Returns and exchanges
  - Customer service inquiries
  - Dispute resolution
  - Visual confirmation of purchase
Amount Breakdown: Detailed charge breakdown
- subtotal_amount: Items total before additions
- shipping_amount: Delivery fees
- estimated_tax_amount: Taxes (sales tax, VAT, etc.)
- discount_amount: Discounts and promo codes
- tip_amount: Gratuity
- additional_buyer_charges: Convenience fees, surcharges
- All amounts in cents (smallest currency unit)
- Sum of components should equal total amount
Additional Details: Custom key-value pairs
- Flexible structure for extra information
- Common uses:
  - Invoice numbers for accounting systems
  - Order numbers for fulfillment tracking
  - VIN for automotive sales
  - Return policy information
  - Warranty details
  - Customer reference numbers
Requested Delivery Methods: Shows delivery channels configured
- Each method includes:
  - type: EMAIL, SMS, or PRINT
  - destinations: Email addresses, phone numbers, or device IDs
- Note: This shows requested delivery, not delivery status
- Check delivery attempts for actual delivery status
Use Cases:
- Customer Service: Look up receipt details for support inquiries
- Dispute Resolution: Review transaction details for chargeback defense
- Returns/Exchanges: Verify purchase details and amounts
- Accounting: Export receipt data for bookkeeping
- Compliance: Audit trail for tax and regulatory purposes
- Resend Receipts: Get receipt URL to manually send to customer
Delivery Status: To check if receipts were successfully delivered:
- Use GET /receipts/{receipt_id}/delivery_attempts
- Shows all delivery attempts with status (PENDING, SUCCEEDED, FAILED)
- Can retry failed deliveries with POST delivery_attempts
Related Resources: Use _links to navigate to:
- The original Transfer or Authorization
- The Merchant who processed the transaction
- Delivery attempts for this receipt
Data Retention: Receipts are typically retained for:
- 7+ years for compliance and audit purposes
- Receipt URLs may expire after 90 days but can be regenerated
- Raw receipt data remains accessible via API
Privacy Considerations:
- Payment details are masked (PCI compliant)
- Customer email/phone shown only if you have permission
- Hosted receipt URL is unguessable but not password-protected
Multi-Currency Support:
- Currency field shows the transaction currency
- All amounts (breakdown, items) use the same currency
- Follows ISO 4217 currency codes (USD, EUR, GBP, etc.)

Overview​

Resource Access​

Arguments​

Example Request​

Example Response​

Additional Information​

Overview

Resource Access

Arguments

Example Request

Example Response

Additional Information