Get profile
POST/:apiKey/getProfile
Retrieve a customer profile.
If successful and the profile with the given identification was found the profile data will be returned.
In case of the profile does not exist, you will receive a response stating this.
Request
Path Parameters
API Key of Connector
- application/json
Body
required
ID of customer profile to retrieve
- GetProfileRequestGuid
- GetProfileRequestCustomerIdentification
oneOf
Possible values: >= 32 characters
and <= 32 characters
Customer id assigned by the payment platform.
Possible values: non-empty
and <= 36 characters
Customer id assigned by you.
Responses
- 200
- default
Retrieve a customer profile
- application/json
- Schema
- Example (from schema)
- Successful profile retrieval
- Profile not found
Schema
Array [
- card
- iban
- wallet
- paymentData.card
- paymentData.iban
- paymentData.wallet
- paymentData.card
- paymentData.iban
- paymentData.wallet
- paymentData.card
- paymentData.iban
- paymentData.wallet
]
true
if successful.
true
if customer profile exists. If false
no other fields will be provided in the response.
Customer id assigned by the payment platform.
Customer id assigned by you.
Preferred payment method.
customer
object
Line one of the customer's billing address.
Line two of the customer's billing address.
City of the customer's billing address.
Country of the customer's billing address.
ISO 3166-1 alpha-2 country code.
Phone number of the billed customer.
Postal code of the customer's billing address.
State of the customer's billing address.
Birthdate of customer.
RFC 3339 Internet Date/Time Format full-date
.
Company of the customer.
E-mail address of the customer.
extraData
object
Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.
First name of customer.
Gender of the customer.
IPv4 or IPv6 address of the customer.
Last name of customer.
National id of the customer.
paymentInstruments
object[]
Payment instruments stored for this customer profile.
_TYPE
string
Possible values: [card
, iban
, wallet
]
paymentData
object
Credit card payment data.
_TYPE
string
Possible values: [paymentData.card
, paymentData.iban
, paymentData.wallet
]
circular(PaymentDataCard)
IBAN.
BIC.
Mandate id.
RFC 3339 Internet Date/Time Format date-time
.
UUID of the transaction that initially registered this wallet.
Brand of the credit card.
Cardholder of the credit card.
Expiry month of the credit card.
Expiry year of the credit card.
First six digits of the credit card.
Last four digits of the credit card.
Credit card payment data.
paymentData
object
IBAN payment data.
_TYPE
string
Possible values: [paymentData.card
, paymentData.iban
, paymentData.wallet
]
Brand of the credit card.
Cardholder of the credit card.
Expiry month of the credit card.
Expiry year of the credit card.
First six digits of the credit card.
Last four digits of the credit card.
circular(PaymentDataIban)
UUID of the transaction that initially registered this wallet.
IBAN.
BIC.
Mandate id.
RFC 3339 Internet Date/Time Format date-time
.
IBAN payment data.
paymentData
object
Wallet payment data.
_TYPE
string
Possible values: [paymentData.card
, paymentData.iban
, paymentData.wallet
]
Brand of the credit card.
Cardholder of the credit card.
Expiry month of the credit card.
Expiry year of the credit card.
First six digits of the credit card.
Last four digits of the credit card.
IBAN.
BIC.
Mandate id.
RFC 3339 Internet Date/Time Format date-time
.
circular(PaymentDataWallet)
UUID of the transaction that initially registered this wallet.
Wallet payment data.
RFC 3339 Internet Date/Time Format date-time
.
Payment method of the payment instrument. Same as _TYPE
.
Token of the customer profile, can be used with the Transaction API to use the tokenized payment instrument.
If a customer profile has multiple payment instruments stored, only one can be marked as preferred payment instrument.
{
"success": true,
"profileExists": true,
"profileGuid": "CP-91ec-509a-3899-4f4f-a4ad-67fb",
"customerIdentification": "my-id-620fa70b-cc34-4bbb-8d66-3670d3ea24f2",
"preferredMethod": "Creditcard",
"customer": {
"_TYPE": "string",
"billingAddress1": "string",
"billingAddress2": "string",
"billingCity": "string",
"billingCountry": "string",
"billingPhone": "+XX 1234567890",
"billingPostcode": "string",
"billingState": "string",
"birthDate": "string",
"company": "string",
"email": "string",
"extraData": {},
"firstName": "Alex",
"gender": "string",
"ipAddress": "198.51.100.123",
"lastName": "Smith",
"nationalId": "string"
},
"paymentInstruments": [
{
"_TYPE": "card",
"createdAt": "string",
"method": "card",
"paymentToken": "string",
"isPreferred": true
}
]
}
{
"success": true,
"profileExists": true,
"profileGuid": "CP-0000-0000-0000-0000-0000-0000",
"customerIdentification": "YOUR_CUSTOMER_ID",
"preferredMethod": "Creditcard",
"customer": {
"_TYPE": "customerData",
"billingAddress1": "123 Main St.",
"billingAddress2": "Apt. 4B",
"billingCity": "Anytown",
"billingCountry": "US",
"billingPhone": "+XX 1234567890",
"billingPostcode": "12345",
"billingState": "AN",
"birthDate": "1970-01-01",
"company": "Alex's Artisan Goods",
"email": "[email protected]",
"extraData": [],
"firstName": "Alex",
"gender": "M",
"ipAddress": "198.51.100.123",
"lastName": "Smith",
"nationalId": "COUNTRY-1234567-PLACEHOLDER"
},
"paymentInstruments": [
{
"_TYPE": "paymentInstrument",
"createdAt": "2018-10-25 12:52:27",
"method": "card",
"paymentData": {
"_TYPE": "paymentData.card",
"brand": "visa",
"cardHolder": "Alex Smith",
"expiryMonth": 6,
"expiryYear": 2027,
"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",
"walletReferenceId": "B-123456789012345",
"walletOwner": "[email protected]",
"walletType": "paypal",
"walletOwnerFirstName": "Alex",
"walletOwnerLastName": "Smith",
"walletOwnerCountryCode": "US",
"walletRegistrationId": "reg157ra710N1D"
},
"paymentToken": "pt::12345678901234567892",
"isPreferred": false
}
]
}
{
"success": false,
"profileExists": false,
"profileGuid": null,
"customerIdentification": null,
"preferredMethod": null,
"customer": null,
"paymentInstruments": []
}
Error response
- application/json
- Schema
- Example (from schema)
Schema
false
if error.
Error message.
While the errorMessage
field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances.
For consistent and reliable error handling in your application, always base your logic on the errorCode
field, not the errorMessage
.
Error code.
{
"success": true,
"errorMessage": "string",
"errorCode": 0
}