Retrieve a Receipt

GEThttps://api.omise.co/receipts/:receipt_id

Retrieve details for a specific receipt by its identifier. Returns a complete receipt object with fee breakdown.

Request Parameters

Required - 1 fieldRequired Parameters

▼

`receipt_id`STRING(required)

Receipt identifier matching pattern /rcpt(_test)?_[0-9a-z]+/. This is provided in the URL path.

Example:"rcpt_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid receipt ID

---

Responses

200

Successful retrieval

Receipt retrieved successfully. Returns the complete receipt object with all details.

Response includes:

• object - The value "receipt"
• id - Receipt identifier (rcpt_*)
• livemode - Live or test mode
• location - API path to the receipt object
• adjustment_transaction - Associated adjustment transaction ID
• charge_fee - Accumulated charge fees in smallest currency unit
• company_address - Omise company address
• company_name - Omise company name
• company_tax_id - Omise company tax ID
• credit_note - Whether this is a credit note
• currency - Three-letter ISO 4217 currency code
• customer_address - Merchant address
• customer_email - Merchant email
• customer_name - Merchant name
• customer_statement_name - Merchant statement name
• customer_tax_id - Merchant tax ID
• issued_on - Date the receipt was issued
• number - Receipt number
• subtotal - Subtotal before tax in smallest currency unit
• total - Total amount (subtotal + vat - wht)
• transaction_fee - Transaction fee in smallest currency unit
• transfer_fee - Transfer fee in smallest currency unit
• vat - VAT amount in smallest currency unit
• voided_fee - Voided fee amount in smallest currency unit
• wht - Withholding tax amount in smallest currency unit
• created_at - Receipt creation timestamp (ISO 8601)

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

Receipt not found with the provided ID.

Common causes:

• Invalid receipt ID format
• Receipt does not exist
• Receipt belongs to different account
• Using test key with live receipt ID (or vice versa)

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/receipts/rcpt_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

receipt = Omise::Receipt.retrieve('rcpt_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

receipt = omise.Receipt.retrieve('rcpt_test_5xuy4w91xqz7d1w9u0t')

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const receipt = await omise.receipts.retrieve('rcpt_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$receipt = OmiseReceipt::retrieve('rcpt_test_5xuy4w91xqz7d1w9u0t');

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Receipt receipt = client.receipts().get("rcpt_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var receipt = await client.Receipts.Get("rcpt_test_5xuy4w91xqz7d1w9u0t");

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

receipt, _ := client.Receipts().Get("rcpt_test_5xuy4w91xqz7d1w9u0t")

---

Error and result codes

Common Error Codes

Code	Description	Resolution
authentication_failure	Invalid API key	Verify your secret key is correct
not_found	Receipt not found	Check receipt ID is correct and exists
invalid_receipt_id	Malformed receipt ID	Ensure ID matches format rcpt(test)?[0-9a-z]+

Receipt Object Fields

Field	Type	Description
object	string	Always returns "receipt"
id	string	Unique receipt identifier (rcpt_*)
livemode	boolean	Production vs test environment indicator
location	string	API path to the receipt object
adjustment_transaction	string	Associated adjustment transaction ID
charge_fee	integer	Omise charge fee in smallest currency unit
company_address	string	Omise company address
company_name	string	Omise company name
company_tax_id	string	Omise company tax ID
credit_note	boolean	Whether this is a credit note
currency	string	Three-letter ISO 4217 code
customer_address	string	Merchant address
customer_email	string	Merchant email
customer_name	string	Merchant name
customer_statement_name	string	Merchant statement name
customer_tax_id	string	Merchant tax ID
issued_on	string	Date the receipt was issued
number	string	Receipt number
subtotal	integer	Subtotal before tax
total	integer	Total calculated as subtotal + vat - wht
transaction_fee	integer	Transaction fee in smallest currency unit
transfer_fee	integer	Transfer fee in smallest currency unit
vat	integer	VAT amount
voided_fee	integer	Voided fee amount
wht	integer	Withholding tax amount
created_at	string	Creation timestamp (ISO 8601)

---

🔑API Credentials

▼

Try it out

Required - 1 fields

▼

receipt_id(Required)

Your IP: ...Loading...