Customers - Retrieve

curl --request GET \
  --url https://sandbox.hyperswitch.io/v1/customers/{id} \
  --header 'Authorization: <api-key>' \
  --header 'X-Profile-Id: <x-profile-id>'

import requests

url = "https://sandbox.hyperswitch.io/v1/customers/{id}"

headers = {
    "X-Profile-Id": "<x-profile-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Profile-Id': '<x-profile-id>', Authorization: '<api-key>'}
};

fetch('https://sandbox.hyperswitch.io/v1/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.hyperswitch.io/v1/customers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "X-Profile-Id: <x-profile-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.hyperswitch.io/v1/customers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Profile-Id", "<x-profile-id>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/v1/customers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Profile-Id"] = '<x-profile-id>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "0a_cus_01926c58bc6e77c09e809964e72af8c8",
  "merchant_reference_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "created_at": "2023-01-18T11:04:09.922Z",
  "connector_customer_ids": {},
  "name": "Jon Test",
  "email": "JonTest@test.com",
  "phone": "9123456789",
  "phone_country_code": "+65",
  "description": "First Customer",
  "default_billing_address": {
    "city": "New York",
    "country": "AF",
    "line1": "123, King Street",
    "line2": "Powelson Avenue",
    "line3": "Bridgewater",
    "zip": "08807",
    "state": "New York",
    "first_name": "John",
    "last_name": "Doe",
    "origin_zip": "08807"
  },
  "default_shipping_address": {
    "city": "New York",
    "country": "AF",
    "line1": "123, King Street",
    "line2": "Powelson Avenue",
    "line3": "Bridgewater",
    "zip": "08807",
    "state": "New York",
    "first_name": "John",
    "last_name": "Doe",
    "origin_zip": "08807"
  },
  "metadata": {},
  "default_payment_method_id": "0a_pm_01926c58bc6e77c09e809964e72af8c8",
  "tax_registration_id": "123456789",
  "document_details": {
    "document_type": "cpf",
    "document_number": "12345678911"
  }
}

GET

customers

{id}

Customers - Retrieve

curl --request GET \
  --url https://sandbox.hyperswitch.io/v1/customers/{id} \
  --header 'Authorization: <api-key>' \
  --header 'X-Profile-Id: <x-profile-id>'

import requests

url = "https://sandbox.hyperswitch.io/v1/customers/{id}"

headers = {
    "X-Profile-Id": "<x-profile-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Profile-Id': '<x-profile-id>', Authorization: '<api-key>'}
};

fetch('https://sandbox.hyperswitch.io/v1/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.hyperswitch.io/v1/customers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "X-Profile-Id: <x-profile-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.hyperswitch.io/v1/customers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Profile-Id", "<x-profile-id>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/v1/customers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Profile-Id"] = '<x-profile-id>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "0a_cus_01926c58bc6e77c09e809964e72af8c8",
  "merchant_reference_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "created_at": "2023-01-18T11:04:09.922Z",
  "connector_customer_ids": {},
  "name": "Jon Test",
  "email": "JonTest@test.com",
  "phone": "9123456789",
  "phone_country_code": "+65",
  "description": "First Customer",
  "default_billing_address": {
    "city": "New York",
    "country": "AF",
    "line1": "123, King Street",
    "line2": "Powelson Avenue",
    "line3": "Bridgewater",
    "zip": "08807",
    "state": "New York",
    "first_name": "John",
    "last_name": "Doe",
    "origin_zip": "08807"
  },
  "default_shipping_address": {
    "city": "New York",
    "country": "AF",
    "line1": "123, King Street",
    "line2": "Powelson Avenue",
    "line3": "Bridgewater",
    "zip": "08807",
    "state": "New York",
    "first_name": "John",
    "last_name": "Doe",
    "origin_zip": "08807"
  },
  "metadata": {},
  "default_payment_method_id": "0a_pm_01926c58bc6e77c09e809964e72af8c8",
  "tax_registration_id": "123456789",
  "document_details": {
    "document_type": "cpf",
    "document_number": "12345678911"
  }
}

Authorizations

Authorization

string

header

required

Format: api-key=<api_key>

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Headers

X-Profile-Id

string

required

Profile ID associated to the customer

Path Parameters

string

required

The unique identifier for the Customer

Response

Customer Retrieved

string

required

Unique identifier for the customer

Required string length: 32 - 64

Example:

"0a_cus_01926c58bc6e77c09e809964e72af8c8"

merchant_reference_id

string

required

The identifier for the customer object

Required string length: 1 - 64

Example:

"cus_y3oqhf46pyzuxjbcn2giaqnb44"

created_at

string<date-time>

required

A timestamp (ISO 8601 code) that determines when the customer was created

Example:

"2023-01-18T11:04:09.922Z"

connector_customer_ids

object | null

Connector specific customer reference ids

name

string | null

The customer's name

Maximum string length: 255

Example:

"Jon Test"

string | null

The customer's email address

Maximum string length: 255

Example:

"JonTest@test.com"

phone

string | null

The customer's phone number

Maximum string length: 255

Example:

"9123456789"

phone_country_code

string | null

The country code for the customer phone number

Maximum string length: 255

Example:

"+65"

description

string | null

An arbitrary string that you can attach to a customer object.

Maximum string length: 255

Example:

"First Customer"

default_billing_address

object | null

Address details

Show child attributes

default_shipping_address

object | null

Address details

Show child attributes

metadata

object | null

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

default_payment_method_id

string | null

The identifier for the default payment method.

Maximum string length: 64

Example:

"0a_pm_01926c58bc6e77c09e809964e72af8c8"

tax_registration_id

string | null

The customer's tax registration number.

Maximum string length: 255

Example:

"123456789"

document_details

object | null

Show child attributes

Get Started

Essentials

Payments Core APIs

Deprecated APIs

Account management APIs

Other APIs

Customers - Retrieve

Authorizations

Headers

Path Parameters

Response