2020-05-19

Customer Object

Contoh Customer Object

{
    "id": "239c16f4-866d-43e8-9341-7badafbc019f",
    "reference_id": "demo_1475801962607",
    "email": "customer@website.com",
    "mobile_number": null,
    "given_names": "John",
    "description": null,
    "middle_name": null,
    "surname": "Doe",
    "phone_number": "+6285300000000",
    "hashed_phone_number": null,
    "nationality": "ID",
    "addresses": [{
        "country": "ID",
        "street_line1": "Jalan Makan",
        "street_line2": "Kecematan Kebayoran Baru",
        "city": "Jakarta Selatan",
        "province": "Daerah Khusus Ibukota Jakarta",
        "state": null,
        "postal_code": "12160"
    }],
    "date_of_birth": "2000-01-01",
    "metadata": null
}

Versi

Anda sedang melihat API versi 2020-05-19. Versi yang terbaru telah tersedia! Klik di sini untuk melihat versi terbaru.

Parameter	Deskripsi
id	string ID unik yang dihasilkan oleh Xendit untuk customer ini
reference_id	string Pengidentifikasi yang Anda berikan pada saat melakukan request
mobile_number	string Nomor telepon customer
email	string Alamat email customer
given_names	string Nama depan customer
middle_name	string Nama tengah customer
surname	string Name keluarga customer
description	string Deskripsi yang Anda sediakan untuk customer object
phone_number	string Nomor telepon alternatif
hashed_phone_number	string Hashed phone number
nationality	string Kode negara kewarganegaraan customer
addresses	object array Array objek yang mengandung informasi alamat customer kode negara tempat tinggal customer Key Value country required 2-huruf 2-letter ISO 3166-2 country code street_line1 optional Nama jalan dan nomor unit tempat tinggal street_line2 optional Alamat tempat tinggal city optional Kota/Kabupaten tempat tinggal customer province optional Provinsi tempat tinggal customer state optional Negara bagian di dalam negara, jika berlaku postal_code optional Kode pos, jika berlaku
date_of_birth	string Tanggal lahir customer dalam format YYYY-MM-DD
metadata	object Format JSON bebas untuk informasi tambahan yang bisa Anda gunakan

Create Customer

Customer object wajib digunakan untuk menghubungkan metode pembayaran dengan direct debit. Endpoint ini memungkinkan Anda untuk dengan mudah menghubungkan dan menelusuri transaksi dan metode pembayaran

Endpoint: Create Customer

POST https://api.xendit.co/customers

Versi

Anda sedang melihat API versi 2020-05-19. Versi yang terbaru telah tersedia! Klik di sini untuk melihat versi terbaru.

Parameter Request

Contoh Request Create Customer

curl https://api.xendit.co/customers -X POST \
   -u xnd_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==: \
   -H 'Content-Type: application/json' \
   -H 'API-VERSION: 2020-05-19' \
   -d reference_id=demo_1475801962607 \
   -d given_names="John" \
   -d mobile_number="+6287774441111" \
   -d email="customer@website.com" \

<?php

  use Xendit\Xendit;
  require 'vendor/autoload.php';

  Xendit::setApiKey('xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw==');

  $customerParams = [
    'reference_id' => '' . time(),
    'given_names' => 'customer 1',
    'email' => 'customer@website.com',
    'mobile_number' => '+6281212345678',
    'description' => 'dummy customer',
    'middle_name' => 'middle',
    'surname' => 'surname',
    'addresses' => [
      [
        'country' => 'ID',
        'street_line1' => 'Jl. 123',
        'street_line2' => 'Jl. 456',
        'city' => 'Jakarta Selatan',
        'province' => 'DKI Jakarta',
        'state' => '-',
        'postal_code' => '12345'
      ]
    ],
    'metadata' => [
      'meta' => 'data'
    ]
  ];

  $createCustomer = \Xendit\Customers::createCustomer($customerParams);
  var_dump($createCustomer);

?>

const x = new require("xendit-node")({
  secretKey:
    "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw==",
});

const { Customer } = x;
const customerSpecificOptions = {};
const c = new Customer(customerSpecificOptions);

const resp = await c.createCustomer({
  referenceID:'demo_1475801962607',
  givenNames: 'John',
  mobileNumber: '+6287774441111',
  email: 'customer@website.com',
});
console.log(resp);

xendit.Opt.SecretKey = "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw=="

customerAddress := xendit.CustomerAddress{
  Country:      "ID",
  StreetLine1:  "Jl. 123",
  StreetLine2:  "Jl. 456",
  City:         "Jakarta Selatan",
  Province:     "DKI Jakarta",
  State:        "-",
  PostalCode:   "12345",
}

data := customer.CreateCustomerParams{
  ReferenceID:  "test-reference-id-003",
  Email:        "tes@tes.com",
  GivenNames:   "Given Names",
  Nationality:  "ID",
  DateOfBirth:  "1995-12-30",
  Addresses:    []xendit.CustomerAddress{customerAddress},
  Metadata:     map[string]interface{}{
    "meta": "data",
  },
}

resp, err := customer.CreateCustomer(&data)
if err != nil {
  log.Fatal(err)
}

fmt.Printf("created payment: %+v\n", resp)

try {
    Xendit.apiKey = "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw==";

    CustomerAddress customerAddress =  CustomerAddress.builder()
        .country("ID")
        .streetLine1("Jl. 123")
        .streetLine2("Jl. 456")
        .city("Jakarta Selatan")
        .province("DKI Jakarta")
        .state("-")
        .postalCode("12345")
        .category("None")
        .isPreferred(true)
        .build();
    CustomerAddress[] customerAddressArray = new CustomerAddress[]{customerAddress};

    Map<String, Object> metadata = new HashMap<>();
    metadata.put("halo", "hello");
    metadata.put("tes", "123");

    Map<String, Object> params = new HashMap<>();
    params.put("reference_id", "test-reference-id");
    params.put("email", "tes@tes.com");
    params.put("given_names", "Given Names");
    params.put("nationality", "ID");
    params.put("date_of_birth", "1995-12-30");
    params.put("addresses", customerAddressArray);
    params.put("metadata", metadata);

    Customer customer = Customer.createCustomer(params);
} catch (XenditException e) {
    e.printStackTrace();
}

from xendit import Xendit

api_key = "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw=="
xendit_instance = Xendit(api_key=api_key)
DirectDebit = xendit_instance.DirectDebit

customer = DirectDebit.create_customer(
    reference_id="merc-1594279037",
    email="t@x.co",
    given_names="Adyaksa",
)
print(customer)

string apiKey = "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw==";

XenditClient xendit = new XenditClient(apiKey);
CustomerClient customer = xendit.Customer;

CustomerParameter individualParameterVersion20200519 = new CustomerParameter
{
  ReferenceId = "demo_11212162",
  Email = "john@email.com",
  GivenNames = "John",
  Addresses = new Address[] { new Address { Country = Country.Indonesia } }
};

CustomerResponse individualCustomerVersion20200519 = await customer.Create(individualParameterVersion20200519, version: ApiVersion.Version20200519);

Header	Deskripsi
for-user-id optional	string User-id yang Anda inginkan untuk membuat transaksi. Header ini hanya bisa digunakan jika Anda memiliki akses ke xenPlatform. Silahkan buka xenPlatform untuk informasi lebih lanjut.

Parameter Request Body	Deskripsi
reference_id required	string ID untuk identifikasi customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
mobile_number nomor handphone atau email wajib	string Nomor ponsel customer dalam standar format internasional E.164 . Format: +(country code)(subscriber number)
email nomor handphone atau email wajib	string Alamat email dari customer
given_names required	string Nama depan customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
middle_name optional Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.	string Nama tengah customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
surname optional	string Nama keluarga customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
description optional	string Deskripsi yang disediakan oleh merchant untuk customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
phone_number optional	string Alternatif nomor telepon dengan standar format internasional E.164 . Format: +(country code)(subscriber number)
hashed_phone_number optional	string Hashed phone number
nationality optional	string Dua huruf 2-letter ISO 3166-2 country code kode negara kebangsaan customer
addresses optional	object array Array objek yang mengandung informasi alamat customer Setiap objek mungkin memiliki properti di bawah ini: kode negara tempat tinggal customer Key Value country required 2-huruf 2-letter ISO 3166-2 country code street_line1 optional Nama jalan tempat tinggal dan nomor unit Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan. street_line2 optional Alamat jalan tempat tinggal Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan. city optional Kota/Kabupaten tempat tinggal customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan. province optional Provinsi tempat tinggal customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan. state optional Negarabagian di dalam negara,jika berlaku Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan. postal_code optional Kodepos, jika berlaku Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
date_of_birth optional	string Tanggal lahir customer dalam format YYYY-MM-DD
metadata optional	object Format JSON bebas untuk informasi tambahan yang bisa Anda gunakan

Parameter Respon

Contoh Respon Sukses Membuat Customer

{
    "id": "239c16f4-866d-43e8-9341-7badafbc019f",
    "reference_id": "demo_1475801962607",
    "email": "customer@website.com",
    "mobile_number": null,
    "given_names": "John",
    "description": null,
    "middle_name": null,
    "surname": null,
    "phone_number": null,
    "nationality": null,
    "addresses": null,
    "date_of_birth": null,
    "metadata": null
}

Parameter	Deskripsi
id	string ID unik yang dihasilkan oleh Xendit untuk customer ini
reference_id	string Pengidentifikasi yang Anda sediakan pada saat melakukan request
mobile_number	string Nomor handphone customer
email	string Alamat email customer
given_names	string Nama depan customer
middle_name	string Nama tengah customer
surname	string Name keluarga customer
description	string Deskripsi yang Anda sediakan untuk customer object
phone_number	string Alternatif atau saluran telepon
nationality	string Kode negara untuk kebangsaan customer
addresses	object array Array objek yang mengandung informasi sepsifik dari alamat customer kode negara tempat tinggal customer Key Value country required 2-huruf 2-letter ISO 3166-2 country code street_line1 optional Nama jalan tempat tinggal dan nomor unit street_line2 optional Alamat jalan tempat tinggal city optional Kota/Kabupaten tempat tinggal customer province optional Provinsi tempat tinggal customer state optional Negarabagian di dalam negara,jika berlaku postal_code optional Kodepos, jika berlaku
date_of_birth	string Tanggal lahir customer dalam format YYYY-MM-DD
metadata	object Format JSON bebas untuk informasi tambahan yang bisa Anda gunakan

Kode Error

Lihat lainnya error pada umumnya di sini.

Error Code	Deskripsi
DUPLICATE_ERROR 409	reference_idyang Anda gunakan sudah pernah digunakan sebelumnya. Silakan masukkan reference_id unik dan coba kembali

Get Customer

Untuk mendapatkan satu objek customer

Endpoint: Get Customer

GET https://api.xendit.co/customers/:id

Versi

Anda sedang melihat API versi 2020-05-19. Versi yang terbaru telah tersedia! Klik di sini untuk melihat versi terbaru.

Parameter Request

Contoh Request Get Customer

curl https://api.xendit.co/customers/239c16f4-866d-43e8-9341-7badafbc019f -X GET \
   -u xnd_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==: \
   -H 'API-VERSION: 2020-05-19' \

<?php
  $url = "https://api.xendit.co/customers/239c16f4-866d-43e8-9341-7badafbc019f";
  $apiKey = "xnd_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==:";
  $headers = [];
  $headers[] = "Content-Type: application/json";
  $headers[] = "API-VERSION: 2020-05-19";

  $curl = curl_init();

  $payload = json_encode($data);
  curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
  curl_setopt($curl, CURLOPT_USERPWD, $apiKey.":");
  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

  $result = curl_exec($curl);
  echo $result;

let apiKey = "xnd_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==:";
let url = "https://api.xendit.co/customers/239c16f4-866d-43e8-9341-7badafbc019f";

var headers = new Headers();
headers.append("Authorization", "Basic " + btoa(apiKey + ":"));
headers.append("Content-Type", "application/json");
headers.append("API-VERSION", "2020-05-19");

var requestOptions = {
  method: 'GET',
  headers: headers,
  redirect: 'follow'
};

fetch(url, requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

xendit.Opt.SecretKey = "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw=="

data := customer.getCustomer{
  id: 'cust-239c16f4-866d-43e8-9341-7badafbc019f'
}

resp, err := customer.getCustomer(&getCustomerByReferenceIDData)
if err != nil {
  log.Fatal(err)
}

fmt.Printf("retrieved customer: %+v\n", resp)

try {
    Xendit.apiKey = "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw==";

    Customer[] customers = Customer.getCustomer("cust-239c16f4-866d-43e8-9341-7badafbc019f");
} catch (XenditException e) {
    e.printStackTrace();
}

import requests
import base64

api_key = "xnd_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==:"
url = "https://api.xendit.co/customers/239c16f4-866d-43e8-9341-7badafbc019f"

api_key_bytes = api_key.encode('ascii')
base64_bytes = base64.b64encode(api_key_bytes)
base64_token = base64_bytes.decode('ascii')

auth_token = 'Basic ' + base64_token
headers = {
  'Authorization': auth_token,
  'API-VERSION': '2020-05-19'
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Header Parameter	Tipe	Deskripsi
API-VERSION optional	string	Versi API dalam format tanggal (contoh: 2020-05-19). Gunakan header ini untuk menggunakan versi API yang anda inginkan. Daftar versi API dapat ditemukan di sini.
for-user-id optional	string	User-id yang Anda inginkan untuk membuat transaksi. Header ini hanya bisa digunakan jika Anda memiliki akses ke xenPlatform. Silahkan buka xenPlatform untuk informasi lebih lanjut.

Parameter	Tipe	Deskripsi
id	string	Customer ID yang dihasilkan oleh Xendit. Dimulai dengan cust-...

Parameter Respon

Respon sukses akan berisi satu Customer Object

Kode Error

Lihat lainnya error pada umumnya di sini.

Kode Error	Deskripsi
DATA_NOT_FOUND 404	id yang diberikan tidak ada. Mohon cek id tersebut dan coba kembali

Update Customer

Lakukan request PATCH ke endpoint ini untuk melakukan update pada suatu customer. Hanya fields yang ada pada request yang akan dilakukan update. Perubahan apapun pada field-field di objek customer akan menggantikan hal tersebut secara keseluruhan. Apabila anda ingin menambahkan pada suatu array, request PATCH anda harus memiliki kondisi akhir array yang diinginkan (contoh, konten yang ada sekarang dan elemen array baru yang ingin anda tambahkan). Berikan nilai NULL untuk menghapus konten yang ada sekarang.

Perhatikan bahwa reference_id dan type pada suatu customer tidak dapat di-update.

Endpoint: Update Customer

PATCH https://api.xendit.co/customers/:id

Versi

Anda sedang melihat API versi 2020-10-31. Klik di sini untuk melihat versi sebelumnya.

Versi	Changelog
2020-10-31 (terbaru)	Pembaruan untuk mendukung jenis BUSINESS dan akun identitas umum
2020-05-19	Versi asli

Parameter Request

Contoh Request Update Customer

curl https://api.xendit.co/customers/239c16f4-866d-43e8-9341-7badafbc019f -X PATCH \
   -u xnd_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==: \
   -H 'Content-Type: application/json'
   -H 'API-VERSION: 2020-05-19'
   --data-raw '{
      "given_names": "John",
      "surname": "Doe",
      "email": "customer@website.com",
      "mobile_number": "+628121234567890"
     }'

<?php
  $url = "https://api.xendit.co/customers/239c16f4-866d-43e8-9341-7badafbc019f";
  $apiKey = "xnd_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==:";
  $headers = [];
  $headers[] = "Content-Type: application/json";
  $headers[] = "API-VERSION: 2020-05-19";
  $data = [
       "given_names" => "Jane",
       "surname" => "Doe"
       "email"=>  "customer@website.com",
       "mobile_number"=>  "+628121234567890
  ];

  $curl = curl_init();

  $payload = json_encode($data);
  curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
  curl_setopt($curl, CURLOPT_USERPWD, $apiKey.":");
  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PATCH');
  curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

  $result = curl_exec($curl);
  echo $result;

let apiKey = "xnd_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==:";
let url = "https://api.xendit.co/customers/239c16f4-866d-43e8-9341-7badafbc019f";

var headers = new Headers();
headers.append("Authorization", "Basic " + btoa(apiKey + ":"));
headers.append("Content-Type", "application/json");
headers.append("API-VERSION", "2020-05-19");

var reqBody = JSON.stringify({
  "given_names": "John",
  "surname": "Doe",
  "email": "customer@website.com",
  "mobile_number": "+628121234567890"});

var requestOptions = {
  method: 'PATCH',
  headers: headers,
  body: reqBody,
  redirect: 'follow'
};

fetch(url, requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import requests
import base64

api_key = "xnd_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==:"
url = "https://api.xendit.co/customers"

api_key_bytes = api_key.encode('ascii')
base64_bytes = base64.b64encode(api_key_bytes)
base64_token = base64_bytes.decode('ascii')

payload = {
  "given_names": "John",
  "surname": "Doe",
  "email": "customer@website.com",
  "mobile_number": "+628121234567890"
}
auth_token = 'Basic ' + base64_token
headers = {
  'Authorization': auth_token,
  'API-VERSION': '2020-05-19'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

string apiKey = "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw==";

XenditClient xendit = new XenditClient(apiKey);
CustomerClient customer = xendit.Customer;

CustomerParameter individualParameter = new CustomerParameter
{
    GivenNames = "John",
    Gender = CustomerGender.Male,
};

CustomerResponse individualCustomerVersion20200519 = await customer.Update(individualParameter);

Header Parameter	Tipe	Deskripsi
API-VERSION	string	Versi API dalam format tanggal (contoh: 2020-10-31). Gunakan header ini untuk menggunakan versi API yang anda inginkan. Daftar versi API dapat ditemukan di sini.
for-user-id	string	User-id yang Anda inginkan untuk membuat transaksi. Header ini hanya bisa digunakan jika Anda memiliki akses ke xenPlatform. Silahkan buka xenPlatform untuk informasi lebih lanjut.

Parameter Request Body	Deskripsi
mobile_number nomor handphone atau email wajib	string Nomor ponsel customer dalam standar format internasional E.164 . Format: +(country code)(subscriber number)
email nomor handphone atau email wajib	string Alamat email dari customer
given_names	string Nama depan customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
middle_name	string Nama tengah customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
surname	string Nama keluarga customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
description	string Deskripsi yang disediakan oleh merchant untuk customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
phone_number	string Alternatif nomor telepon dengan standar format internasional E.164 . Format: +(country code)(subscriber number)
hashed_phone_number	string Hashed phone number
nationality	string Dua huruf 2-letter ISO 3166-2 country code kode negara kebangsaan customer
addresses	object array Array objek yang mengandung informasi alamat customer Setiap objek mungkin memiliki properti di bawah ini: kode negara tempat tinggal customer Key Value country 2-huruf 2-letter ISO 3166-2 country code street_line1 Nama jalan tempat tinggal dan nomor unit Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan. street_line2 Alamat jalan tempat tinggal Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan. city Kota/Kabupaten tempat tinggal customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan. province Provinsi tempat tinggal customer Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan. state Negarabagian di dalam negara,jika berlaku Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan. postal_code Kodepos, jika berlaku Karakter Alfanumerik. Tidak ada karakter spesial yang diperbolehkan.
date_of_birth	string Tanggal lahir customer dalam format YYYY-MM-DD
metadata	object Format JSON bebas untuk informasi tambahan yang bisa Anda gunakan

Parameter Respon

Respon sukses akan berisi satu Customer Object dengan konten yang diperbarui

Kode Error

Lihat lainnya error pada umumnya di sini.

Kode Error	Deskripsi
DATA_NOT_FOUND 404	id yang diberikan tidak ada. Mohon cek id tersebut dan coba kembali

Get Customer by Reference ID

Mendapatkan array customer object sesuai dengan reference_id yang Anda berikan.

Endpoint: Get Customer by Reference ID

GET https://api.xendit.co/customers?reference_id={reference_id}

Versi

Anda sedang melihat API versi 2020-05-19. Versi yang terbaru telah tersedia! Klik di sini untuk melihat versi terbaru.

Parameter Request

Contoh Request Get Customer menggunakan Reference ID

curl https://api.xendit.co/customers?reference_id=demo_1475801962607 -X GET \
   -u xnd_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==: \
   -H 'API-VERSION: 2020-05-19' \

<?php

  use Xendit\Xendit;
  require 'vendor/autoload.php';

  Xendit::setApiKey('xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw==');

  $getCustomer = \Xendit\Customers::getCustomerByReferenceID(
    'cust-ref-id'
  );
  var_dump($getCustomer);

?>

const x = new require("xendit-node")({
  secretKey:
    "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw==",
});

const { Customer } = x;
const customerSpecificOptions = {};
const c = new Customer(customerSpecificOptions);

const resp = await c.getCustomerByReferenceID({
  referenceID: 'demo_1475801962607',
});
console.log(resp);

xendit.Opt.SecretKey = "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw=="

data := customer.GetCustomerByReferenceIDParams{
  ReferenceID:    "test-reference-id-003",
}

resp, err := customer.GetCustomerByReferenceID(&getCustomerByReferenceIDData)
if err != nil {
  log.Fatal(err)
}

fmt.Printf("retrieved customer: %+v\n", resp)

try {
    Xendit.apiKey = "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw==";

    Customer[] customers = Customer.getCustomerByReferenceId("test-reference-id");
} catch (XenditException e) {
    e.printStackTrace();
}

from xendit import Xendit

api_key = "xnd_development_P4qDfOss0OCpl8RtKrROHjaQYNCk9dN5lSfk+R1l9Wbe+rSiCwZ3jw=="
xendit_instance = Xendit(api_key=api_key)
DirectDebit = xendit_instance.DirectDebit

customer = DirectDebit.get_customer_by_ref_id(
    reference_id="merc-1594279037",
)
print(customer)

Query String Parameter	Deskripsi
reference_id required	string Pengidentifikasi yang disediakan merchant untuk customer

Parameter Respon

Contoh respon sukses Get Customer menggunakan Reference ID

[{
    "id": "239c16f4-866d-43e8-9341-7badafbc019f",
    "reference_id": "demo_1475801962607",
    "email": "customer@website.com",
    "mobile_number": null,
    "given_names": "John",
    "description": null,
    "middle_name": null,
    "surname": null,
    "phone_number": null,
    "hashed_phone_number": null,
    "nationality": null,
    "addresses": null,
    "date_of_birth": null,
    "metadata": null
}]

Header	Deskripsi
for-user-id optional	string User-id yang Anda inginkan untuk membuat transaksi. Header ini hanya bisa digunakan jika Anda memiliki akses ke xenPlatform. Silahkan buka xenPlatform untuk informasi lebih lanjut.

Parameter	Deskripsi
id	string ID unik dari Xendit untuk customer yang Anda buat
reference_id	string Pengidentifikasi yang Anda sediakan pada saat melakukan request
mobile_number	string Nomor telepon customer
email	string Alamat email customer
given_names	string Nama depan customer
middle_name	string Nama tengah customer
surname	string Nama keluarga customer
description	string Deskripsi yang Anda sediakan untuk customer object
phone_number	string Nomor telepon alternatif
nationality	string Kode negara kewarganegaraan customer
addresses	object array Array objek yang mengandung informasi alamat customer
date_of_birth	string Tanggal lahir customer dalam format YYYY-MM-DD
metadata	object Json dalam format bebas sebagai tambahan informasi yang Anda sediakan pada saat melakukan request

Kode Error

Lihat lainnyaerror pada umumnya di sini.

Changelog

Version 2020-10-31

Pembaruan untuk mendukung jenis BUSINESS dan akun identitas umum

Version 2020-05-19

Versi asli