Get customer by externalId

Get customer by external ID

curl --request GET \
  --url https://api.moonpay.com/v1/customers/ext/{customerId} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.moonpay.com/v1/customers/ext/{customerId}', 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://api.moonpay.com/v1/customers/ext/{customerId}",
  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>"
  ],
]);

$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://api.moonpay.com/v1/customers/ext/{customerId}"

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

	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://api.moonpay.com/v1/customers/ext/{customerId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

[
  {
    "id": "2fcbcea3-6b62-49f1-b9d1-026d9bfd00b6",
    "createdAt": "2024-02-17T18:24:45.206Z",
    "updatedAt": "2024-02-17T18:24:45.206Z",
    "liveMode": true,
    "defaultCurrencyId": "71435a8d-211c-4664-a59e-2a5361a6c5a7",
    "defaultCurrencyCode": "eur",
    "externalCustomerId": "<string>",
    "identityCheckStatus": "completed",
    "identityCheckLevel": 1
  }
]

{
  "moonPayErrorCode": "4_SYS_BAD_REQUEST",
  "message": "<string>",
  "type": "<string>",
  "errors": [
    {
      "property": "<string>",
      "message": "<string>",
      "children": [
        {}
      ]
    }
  ]
}

{
  "moonPayErrorCode": "4_SYS_BAD_REQUEST",
  "message": "<string>",
  "type": "<string>",
  "errors": [
    {
      "property": "<string>",
      "message": "<string>",
      "children": [
        {}
      ]
    }
  ]
}

GET

customers

ext

{customerId}

Get customer by external ID

curl --request GET \
  --url https://api.moonpay.com/v1/customers/ext/{customerId} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.moonpay.com/v1/customers/ext/{customerId}', 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://api.moonpay.com/v1/customers/ext/{customerId}",
  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>"
  ],
]);

$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://api.moonpay.com/v1/customers/ext/{customerId}"

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

	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://api.moonpay.com/v1/customers/ext/{customerId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

[
  {
    "id": "2fcbcea3-6b62-49f1-b9d1-026d9bfd00b6",
    "createdAt": "2024-02-17T18:24:45.206Z",
    "updatedAt": "2024-02-17T18:24:45.206Z",
    "liveMode": true,
    "defaultCurrencyId": "71435a8d-211c-4664-a59e-2a5361a6c5a7",
    "defaultCurrencyCode": "eur",
    "externalCustomerId": "<string>",
    "identityCheckStatus": "completed",
    "identityCheckLevel": 1
  }
]

{
  "moonPayErrorCode": "4_SYS_BAD_REQUEST",
  "message": "<string>",
  "type": "<string>",
  "errors": [
    {
      "property": "<string>",
      "message": "<string>",
      "children": [
        {}
      ]
    }
  ]
}

{
  "moonPayErrorCode": "4_SYS_BAD_REQUEST",
  "message": "<string>",
  "type": "<string>",
  "errors": [
    {
      "property": "<string>",
      "message": "<string>",
      "children": [
        {}
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Your secret API key, passed as Authorization: Api-Key <secret key>, for example Authorization: Api-Key sk_test_key. Secret keys are prefixed with sk_test_ (sandbox) or sk_live_ (production) and must only be used server-side. Never expose them in client code. Find your keys on the API keys page of the dashboard. See Authentication.

Path Parameters

customerId

string

required

A valid external customer ID.

Response

Successful response: an array of customer objects matching the external customer ID.

string

Unique identifier for the customer.

Example:

"2fcbcea3-6b62-49f1-b9d1-026d9bfd00b6"

createdAt

string

Time at which the object was created. Returned as an ISO 8601 string.

Example:

"2024-02-17T18:24:45.206Z"

updatedAt

string

Time at which the object was last updated. Returned as an ISO 8601 string.

Example:

"2024-02-17T18:24:45.206Z"

liveMode

boolean

true if the customer was created in live mode, false if created in sandbox.

Example:

true

defaultCurrencyId

string

Unique identifier of the customer's default fiat currency.

Example:

"71435a8d-211c-4664-a59e-2a5361a6c5a7"

defaultCurrencyCode

string

Code of the customer's default fiat currency. May be omitted if no default currency is set.

Example:

"eur"

externalCustomerId

string | null

An identifier associated with the customer, provided by you.

identityCheckStatus

enum<string>

Status of the customer's identity verification.

Available options:

no_kyc,

pending,

completed,

rejected

Example:

"completed"

identityCheckLevel

integer

The customer's identity verification level. 0 if the customer has not completed an identity check.

Example:

1

Overview

Customers

On-ramp

Off-ramp

Data

DeFi tokens

Virtual Accounts

Webhooks

Authorizations

Path Parameters

Response