Skip to content

creditCards_getAllByCustomers

Deprecated
POST
/api/connector/v1/creditCards/getAllByCustomers
MultipleCustomerParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
CustomerIds
required

Unique identifier of the Customer.

Array<string>
>= 1 items <= 1000 items
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"CustomerIds": [
"e98995b0-140a-4208-bbeb-b77f2c43d6ee"
]
}

OK

CreditCardResult
object
CreditCards

The credit cards.

Array<object>
nullable
Credit card
object
Id
required

Unique identifier of the credit card.

string format: uuid
EnterpriseId

Unique identifier of the Enterprise.

string format: uuid
nullable
CustomerId
required

Unique identifier of the credit card owner.

string format: uuid
IsActive
required

Whether the credit card is still active.

boolean
State

State of the credit card.

string
nullable
Kind

Kind of the credit card.

string
nullable
Format

Format of the credit card.

string
nullable
Type

Type of the credit card.

string
nullable
ObfuscatedNumber

Obfuscated credit card number. At most first six digits and last four digits can be specified, otherwise the digits are replaced with *.

string
nullable
Expiration

Expiration of the credit card in format MM/YYYY.

string
nullable
CreatedUtc
required

Creation date and time of the credit card in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the credit card in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Cursor

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.

string format: uuid
nullable
Example
{
"CreditCards": [
{
"Id": "f1d94a32-b4be-479b-9e47-a9fcb03d5196",
"EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"CreatedUtc": "2023-10-01T11:48:57Z",
"UpdatedUtc": "2023-10-28T11:48:57Z",
"CustomerId": "a3c90426-43f2-4b53-8482-446dfc724bd2",
"Expiration": "2020-11",
"Format": "Physical",
"IsActive": true,
"Kind": "Gateway",
"ObfuscatedNumber": "************1111",
"State": "Enabled",
"Type": "Visa"
}
],
"Cursor": "f1d94a32-b4be-479b-9e47-a9fcb03d5196"
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable