Get customer Address

ApiScope: payment.payisland
API Scope Level: ServiceSubscriberScope

Path Parameters

customerGuid string required

Query Parameters

dealerUUID string required

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode string
errorDescription string
]
warnings object[]
Array [
warningCode string
warningDescription string
]
customerInfo object
id int64
fname string
lname string
customerKey string
uuid string
company string
dealerId int64
communications object[]
Array [
commValue string
commType string
commLabel string
preferred boolean
id int64
]
vehicles object[]
Array [
model string
year string
make string
engine string
bodyStyle string
trim string
vin string
id int64
isValid boolean
uuid string
vehicleKey string
imageUrl string
]
secondaryCustomerData object[]
Array [
fname string
lname string
customerKey string
guid string
customerId int64
]
dealerOrderInfoList object[]
Array [
dealerOrder_id int64
dealer_id int64
customer_id int64
dealerassociate_id int64
vehicle_id int64
order_number string
order_type string
order_date string
order_amount number
order_status string
description string
created_date string
close_date string
dealerOrder_uuid string
tag_or_hat string
dealerOrderStatusFilter string[]
updated_date string
transactions object[]
Array [
tenderDataId int64
dealerOrderId int64
customerId int64
transactionId int64
deviceId int64
transactionTypeId int64
transactionAmount number
ccNumber string
]
customer_uuid string
vehicle_uuid string
dealerAssociate_uuid string
]
addressListV2 object[]
Array [
line1 string
line2 string
city string
zip string
addressType string
type string
Possible values: [COMMON, PRIMARY, BILLING, OTHER]
country string
updateTS date-time
uuid string
isValid boolean
isPreferred boolean
state string
]
addressList object[]
Array [
id int64
dealerID int64
line1 string
line2 string
city string
zip string
zipExt string
addressType string
phone string
stateCode string
stateDescription string
countryCode string
country string
]

{
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ],
  "customerInfo": {
    "id": 0,
    "fname": "string",
    "lname": "string",
    "customerKey": "string",
    "uuid": "string",
    "company": "string",
    "dealerId": 0,
    "communications": [
      {
        "commValue": "string",
        "commType": "string",
        "commLabel": "string",
        "preferred": true,
        "id": 0
      }
    ],
    "vehicles": [
      {
        "model": "string",
        "year": "string",
        "make": "string",
        "engine": "string",
        "bodyStyle": "string",
        "trim": "string",
        "vin": "string",
        "id": 0,
        "isValid": true,
        "uuid": "string",
        "vehicleKey": "string",
        "imageUrl": "string"
      }
    ],
    "secondaryCustomerData": [
      {
        "fname": "string",
        "lname": "string",
        "customerKey": "string",
        "guid": "string",
        "customerId": 0
      }
    ]
  },
  "dealerOrderInfoList": [
    {
      "dealerOrder_id": 0,
      "dealer_id": 0,
      "customer_id": 0,
      "dealerassociate_id": 0,
      "vehicle_id": 0,
      "order_number": "string",
      "order_type": "string",
      "order_date": "string",
      "order_amount": 0,
      "order_status": "string",
      "description": "string",
      "created_date": "string",
      "close_date": "string",
      "dealerOrder_uuid": "string",
      "tag_or_hat": "string",
      "dealerOrderStatusFilter": [
        "string"
      ],
      "updated_date": "string",
      "transactions": [
        {
          "tenderDataId": 0,
          "dealerOrderId": 0,
          "customerId": 0,
          "transactionId": 0,
          "deviceId": 0,
          "transactionTypeId": 0,
          "transactionAmount": 0,
          "ccNumber": "string"
        }
      ],
      "customer_uuid": "string",
      "vehicle_uuid": "string",
      "dealerAssociate_uuid": "string"
    }
  ],
  "addressListV2": [
    {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "zip": "string",
      "addressType": "string",
      "type": "COMMON",
      "country": "string",
      "updateTS": "2025-04-07T07:51:27.864Z",
      "uuid": "string",
      "isValid": true,
      "isPreferred": true,
      "state": "string"
    }
  ],
  "addressList": [
    {
      "id": 0,
      "dealerID": 0,
      "line1": "string",
      "line2": "string",
      "city": "string",
      "zip": "string",
      "zipExt": "string",
      "addressType": "string",
      "phone": "string",
      "stateCode": "string",
      "stateDescription": "string",
      "countryCode": "string",
      "country": "string"
    }
  ]
}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

GET /kpayment/v1/customer/:customerGuid

Request

Base URL

/payment

customerGuid — path required

dealerUUID — query required

curl / cURL

curl -L -X GET '/payment/kpayment/v1/customer/:customerGuid' \
-H 'Accept: application/json'

python / requests

curl -L -X GET '/payment/kpayment/v1/customer/:customerGuid' \
-H 'Accept: application/json'

go / native

curl -L -X GET '/payment/kpayment/v1/customer/:customerGuid' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET '/payment/kpayment/v1/customer/:customerGuid' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET '/payment/kpayment/v1/customer/:customerGuid' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET '/payment/kpayment/v1/customer/:customerGuid' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET '/payment/kpayment/v1/customer/:customerGuid' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET '/payment/kpayment/v1/customer/:customerGuid' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET '/payment/kpayment/v1/customer/:customerGuid' \
-H 'Accept: application/json'