[go: up one dir, main page]
Retrieve a customer
Developer Documents‣Customers‣Retrieve a customer

Use this request for on-demand customer and payment method information.

Customer by Merchant ReferenceCustomer by Customer IDList Customer Payment MethodsShow Payment Method
API Examples
Get Customer by Merchant Reference

GET /acceptor/rest/customers/{instId}/byRef?merchantRef={merchantCustomerReference}
{}

HTTP/1.1 200
{
  "merchantRef": "mer_cust_131241412",
  "id": "10500",
  "displayName": "Mr O Whatasillyname",
  "billingAddress": {
    "line1": "Flat 1 ",
    "line2": "Cauldron house",
    "city": "Bath",
    "region": "Somerset",
    "postcode": "BA1 234",
    "country": "United Kingdom",
    "countryCode": "GBR"
  },
  "email": "test@test.com",
  "telephone": "0123 456 789",
  "defaultCurrency": "GBP",
  "link": [
    {
      "rel": "self",
      "href": "https://api.mite.pay360.com/acceptor/rest/customers/1009/10500"
    },
    {
      "rel": "payment-methods",
      "href": "https://api.mite.pay360.com/acceptor/rest/customers/1009/10500/paymentMethods"
    }
  ]
}
API Endpoint
endpoint: /acceptor/rest/customers/{instId}/byRef
method: GET
summary: find Customer By Merchant Ref

parameters:

Name
Data Type
Description
instId
string
The installation id
merchantRef
string
merchant Ref
response:
{
id string
Our ID for the Customer that is registered with us.
email string
Email address for the Customer.
merchantRef string
Your reference for the Customer.
defaultCurrency string
The Customer’s default currency.
dob string
Date of birth for the Customer.
billingAddress { The address of the Customer.
line1 string
Line 1 of the Customer’s address.
line2 string
Line 2 of the Customer’s address.
line3 string
Line 3 of the Customer’s address.
line4 string
Line 4 of the Customer’s address.
city string
City of the Customer’s address.
region string
Region of the Customer’s address.
postcode string
Post Code of the Customer’s address.
country string
Country name of the Customer’s address.
countryCode string
The 3 character ISO-3166-1 code for the Customer’s address country.
}
displayName string
The Customer’s name.
telephone string
Telephone number for the Customer.
}
API Examples
Get Customer by Customer ID

GET /acceptor/rest/customers/{instId}/{custId}
{}

HTTP/1.1 200
{
  "merchantRef": "mer_cust_131241412",
  "id": "10500",
  "displayName": "Mr O Whatasillyname",
  "billingAddress": {
    "line1": "Flat 1 ",
    "line2": "Cauldron house",
    "city": "Bath",
    "region": "Somerset",
    "postcode": "BA1 234",
    "country": "United Kingdom",
    "countryCode": "GBR"
  },
  "email": "test@test.com",
  "telephone": "0123 456 789",
  "defaultCurrency": "GBP",
  "link": [
    {
      "rel": "self",
      "href": "https://api.mite.pay360.com/acceptor/rest/customers/1009/10500"
    },
    {
      "rel": "payment-methods",
      "href": "https://api.mite.pay360.com/acceptor/rest/customers/1009/10500/paymentMethods"
    }
  ]
}
API Endpoint
endpoint: /acceptor/rest/customers/{instId}/{customerId}
method: GET
summary: show Customer

parameters:

Name
Data Type
Description
instId
string
The installation id
customerId
string
The customer id
response:
{
id string
Our ID for the Customer that is registered with us.
email string
Email address for the Customer.
merchantRef string
Your reference for the Customer.
defaultCurrency string
The Customer’s default currency.
dob string
Date of birth for the Customer.
billingAddress { The address of the Customer.
line1 string
Line 1 of the Customer’s address.
line2 string
Line 2 of the Customer’s address.
line3 string
Line 3 of the Customer’s address.
line4 string
Line 4 of the Customer’s address.
city string
City of the Customer’s address.
region string
Region of the Customer’s address.
postcode string
Post Code of the Customer’s address.
country string
Country name of the Customer’s address.
countryCode string
The 3 character ISO-3166-1 code for the Customer’s address country.
}
displayName string
The Customer’s name.
telephone string
Telephone number for the Customer.
}
API Examples
List Customer Payment Methods

GET  /acceptor/rest/customers/{instId}/{custId}/paymentMethods
{}

HTTP/1.1 200
[
  {
    "billingAddress": {
      "city": "Bath",
      "country": "United Kingdom",
      "countryCode": "GBR",
      "line1": "Flat 3 ",
      "line2": "Cauldron house",
      "line3": "A Street",
      "line4": "Twertonia",
      "name": null,
      "postcode": "BA1 234",
      "region": "Somerset"
    },
    "card": {
      "cardHolderName": "John Smith",
      "cardNickname": "My Card",
      "cardToken": "yBuwboU0QTexB7AcNeQIfA",
      "cardType": "VISA_DEBIT",
      "cardUsageType": "DEBIT",
      "cardScheme": "VISA",
      "expiryDate": "0215",
      "issueNumber": null,
      "issuer": "Lloyds",
      "issuerCountry": "GBR",
      "maskedPan": "100035******0007",
      "validDate": "1212"
    },
    "isPrimary": false,
    "link": [
      {
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/1/paymentMethods/yBuwboU0QTexB7AcNeQIfA",
        "rel": "self"
      },
      {
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/1/paymentMethod/yBuwboU0QTexB7AcNeQIfA/remove",
        "rel": "remove"
      },
      {
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/1",
        "rel": "customer"
      },
      {
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/1/paymentMethods/yBuwboU0QTexB7AcNeQIfA/update",
        "rel": "update"
      },
      {
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/1/paymentMethod/yBuwboU0QTexB7AcNeQIfA/makeDefault",
        "rel": "make-primary"
      }
    ],
    "paymentClass": "CARD"
  },
  {
    "billingAddress": {
      "city": "Bath",
      "country": "United Kingdom",
      "countryCode": "GBR",
      "line1": "Flat 4 ",
      "line2": "Cauldron house",
      "line3": "A Street",
      "line4": "Twertonia",
      "name": null,
      "postcode": "BA1 234",
      "region": "Somerset"
    },
    "card": {
      "cardHolderName": "John Smith",
      "cardNickname": "John",
      "cardToken": "MT_lBWm_3wITvmm5b7sjCaSiA",
      "cardType": "MC_DEBIT",
      "cardUsageType": "DEBIT",
      "cardScheme": "VISA",
      "expiryDate": "0115",
      "issueNumber": "1112",
      "issuer": "Lloyds",
      "issuerCountry": "GBR",
      "maskedPan": "544157******0008",
      "validDate": "1111"
    },
    "isPrimary": true,
    "link": [
      {
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/1/paymentMethods/MT_lBWm_3wITvmm5b7sjCaSiA",
        "rel": "self"
      },
      {
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/1/paymentMethod/MT_lBWm_3wITvmm5b7sjCaSiA/remove",
        "rel": "remove"
      },
      {
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/1",
        "rel": "customer"
      },
      {
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/1/paymentMethods/MT_lBWm_3wITvmm5b7sjCaSiA/update",
        "rel": "update"
      },
      {
        "href": "https://api.mite.pay360.com/acceptor/rest/manage/1009/customers/1/paymentMethod/MT_lBWm_3wITvmm5b7sjCaSiA/makeDefault",
        "rel": "make-primary"
      }
    ],
    "paymentClass": "CARD"
  }
]
API Endpoint
endpoint: /acceptor/rest/customers/{instId}/{customerId}/paymentMethods
method: GET
summary: list Payment Methods

parameters:

Name
Data Type
Description
instId
string
The installation id
customerId
string
The customer id
response:
[ array
{
paymentClass string
The classification of payment method used. Eg. Card, Cash, PayPal
isPrimary boolean
Indicates if this was Customer’s primary registered payment method.
card {
issueNumber string
The issue number of the card used in the request.
cardToken string
The token for the card.
cardHolderName string
The Cardholder’s name.
issuer string
The Issuer of the card.
maskedPan string
The masked card number. eg. 123456******1234
issuerCountry string
The country of the card Issuer.
expiryDate string
The expiry date of the card. Formatted as MMYY.
validDate string
The valid from date of the card. Formatted as MMYY.
cardType string
The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
cardUsageType string
The usage type of card. Eg. DEBIT, CREDIT.
cardScheme string
The scheme of card. Eg. VISA, MASTERCARD, AMEX.
cardCategory string
The category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS.
cardNickname string
The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
}
billingAddress { The billing address of the Customer. Will be used for AVS checks.
line1 string
Line 1 of the Customer’s billing address.
line2 string
Line 2 of the Customer’s billing address.
line3 string
Line 3 of the Customer’s billing address.
line4 string
Line 4 of the Customer’s billing address.
city string
City of the Customer’s billing address.
region string
Region of the Customer’s billing address.
postcode string
Post Code of the Customer’s billing address.
country string
Country name of the Customer’s billing address.
countryCode string
The 3 character ISO-3166-1 code for the Customer’s billing address country.
}
}
]
API Examples
Show Payment Method

GET /acceptor/rest/customers/{instId}/{custId}/paymentMethods/MT_hkuJIGioTy-4T_9hhNTzGw
{}

HTTP/1.1 200
{
  "paymentClass": "CARD",
  "card": {
    "cardToken": "MT_hkuJIGioTy-4T_9hhNTzGw",
    "cardType": "VISA_DEBIT",
    "cardUsageType": "DEBIT",
    "cardScheme": "VISA",
    "maskedPan": "100035******0007",
    "expiryDate": "0315",
    "issuer": "DATACASH",
    "issuerCountry": "GBR",
    "cardHolderName": "John Smith",
    "cardNickname": "John",
    "validDate": "1111"
  },
  "isPrimary": true,
  "billingAddress": {
    "line1": "Flat 1 ",
    "line2": "Cauldron house",
    "line3": "A Street",
    "line4": "Twertonia",
    "city": "Bath",
    "region": "Somerset",
    "postcode": "BA1 234",
    "country": "United Kingdom",
    "countryCode": "GBR"
  },
  "link": [
    {
      "rel": "self",
      "href": "https://api.mite.pay360.com/acceptor/rest/customers/1009/10500/paymentMethods/MT_hkuJIGioTy-4T_9hhNTzGw"
    },
    {
      "rel": "remove",
      "href": "https://api.mite.pay360.com/acceptor/rest/customers/1009/10500/paymentMethod/MT_hkuJIGioTy-4T_9hhNTzGw/remove"
    },
    {
      "rel": "customer",
      "href": "https://api.mite.pay360.com/acceptor/rest/customers/1009/10500"
    },
    {
      "rel": "update",
      "href": "https://api.mite.pay360.com/acceptor/rest/customers/1009/10500/paymentMethods/MT_hkuJIGioTy-4T_9hhNTzGw/update"
    },
    {
      "rel": "make-primary",
      "href": "https://api.mite.pay360.com/acceptor/rest/customers/1009/10500/paymentMethod/MT_hkuJIGioTy-4T_9hhNTzGw/makeDefault"
    }
  ]
}
API Endpoint
endpoint: /acceptor/rest/customers/{instId}/{customerId}/paymentMethods/{token}
method: GET
summary: show Payment Method

parameters:

Name
Data Type
Description
instId
string
The installation id
customerId
string
The customer id
token
string
token
response:
{

paymentClass string
The classification of payment method used. Eg. Card, Cash, PayPal
isPrimary boolean
Indicates if this was Customer’s primary registered payment method.
card {
issueNumber string
The issue number of the card used in the request.
cardToken string
The token for the card.
cardHolderName string
The Cardholder’s name.
issuer string
The Issuer of the card.
maskedPan string
The masked card number. eg. 123456******1234
issuerCountry string
The country of the card Issuer.
expiryDate string
The expiry date of the card. Formatted as MMYY.
validDate string
The valid from date of the card. Formatted as MMYY.
cardType string
The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
cardUsageType string
The usage type of card. Eg. DEBIT, CREDIT.
cardScheme string
The scheme of card. Eg. VISA, MASTERCARD, AMEX.
cardCategory string
The category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS.
cardNickname string
The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
}
billingAddress { The billing address of the Customer. Will be used for AVS checks.
line1 string
Line 1 of the Customer’s billing address.
line2 string
Line 2 of the Customer’s billing address.
line3 string
Line 3 of the Customer’s billing address.
line4 string
Line 4 of the Customer’s billing address.
city string
City of the Customer’s billing address.
region string
Region of the Customer’s billing address.
postcode string
Post Code of the Customer’s billing address.
country string
Country name of the Customer’s billing address.
countryCode string
The 3 character ISO-3166-1 code for the Customer’s billing address country.
}
}