Retrieve a customer profile

curl -X POST https://gateway.ixopay.com/api/v3/customerProfiles/apiKey/getProfile \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "profileGuid": "CP-0000-0000-0000-0000-0000-0000"
}'

{
  "success": true,
  "profileExists": true,
  "profileGuid": "CP-0000-0000-0000-0000-0000-0000",
  "customerIdentification": "YOUR_CUSTOMER_ID",
  "preferredMethod": "Creditcard",
  "customer": {
    "_TYPE": "customerData",
    "billingAddress1": "Street",
    "billingAddress2": "Address",
    "billingCity": "Vienna",
    "billingCountry": "AT",
    "billingPhone": "123456789",
    "billingPostcode": "1010",
    "billingState": "Vienna",
    "birthDate": "1970-01-01",
    "company": "Company Name",
    "email": "john@example.com",
    "extraData": [],
    "firstName": "John",
    "gender": "M",
    "ipAddress": "127.0.0.1",
    "lastName": "Smith",
    "nationalId": "1234"
  },
  "paymentInstruments": [
    {
      "_TYPE": "paymentInstrument",
      "createdAt": "2018-10-25 12:52:27",
      "method": "card",
      "paymentData": {
        "_TYPE": "paymentData.card",
        "brand": "visa",
        "cardHolder": "John Smith",
        "expiryMonth": "4",
        "expiryYear": "2020",
        "firstSixDigits": "411111",
        "lastFourDigits": "1111"
      },
      "paymentToken": "pt::12345678901234567890",
      "isPreferred": true
    },
    {
      "_TYPE": "paymentInstrument",
      "createdAt": "2018-10-25 13:02:22",
      "method": "iban",
      "paymentData": {
        "_TYPE": "paymentData.iban",
        "bic": null,
        "iban": "AT111111111111111111",
        "mandateDate": "2018-10-25 00:00:00",
        "mandateId": "123123"
      },
      "paymentToken": "pt::12345678901234567891",
      "isPreferred": false
    },
    {
      "_TYPE": "paymentInstrument",
      "createdAt": "2018-10-28 12:00:25",
      "method": "wallet",
      "paymentData": {
        "_TYPE": "paymentData.wallet",
        "walletOwner": "someone@example.com",
        "walletOwnerCountryCode": "DE,",
        "walletOwnerFirstName": "Max,",
        "walletOwnerLastName": "Mustermann,",
        "walletReferenceId": "B-123456789012345",
        "walletRegistrationId": "reg157ra710N1D",
        "walletType": "paypal"
      },
      "paymentToken": "pt::12345678901234567892",
      "isPreferred": false
    }
  ]
}

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

apiKeystringRequired

API Key of Connector

Request

ID of customer profile to retrieve

profileGuidstringOptional23-32 characters

customerIdentificationstringOptional1-36 characters

Response

Retrieve a customer profile

successbooleanOptional

profileExistsbooleanOptional

profileGuidstringOptional

customerIdentificationstringOptional

preferredMethodstringOptional

customerobjectOptional

paymentInstrumentslist of objectsOptional