Connector API
Search…
Credit cards

Get all credit cards

Returns all credit cards, possibly filtered by identifiers, Customers or other filters.

Request

[PlatformAddress]/api/connector/v1/creditCards/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"CreditCardIds": [
6
"f1d94a32-b4be-479b-9e47-a9fcb03d5196"
7
],
8
"CustomerIds": [
9
"5cbbd97d-5f19-4010-9abf-ab0400a3366a"
10
]
11
}
Copied!
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
CreditCardIds
array of string
optional, max 1000 items
Unique identifiers of the Credit cards. Required if no other filter is provided.
CustomerIds
array of string
optional, max 1000 items
Unique identifiers of the Customers.

Response

1
{
2
"CreditCards": [
3
{
4
"CreatedUtc": "2018-05-24T13:45:29Z",
5
"CustomerId": "a3c90426-43f2-4b53-8482-446dfc724bd2",
6
"Expiration": "2020-11",
7
"Format": "Physical",
8
"Id": "f1d94a32-b4be-479b-9e47-a9fcb03d5196",
9
"IsActive": true,
10
"Kind": "Gateway",
11
"ObfuscatedNumber": "************1111",
12
"State": "Enabled",
13
"Type": "Visa"
14
}
15
]
16
}
Copied!
Property
Type
Contract
Description
CreditCards
array of Credit cards
required
The credit cards.

Credit card

Property
Type
Contract
Description
Id
string
required
Unique identifier of the credit card.
CustomerId
string
required
Unique identifier of the credit card owner.
CreatedUtc
string
required
Creation date and time of the credit card in UTC timezone in ISO 8601 format.
Expiration
string
optional
Expiration of the credit card in format MM/YYYY.
IsActive
boolean
required
Whether the credit card is still active.
ObfuscatedNumber
string
optinal
Obfuscated credit card number. At most first six digits and last four digits can be specified, otherwise the digits are replaced with *.
Format
required
Format of the credit card.
Kind
required
Kind of the credit card.
State
required
State of the credit card.
Type
required
Type of the credit card.

Credit card format

  • Physical
  • Virtual

Credit card kind

  • Terminal
  • Gateway

Credit card state

  • Enabled
  • Disabled

Credit card type

  • MasterCard, Visa, Amex, Maestro, Discover, VPay, ...

Charge credit card

Creates payment for specified customer credit card and charges the credit card via a gateway. Note that the kind of the card has to be Gateway.

Request

[PlatformAddress]/api/connector/v1/creditCards/charge
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"CreditCardId": "866d3f51-5b8b-4e8f-a3af-5b84768c522d",
6
"Amount": {
7
"GrossValue": 5,
8
"Currency": "EUR"
9
},
10
"AccountingCategoryId": null,
11
"Notes": null,
12
"ReceiptIdentifier": null
13
}
Copied!
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
CreditCardId
string
required
Unique identifier of the Credit card.
Amount
required
Amount of the credit card payment.
AccountingCategoryId
string
optional
Unique identifier of the Accounting category.
ReceiptIdentifier
string
optional
Identifier of the payment receipt.
Notes
string
optional
Additional payment notes.

Response

1
{
2
"PaymentId": "98753f51-5b8b-4e8f-a3af-5b8476865983"
3
}
Copied!
Property
Type
Contract
Description
PaymentId
string
required
Unique identifier of the Payment item.

Add tokenized credit card

Adds a new tokenized credit card to the specified customer. To be able to use this operation special permission has to be granted during certification.

Request

[PlatformAddress]/api/connector/v1/creditCards/addTokenized
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"CustomerId": "e98995b0-140a-4208-bbeb-b77f2c43d6ee",
6
"CreditCardData": {
7
"StorageData": "190510170631533875",
8
"Expiration": "2025-10"
9
}
10
}
Copied!
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
CustomerId
string
required
Unique identifier of the Customer.
CreditCardData
required
Credit card details provided by PCI provider.

Credit card data

Property
Type
Contract
Description
StorageData
string
required
Identifier of credit card data in PCI storage (transactionId).
Expiration
string
required
Expiration of the credit card in format yyyy-MM.

Response

1
{
2
"CreditCardId": "ee2209ce-71c6-4e3a-978f-aac700c82c7b"
3
}
Copied!
Property
Type
Contract
Description
CreditCardId
string
required
Unique identifier of the Credit card.