Get Customer

Retrieve a customer by ID, email, or reference code.

Retrieves a customer's details by their ID, email address, or IvoryPay reference code.

Endpoint

GET /v1/customers/:prop

Authentication

Header

Value

x-api-key

Your API key

Path parameters

Parameter

Type

Description

prop

string

Customer UUID, email address, or refCode

Example requests

# By UUID
curl -X GET https://ramp-api.ivorypay.io/api/v1/customers/c3d4e5f6-a7b8-9012-cdef-a12345678901 \
  -H "x-api-key: your_api_key"

# By email
curl -X GET https://ramp-api.ivorypay.io/api/v1/customers/amina@example.com \
  -H "x-api-key: your_api_key"

# By refCode
curl -X GET https://ramp-api.ivorypay.io/api/v1/customers/abc123def4 \
  -H "x-api-key: your_api_key"

// By UUID, email, or refCode
const prop = "c3d4e5f6-a7b8-9012-cdef-a12345678901";

const response = await fetch(`https://ramp-api.ivorypay.io/api/v1/customers/${prop}`, {
  method: "GET",
  headers: {
    "x-api-key": "your_api_key",
  },
});

const data = await response.json();
console.log(data);

import requests

# By UUID, email, or refCode
prop = "c3d4e5f6-a7b8-9012-cdef-a12345678901"

response = requests.get(
    f"https://ramp-api.ivorypay.io/api/v1/customers/{prop}",
    headers={
        "x-api-key": "your_api_key",
    },
)

print(response.json())

package main

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

func main() {
	// By UUID, email, or refCode
	prop := "c3d4e5f6-a7b8-9012-cdef-a12345678901"

	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/customers/"+prop, nil)
	req.Header.Set("x-api-key", "your_api_key")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

Example response

{
  "statusCode": 200,
  "success": true,
  "message": "Query successful",
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-a12345678901",
    "refCode": "abc123def4",
    "firstName": "Amina",
    "lastName": "Okafor",
    "email": "amina@example.com",
    "phoneNumber": "+2348012345678",
    "context": "LIVE",
    "isVerified": false,
    "createdAt": "2026-03-26T12:00:00.000Z"
  }
}

Error cases

Error code

Description

ONOFFRAMP0053

Customer not found

PreviousCreate Customer NextUpdate Customer

Last updated 1 month ago

hashtagEndpoint

hashtagAuthentication

hashtagPath parameters

hashtagExample requests

hashtagExample response