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
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "CreditCardIds": [
        "f1d94a32-b4be-479b-9e47-a9fcb03d5196"
    ],
    "CustomerIds": [
        "5cbbd97d-5f19-4010-9abf-ab0400a3366a"
    ]
}
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
{
    "CreditCards": [
        {
            "CreatedUtc": "2018-05-24T13:45:29Z",
            "CustomerId": "a3c90426-43f2-4b53-8482-446dfc724bd2",
            "Expiration": "2020-11",
            "Format": "Physical",
            "Id": "f1d94a32-b4be-479b-9e47-a9fcb03d5196",
            "IsActive": true,
            "Kind": "Gateway",
            "ObfuscatedNumber": "************1111",
            "State": "Enabled",
            "Type": "Visa"
        }
    ]
}
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
string Credit card format​
required
Format of the credit card.
Kind
string Credit card kind​
required
Kind of the credit card.
State
string Credit card state​
required
State of the credit card.
Type
string 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
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "CreditCardId": "866d3f51-5b8b-4e8f-a3af-5b84768c522d",
    "Amount": {
        "GrossValue": 5,
        "Currency": "EUR"
    },
    "AccountingCategoryId": null,
    "Notes": null,
    "ReceiptIdentifier": null
}
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
​Amount value​
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
{
    "PaymentId": "98753f51-5b8b-4e8f-a3af-5b8476865983"
}
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
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "CustomerId": "e98995b0-140a-4208-bbeb-b77f2c43d6ee",
    "CreditCardData": {
        "StorageData": "190510170631533875",
        "Expiration": "2025-10"
    }
}
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
​Credit card data​
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
{
    "CreditCardId": "ee2209ce-71c6-4e3a-978f-aac700c82c7b"
}
Property
Type
Contract
Description
CreditCardId
string
required
Unique identifier of the Credit card.

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.

Property	Type	Contract	Description
CreditCards	array of Credit cards	required	The credit cards.

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`	string Credit card format	required	Format of the credit card.
`Kind`	string Credit card kind	required	Kind of the credit card.
`State`	string Credit card state	required	State of the credit card.
`Type`	string Credit card type	required	Type of the credit card.

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`	Amount value	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.

Property	Type	Contract	Description
PaymentId	string	required	Unique identifier of the Payment item.

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`	Credit card data	required	Credit card details provided by PCI provider.

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`.

Property	Type	Contract	Description
`CreditCardId`	string	required	Unique identifier of the Credit card.

Countries

Currencies

Last modified 5mo ago