Skip to main content

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

    apiKey stringrequired

    API Key of Connector

Body

required

ID of customer profile to retrieve

    oneOf

    profileGuid stringrequired

    Customer id assigned by the payment platform.

    Possible values: >= 32 characters and <= 32 characters

    Example: CP-91ec-509a-3899-4f4f-a4ad-67fb

Responses​

Retrieve a customer profile

Schema

    success boolean

    true if successful.

    profileExists boolean

    true if customer profile exists. If false no other fields will be provided in the response.

    profileGuid string

    Customer id assigned by the payment platform.

    Example: CP-91ec-509a-3899-4f4f-a4ad-67fb
    customerIdentification string

    Customer id assigned by you.

    Example: my-id-620fa70b-cc34-4bbb-8d66-3670d3ea24f2
    preferredMethod string

    Preferred payment method.

    Example: Creditcard

    customer

    object

    _TYPE string
    billingAddress1 string

    Line one of the customer's billing address.

    billingAddress2 string

    Line two of the customer's billing address.

    billingCity string

    City of the customer's billing address.

    billingCountry string

    Country of the customer's billing address.

    ISO 3166-1 alpha-2 country code.

    billingPhone string

    Phone number of the billed customer.

    Example: +XX 1234567890
    billingPostcode string

    Postal code of the customer's billing address.

    billingState string

    State of the customer's billing address.

    birthDate string

    Birthdate of customer.

    RFC 3339 Internet Date/Time Format full-date.

    company string

    Company of the customer.

    email string

    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.

    property name* string
    firstName string

    First name of customer.

    Example: Alex
    gender string

    Gender of the customer.

    ipAddress string

    IPv4 or IPv6 address of the customer.

    Example: 198.51.100.123
    lastName string

    Last name of customer.

    Example: Smith
    nationalId string

    National id of the customer.

    property name* any

    paymentInstruments

    object[]

    Payment instruments stored for this customer profile.

  • Array [

    • _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)

    brand string

    Brand of the credit card.

    Example: visa
    cardHolder string

    Cardholder of the credit card.

    Example: Alex Smith
    expiryMonth int32

    Expiry month of the credit card.

    expiryYear int32

    Expiry year of the credit card.

    firstSixDigits string

    First six digits of the credit card.

    Example: 411111
    lastFourDigits string

    Last four digits of the credit card.

    Example: 1111
    property name* any

    Credit card payment data.

    createdAt string

    RFC 3339 Internet Date/Time Format date-time.

    method string

    Payment method of the payment instrument. Same as _TYPE.

    Example: card
    paymentToken string

    Token of the customer profile, can be used with the Transaction API to use the tokenized payment instrument.

    isPreferred boolean

    If a customer profile has multiple payment instruments stored, only one can be marked as preferred payment instrument.

  • ]

    • property name* any
Loading...
Last updated on