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.

---

🔑API Credentials

▼

---

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:

• id - Receipt identifier
• charge_fee - Accumulated charge fees
• transfer_fee - Accumulated transfer fees
• total - Total fee amount
• currency - Currency code
• created_at - Creation timestamp

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)

---

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
livemode	boolean	Production vs test environment indicator
charge_fee	integer	Omise charge fee in smallest currency unit
transfer_fee	integer	Transfer fee in smallest currency unit
subtotal	integer	Subtotal before tax
vat	integer	VAT amount
wht	integer	Withholding tax amount
total	integer	Total calculated as subtotal + vat - wht
currency	string	Three-letter ISO 4217 code
created_at	string	Creation timestamp (ISO 8601)

---

Try it out

Required - 1 fields

▼

receipt_id(Required)