Skip to main content

Retrieve a customer

GET 
/v2/customers/:cus_id

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.

Request​

Path Parameters

    cus_id Cus Idrequired

Responses​

Successful Response

Schema

    object Object (string)

    The type of object, in this case charge

    id ID (string)

    A unique ID for this charge. usually starts with cus_, followed by an alphanumeric string.

    email Email (string)

    Customer's email

    mobile_number Mobile Number (string)

    Customer's mobile number

    description Description (string)

    Customer description.

    sources

    object[]

    required

    The customer’s payment sources, if any.

  • Array [

    • object Object (string)required

    String representing the object's type. Objects of the same type share the same value.

    id ID (string)required

    A unique ID for this source, usually starts with src_, followed by an alphanumeric string.

    type SourceTyperequired

    Possible values: [card, gcash, paymaya, wechat, alipay, unionpay, grabpay, instapay, qrph, bpi, unionbank, metrobank, bdo, pnb, rcbc]

    An enumeration.

    card

    object

    object Object (string)required

    String representing the object's type. Objects of the same type share the same value.

    id ID (string)required

    A unique ID for this card, usually starts with card_, followed by an alphanumeric string.

    name Name (string)required

    Full name of cardholder

    last4 Card Number (string)required

    The last 4 digits of the credit card number

    exp_month Expiry month (string)required

    Expiration month of the card.

    exp_year Expiry year (string)required

    Four-digit number expiration year of the card.

    address_line1 Address Line1 (string)
    address_line2 Address Line2 (string)
    address_city Address City (string)
    address_state Address State (string)
    address_country Address Country (string)
    address_zip Address Zip (string)
    brand Brand (string)required
    country Country (string)required
    cvc_checked Cvc Checked (string)required
    funding Funding (string)required
    issuing_bank Issuing Bank (string)required

    bank_account

    object

    reference_id Reference Id (string)required

    Reference Id we used in connecting to debit api

    bank_type Bank Type (string)required

    Token's bank type

    bank_code Bank Code (string)required

    Specific bank's code

    account_name Account name (string)required
    account_number Account number (string)required
    account_type Account type (string)required
    expires_at Expiration date (string)required
    metadata object

    redirect

    object

    success urirequired

    Possible values: non-empty and <= 2083 characters

    The URL where we redirect after successful payment.

    fail urirequired

    Possible values: non-empty and <= 2083 characters

    The URL where we redirect after failed payment.

    notify uri

    Possible values: non-empty and <= 2083 characters

    The URL where we will call repeatedly, until a proper response was received.

    owner

    object

    billing

    object

    name Name (string)required

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    Full name of account holder

    phone_number Phone Number (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    email email
    line1 Line 1 (string)

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    line2 Line 2 (string)

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    city City (string)

    Possible values: non-empty and <= 100 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    state State (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    country Country (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    zip_code Zip Code (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    shipping

    object

    name Name (string)required

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    Full name of account holder

    phone_number Phone Number (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    email email
    line1 Line 1 (string)

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    line2 Line 2 (string)

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    city City (string)

    Possible values: non-empty and <= 100 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    state State (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    country Country (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    zip_code Zip Code (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    name Name (string)

    Possible values: <= 50 characters

    Full name of account holder

    address_country Country (string)

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

    vaulted Vaulted (boolean)required

    Whether this source has been securely saved for later reuse.

    used Used (boolean)required

    Whether this source has already been used.

    livemode Live Mode (boolean)required

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    created_at Created Date (string)required

    Time at which the object was created in ISO 8601 format.

    updated_at Updated Date (string)required

    Time at which the object was updated in ISO 8601 format.

    metadata object

  • ]

    • livemode Live Mode (boolean)required

    Will be true if the secret key used was the live key, false if the test key was used

    created_at Created Date (string)

    Time at which the object was created in ISO 8601 format.

    updated_at Updated Date (string)

    Time at which the object was updated in ISO 8601 format.

    metadata object

    Default value: [object Object]

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Loading...