Data Elements
| Key | Format | Condition | Description | |
|---|---|---|---|---|
| 1 | cardholderName | string | C | Presence depends on merchant configuration. Name of the cardholder as printed on the card. |
| 2 | number | string | C | Presence depends on merchant configuration. If present this element entails either the masked card number or Paygate card token. |
| 3 | expiryDate | string | C | Present if number entails Paygate card token. |
| 4 | bin | object | M | Bank Identification Number including account range if applicable. |
| 5 | brand | string | M | Card network name (e.g. 'Visa', 'MasterCard'). |
| 6 | product | string | C | Card product name (if available) (e.g. 'Business Premium Debit'). |
| 7 | source | string | C | Card funding source (if available). Values accepted:
|
| 8 | type | string | C | The card type specifies the program, application or card level attached to the card if any (e.g. Classic, Standard, Gold, Business etc.). |
| 9 | JSON | M | Country the card was issued in. | |
| 10 | issuer | string | C | Card issuer (if available). |
bin
| Key | Format | Condition | Description | |
|---|---|---|---|---|
| 1 | accountBIN | string | M | The leading six digits of the account number also known as bank identification number (BIN). |
| 2 | accountRangeLow | string | C | The account number at the low end of the account range. |
| 3 | accountRangeHigh | string | C | The account number at the high end of the account range. |
Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://www.computop-paygate.com/schemas/card_response.json",
"title": "card",
"description": "Card Information",
"type": "object",
"properties": {
"cardholderName": {
"type": "string",
"maxLength" : 50,
"minLength" : 1,
"description" : "The name of the cardholder as printed on the card."
},
"number": {
"type" : "string",
"maxLength" : 19,
"minLength" : 12
},
"expiryDate": {
"type": "string",
"description": "YYYYMM",
"minLength": 6,
"maxLength": 6
},
"bin": {
"type": "object",
"properties": {
"accountBin": { "type": "string" },
"accountRangeLow": { "type": "string" },
"accountRangeHigh": { "type": "string" }
},
"additionalProperties": false,
"required": ["accountBin"]
},
"brand": {
"type": "string",
"enum": [
"MasterCard",
"VISA",
"AMEX",
"Diners",
"CBN",
"JCB",
"Dankort",
"Maestro",
"Cartes Bancaires",
"DISCOVER",
"Bancontact",
"Hipercard",
"Elo",
"Aura",
"Carte 4Etoiles",
"AirPlus",
"CUP",
"NARANJA",
"SHOPPING",
"CABAL",
"ARGENCARD",
"CENCOSUD",
"KOOKMIN",
"KEB",
"BC",
"SHINHAN",
"SAMSUNG",
"HYUNDAI",
"LOTTE",
"1euro",
"echequevacances",
"cofidis3xcb",
"cofidis4xcb",
"facilypay-3x",
"facilypay-3xsansfrais",
"facilypay-4x",
"facilypay-4xsansfrais",
"RuPay"
]
},
"product": {
"type": "string"
},
"source": {
"type": "string",
"enum": ["DEBIT", "CREDIT", "DEFERRED DEBIT", "PREPAID", "CHARGE"]
},
"type": {
"type": "string"
},
"country": {
"type": "object",
"properties": {
"countryName": {
"type": "string",
"description": "Name of the country."
},
"countryA2": {
"type": "string",
"description": "ISO-3166 alpha-2 code."
},
"countryA3": {
"type": "string",
"description": "ISO 3166-1:2013 alpha-3"
},
"countryNumber": {
"type": "string",
"description": "ISO-3166 numeric code."
}
},
"required": ["countryA3"],
"additionalProperties": false
},
"issuer": {
"type": "string"
}
},
"required": ["bin", "brand", "country"],
"additionalProperties": false
}
Sample
{
"cardholderName": "John Doe",
"bin": {
"accountBin": "492947",
"accountRangeLow": "492947000000",
"accountRangeHigh": "492948387999"
},
"brand": "VISA",
"product": "Business",
"source": "CREDIT",
"type": "CLASSIC",
"country": {
"countryName": "United Kingdom of Great Britain and Northern Ireland",
"countryA2": "GB",
"countryA3": "GBR",
"countryNumber": "826"
},
"issuer": "BARCLAYS BANK PLC"
}