Retrieve a Source

GEThttps://api.omise.co/sources/:id

Retrieve information about an existing source including its type, amount, QR code data, and charge status.

---

🔑API Credentials

▼

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

The source ID to retrieve. Must start with src_ followed by test_ or live_ and a unique identifier.

Example:"src_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid source ID, Pattern: src_(test|live)_[0-9a-z]+

---

Responses

200

Successful retrieval

Source retrieved successfully. Returns the source object with all details.

Response includes:

• id - Source identifier
• type - Payment method type
• flow - Payment flow (offline, redirect, app_redirect)
• amount - Source amount
• currency - Currency code
• charge_status - Status of charge created with source (unknown, pending, successful, failed, expired)
• scannable_code - QR code data if applicable
• references - Payment references if applicable

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid public key
• Incorrect HTTP Basic Auth format

404

Not found

Source not found. The specified source ID does not exist.

Common causes:

• Invalid source ID format
• Source ID does not exist in your account
• Using test key to access live source (or vice versa)
• Typo in source ID

---

Code samples

cURL

curl https://api.omise.co/sources/src_test_5xuy4w91xqz7d1w9u0t \
  -u pkey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'pkey_test_5xuy4w91xqz7d1w9u0t'

source = Omise::Source.retrieve('src_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_public = 'pkey_test_5xuy4w91xqz7d1w9u0t'

source = omise.Source.retrieve('src_test_5xuy4w91xqz7d1w9u0t')

Node.js

const omise = require('omise')({
  publicKey: 'pkey_test_5xuy4w91xqz7d1w9u0t'
});

const source = await omise.sources.retrieve('src_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_PUBLIC_KEY', 'pkey_test_5xuy4w91xqz7d1w9u0t');

$source = OmiseSource::retrieve('src_test_5xuy4w91xqz7d1w9u0t');

Java

Client client = new Client.Builder()
    .publicKey("pkey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Source source = client.sources().get("src_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("pkey_test_5xuy4w91xqz7d1w9u0t");

var source = await client.Sources.Get("src_test_5xuy4w91xqz7d1w9u0t");

Go

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

source, _ := client.Sources().Get("src_test_5xuy4w91xqz7d1w9u0t")

---

Error and result codes

Common Error Codes

Code	Description	Resolution
authentication_failure	Invalid API key	Verify your public key is correct
not_found	Source not found	Check source ID is valid and exists

Charge Status Values

Status	Description
unknown	No charge created with this source yet
pending	Payment is pending customer action
successful	Payment completed successfully
failed	Payment failed
expired	Payment expired before completion

---

Try it out

Required - 1 fields

▼

id(Required)