Credit cards
Get all credit cards
Returns all credit cards, possibly filtered by identifiers, Customers or other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/creditCards/getAll
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.
EnterpriseIds
array of string
optional, max 1000 items
CreditCardIds
array of string
optional, max 1000 items
CustomerIds
array of string
optional, max 1000 items
UpdatedUtc
optional, max length 3 months
Limitation
required
Limitation on the quantity of data returned.
Response
CreditCards
required
The credit cards.
Cursor
string
optional
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
Credit card
Id
string
required
Unique identifier of the credit card.
EnterpriseId
string
required
CustomerId
string
required
CreatedUtc
string
required
Creation date and time of the credit card in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update 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
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
ReservationId
string
optional
Unique identifier of the reservation the payment belongs to.
Amount
required
Amount of the credit card payment.
AccountingCategoryId
string
optional
ReceiptIdentifier
string
optional
Identifier of the payment receipt.
Notes
string
optional
Additional payment notes.
Response
PaymentId
string
required
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
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
CreditCardData
required
Credit card details provided by PCI provider.
Credit card data
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
string
required
Last updated