Card Transactions
Card Transaction Types
- Payment
- Refund
- Chargeback
- ATM Withdrawal
- Money Transfer
Card Transaction Statuses
- Authorised
- Settled
- Reversed
- Declined
Get a Card Transaction
GET /card-transactions/{cardTransactionId}
{
"workflow": {},
"data": {
"cardTransaction": {
"id": "9fbdfd66-0d1d-47d8-9e29-7c2c38abba8e",
"cardId": "491c55ac-21ac-4e8a-bac6-ac9ef2b40c31",
"clientId": "aa5e7c73-3bcf-4698-8619-9377915d6a96",
"matchingTransactionId": null,
"accountId": "28e423eb-04d4-4e07-8e4f-5614ffe5a6ae",
"accountCurrency": "EUR",
"transactionNumber": "20210301-ABC123",
"type": "payment",
"status": "settled",
"transactionAmount": 100.00,
"transactionCurrency": "EUR",
"feeAmount": 10.00,
"feeCurrency": "EUR",
"billingAmount": 1.00,
"billingCurrency": "EUR",
"settlementAmount": 100.00,
"settlementCurrency": "EUR",
"effectiveTransactionAmount": 100.00,
"effectiveFeeAmount": 10.00,
"transactionExchangeRate": null,
"feeExchangeRate": null,
"merchant": {
"name": "Commuter Transport",
"id": "merchantId",
"networkId": "networkId",
"taxId": "taxId",
"address": {
"country": "GB",
"postalCode": "N42 0TO",
"city": "London",
"street": "26 Station Road"
},
"phone": "+44 20 7946 0350",
"website": "website",
"category": {
"code": "4111",
"description": "Commuter Transport, Ferries"
}
},
"pos": {
"cardholderPresent": null,
"cardPresent": null,
"cardDataInputMethod": null,
"authentication": null,
"chipFallback": null,
"fraud": null,
"securityProtocol": null,
"cardAuthentication3DSecureMethod": "oob-biometric"
},
"serviceProvider": "THD",
"serviceProviderEntityId": "00000000-0000-0000-0000-000000000000",
"serviceProviderEntityReference": "reference",
"description": "description",
"reason": "reason",
"direction": "debit",
"totalAmount": 110.00,
"creationDateTime": "2024-03-01T10:00:00"
}
},
"connect": {},
"metadata": {}
}
List Card Transactions
GET /card-transactions
Supported query parameters:
| parameter | description |
|---|---|
| metadata.page.number | 0-indexed, default=0 |
| metadata.page.size | default=10 |
| data.cardTransaction.cardId | ID of the card |
| data.cardTransaction.clientId | ID of the client |
| data.cardTransaction.accountId | ID of the account |
| data.cardTransaction.type | payment, refund, chargeback, atm-withdrawal, money-transfer |
| data.cardTransaction.status | authorised, settled, reversed, declined |
| data.cardTransaction.transactionNumber | transaction number |
| data.cardTransaction.transactionCurrency | transaction currency |
| data.cardTransaction.description | transaction description |
| data.cardTransaction.reason | transaction reason |
| data.cardTransaction.maxAmount | |
| data.cardTransaction.minAmount | |
| data.cardTransaction.creationDateFrom | |
| data.cardTransaction.creationDateTo | |
| data.cardTransaction.serviceProvider | service provider of the card transaction |
| data.cardTransaction.serviceProviderId | service provider ID of the card transaction |
| data.cardTransaction.serviceProviderReference | service provider reference of the card transaction |
{
"workflow": {},
"data": {
"cardTransactions": [
{
"id": "9fbdfd66-0d1d-47d8-9e29-7c2c38abba8e",
"cardId": "491c55ac-21ac-4e8a-bac6-ac9ef2b40c31",
"clientId": "aa5e7c73-3bcf-4698-8619-9377915d6a96",
"matchingTransactionId": null,
"accountId": "28e423eb-04d4-4e07-8e4f-5614ffe5a6ae",
"accountCurrency": "EUR",
"transactionNumber": "20240301-ABC123",
"type": "payment",
"status": "settled",
"transactionAmount": 100.00,
"transactionCurrency": "EUR",
"feeAmount": 10.00,
"feeCurrency": "EUR",
"billingAmount": 1.00,
"billingCurrency": "EUR",
"settlementAmount": 100.00,
"settlementCurrency": "EUR",
"effectiveTransactionAmount": 100.00,
"effectiveFeeAmount": 10.00,
"transactionExchangeRate": null,
"feeExchangeRate": null,
"merchant": {
"name": "Commuter Transport",
"id": "merchantId",
"networkId": "networkId",
"taxId": "taxId",
"address": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
},
"phone": "+441234567890",
"website": "[email protected]",
"category": {
"code": "4111",
"description": "Commuter Transport, Ferries"
}
},
"pos": {
"cardholderPresent": null,
"cardPresent": null,
"cardDataInputMethod": null,
"authentication": null,
"chipFallback": null,
"fraud": null,
"securityProtocol": null,
"cardAuthentication3DSecureMethod": "oob-biometric"
},
"serviceProvider": "THD",
"serviceProviderEntityId": "00000000-0000-0000-0000-000000000000",
"serviceProviderEntityReference": "reference",
"description": "description",
"reason": "reason",
"direction": "debit",
"totalAmount": 110.00,
"creationDateTime": "2024-03-01T10:00:00"
},
{
"id": "522e2cd8-734b-4631-9180-fc35057c449a",
"cardId": "491c55ac-21ac-4e8a-bac6-ac9ef2b40c31",
"clientId": "aa5e7c73-3bcf-4698-8619-9377915d6a96",
"matchingTransactionId": null,
"accountId": "28e423eb-04d4-4e07-8e4f-5614ffe5a6ae",
"accountCurrency": "EUR",
"transactionNumber": "20240101-ABC123",
"type": "payment",
"status": "authorised",
"transactionAmount": 100.00,
"transactionCurrency": "EUR",
"feeAmount": 10.00,
"feeCurrency": "EUR",
"billingAmount": 1.00,
"billingCurrency": "EUR",
"settlementAmount": 100.00,
"settlementCurrency": "EUR",
"effectiveTransactionAmount": 100.00,
"effectiveFeeAmount": 10.00,
"transactionExchangeRate": null,
"feeExchangeRate": null,
"merchant": {
"name": "FORUM HOTELS",
"id": "merchantId",
"networkId": "networkId",
"taxId": "taxıd",
"address": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
},
"phone": "+441234567890",
"website": "[email protected]",
"category": {
"code": "3570",
"description": "FORUM HOTELS"
}
},
"pos": {
"cardholderPresent": null,
"cardPresent": null,
"cardDataInputMethod": null,
"authentication": null,
"chipFallback": null,
"fraud": null,
"securityProtocol": null,
"cardAuthentication3DSecureMethod": "no-authentication"
},
"serviceProvider": "THD",
"serviceProviderEntityId": "00000000-0000-0000-0000-000000000000",
"serviceProviderEntityReference": "reference",
"description": "description",
"reason": "reason",
"direction": "debit",
"totalAmount": 110.00,
"creationDateTime": "2024-01-01T10:00:00"
}
]
},
"connect": {},
"metadata": {
"page": {
"size": 20,
"number": 0,
"totalElements": 5,
"totalPages": 1
}
}
}
Webhooks
Webhook types:
- card-transaction-created
- card-transaction-settled
- card-transaction-reversed
- card-transaction-authorisation-updated
- card-transaction-declined
{
"webhook": {
"module": "card-transactions",
"type": "card-transaction-created"
},
"data": {
"cardTransaction": {
"id": "522e2cd8-734b-4631-9180-fc35057c449a",
"cardId": "491c55ac-21ac-4e8a-bac6-ac9ef2b40c31",
"clientId": "aa5e7c73-3bcf-4698-8619-9377915d6a96",
"matchingTransactionId": null,
"accountId": "28e423eb-04d4-4e07-8e4f-5614ffe5a6ae",
"accountCurrency": "EUR",
"transactionNumber": "20240101-ABC123",
"type": "payment",
"status": "authorised",
"transactionAmount": 100.00,
"transactionCurrency": "EUR",
"feeAmount": 10.00,
"feeCurrency": "EUR",
"billingAmount": 1.00,
"billingCurrency": "EUR",
"settlementAmount": 100.00,
"settlementCurrency": "EUR",
"effectiveTransactionAmount": 100.00,
"effectiveFeeAmount": 10.00,
"transactionExchangeRate": null,
"feeExchangeRate": null,
"merchant": {
"name": "FORUM HOTELS",
"id": "merchantId",
"networkId": "networkId",
"taxId": "taxıd",
"address": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
},
"phone": "+441234567890",
"website": "[email protected]",
"category": {
"code": "3570",
"description": "FORUM HOTELS"
}
},
"pos": {
"cardholderPresent": null,
"cardPresent": null,
"cardDataInputMethod": null,
"authentication": null,
"chipFallback": null,
"fraud": null,
"securityProtocol": null,
"cardAuthentication3DSecureMethod": "no-authentication"
},
"serviceProvider": "THD",
"serviceProviderEntityId": "00000000-0000-0000-0000-000000000000",
"serviceProviderEntityReference": "reference",
"description": "description",
"reason": "reason",
"direction": "debit",
"totalAmount": 110.00,
"creationDateTime": "2024-01-01T10:00:00"
}
},
"connect": {},
"metadata": {}
}
{
"webhook": {
"module": "card-transactions",
"type": "card-transaction-settled"
},
"data": {
"cardTransaction": {
"id": "522e2cd8-734b-4631-9180-fc35057c449a",
"cardId": "491c55ac-21ac-4e8a-bac6-ac9ef2b40c31",
"clientId": "aa5e7c73-3bcf-4698-8619-9377915d6a96",
"matchingTransactionId": null,
"accountId": "28e423eb-04d4-4e07-8e4f-5614ffe5a6ae",
"accountCurrency": "EUR",
"transactionNumber": "20240101-ABC123",
"type": "payment",
"status": "settled",
"transactionAmount": 100.00,
"transactionCurrency": "EUR",
"feeAmount": 10.00,
"feeCurrency": "EUR",
"billingAmount": 1.00,
"billingCurrency": "EUR",
"settlementAmount": 100.00,
"settlementCurrency": "EUR",
"effectiveTransactionAmount": 100.00,
"effectiveFeeAmount": 10.00,
"transactionExchangeRate": null,
"feeExchangeRate": null,
"merchant": {
"name": "FORUM HOTELS",
"id": "merchantId",
"networkId": "networkId",
"taxId": "taxıd",
"address": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
},
"phone": "+441234567890",
"website": "[email protected]",
"category": {
"code": "3570",
"description": "FORUM HOTELS"
}
},
"pos": {
"cardholderPresent": null,
"cardPresent": null,
"cardDataInputMethod": null,
"authentication": null,
"chipFallback": null,
"fraud": null,
"securityProtocol": null,
"cardAuthentication3DSecureMethod": "no-authentication"
},
"serviceProvider": "THD",
"serviceProviderEntityId": "00000000-0000-0000-0000-000000000000",
"serviceProviderEntityReference": "reference",
"description": "description",
"reason": "reason",
"direction": "debit",
"totalAmount": 110.00,
"creationDateTime": "2024-01-01T10:00:00"
}
},
"connect": {},
"metadata": {}
}
{
"webhook": {
"module": "card-transactions",
"type": "card-transaction-reversed"
},
"data": {
"cardTransaction": {
"id": "522e2cd8-734b-4631-9180-fc35057c449a",
"cardId": "491c55ac-21ac-4e8a-bac6-ac9ef2b40c31",
"clientId": "aa5e7c73-3bcf-4698-8619-9377915d6a96",
"matchingTransactionId": null,
"accountId": "28e423eb-04d4-4e07-8e4f-5614ffe5a6ae",
"accountCurrency": "EUR",
"transactionNumber": "20240101-ABC123",
"type": "payment",
"status": "reversed",
"transactionAmount": 100.00,
"transactionCurrency": "EUR",
"feeAmount": 10.00,
"feeCurrency": "EUR",
"billingAmount": 1.00,
"billingCurrency": "EUR",
"settlementAmount": 100.00,
"settlementCurrency": "EUR",
"effectiveTransactionAmount": 100.00,
"effectiveFeeAmount": 10.00,
"transactionExchangeRate": null,
"feeExchangeRate": null,
"merchant": {
"name": "FORUM HOTELS",
"id": "merchantId",
"networkId": "networkId",
"taxId": "taxıd",
"address": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
},
"phone": "+441234567890",
"website": "[email protected]",
"category": {
"code": "3570",
"description": "FORUM HOTELS"
}
},
"pos": {
"cardholderPresent": null,
"cardPresent": null,
"cardDataInputMethod": null,
"authentication": null,
"chipFallback": null,
"fraud": null,
"securityProtocol": null,
"cardAuthentication3DSecureMethod": "no-authentication"
},
"serviceProvider": "THD",
"serviceProviderEntityId": "00000000-0000-0000-0000-000000000000",
"serviceProviderEntityReference": "reference",
"description": "description",
"reason": "reason",
"direction": "debit",
"totalAmount": 110.00,
"creationDateTime": "2024-01-01T10:00:00"
}
},
"connect": {},
"metadata": {}
}
{
"webhook": {
"module": "card-transactions",
"type": "card-transaction-authorisation-updated"
},
"data": {
"cardTransaction": {
"id": "522e2cd8-734b-4631-9180-fc35057c449a",
"cardId": "491c55ac-21ac-4e8a-bac6-ac9ef2b40c31",
"clientId": "aa5e7c73-3bcf-4698-8619-9377915d6a96",
"matchingTransactionId": null,
"accountId": "28e423eb-04d4-4e07-8e4f-5614ffe5a6ae",
"accountCurrency": "EUR",
"transactionNumber": "20240101-ABC123",
"type": "payment",
"status": "authorised",
"transactionAmount": 100.00,
"transactionCurrency": "EUR",
"feeAmount": 10.00,
"feeCurrency": "EUR",
"billingAmount": 1.00,
"billingCurrency": "EUR",
"settlementAmount": 100.00,
"settlementCurrency": "EUR",
"effectiveTransactionAmount": 100.00,
"effectiveFeeAmount": 10.00,
"transactionExchangeRate": null,
"feeExchangeRate": null,
"merchant": {
"name": "FORUM HOTELS",
"id": "merchantId",
"networkId": "networkId",
"taxId": "taxıd",
"address": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
},
"phone": "+441234567890",
"website": "[email protected]",
"category": {
"code": "3570",
"description": "FORUM HOTELS"
}
},
"pos": {
"cardholderPresent": null,
"cardPresent": null,
"cardDataInputMethod": null,
"authentication": null,
"chipFallback": null,
"fraud": null,
"securityProtocol": null,
"cardAuthentication3DSecureMethod": "no-authentication"
},
"serviceProvider": "THD",
"serviceProviderEntityId": "00000000-0000-0000-0000-000000000000",
"serviceProviderEntityReference": "reference",
"description": "description",
"reason": "reason",
"direction": "debit",
"totalAmount": 110.00,
"creationDateTime": "2024-01-01T10:00:00"
}
},
"connect": {},
"metadata": {}
}
{
"webhook": {
"module": "card-transactions",
"type": "card-transaction-declined"
},
"data": {
"cardTransaction": {
"id": "522e2cd8-734b-4631-9180-fc35057c449a",
"cardId": "491c55ac-21ac-4e8a-bac6-ac9ef2b40c31",
"clientId": "aa5e7c73-3bcf-4698-8619-9377915d6a96",
"matchingTransactionId": null,
"accountId": "28e423eb-04d4-4e07-8e4f-5614ffe5a6ae",
"accountCurrency": "EUR",
"transactionNumber": "20240101-ABC123",
"type": "payment",
"status": "declined",
"transactionAmount": 100.00,
"transactionCurrency": "EUR",
"feeAmount": 10.00,
"feeCurrency": "EUR",
"billingAmount": 1.00,
"billingCurrency": "EUR",
"settlementAmount": 100.00,
"settlementCurrency": "EUR",
"effectiveTransactionAmount": 100.00,
"effectiveFeeAmount": 10.00,
"transactionExchangeRate": null,
"feeExchangeRate": null,
"merchant": {
"name": "FORUM HOTELS",
"id": "merchantId",
"networkId": "networkId",
"taxId": "taxıd",
"address": {
"country": "GB",
"region": "England",
"city": "London",
"street": "Baker Street",
"houseNumber": "221B",
"postalCode": "XYZ ABC",
"refinement": ""
},
"phone": "+441234567890",
"website": "[email protected]",
"category": {
"code": "3570",
"description": "FORUM HOTELS"
}
},
"pos": {
"cardholderPresent": null,
"cardPresent": null,
"cardDataInputMethod": null,
"authentication": null,
"chipFallback": null,
"fraud": null,
"securityProtocol": null,
"cardAuthentication3DSecureMethod": "no-authentication"
},
"serviceProvider": "THD",
"serviceProviderEntityId": "00000000-0000-0000-0000-000000000000",
"serviceProviderEntityReference": "reference",
"description": "description",
"reason": "reason",
"direction": "debit",
"totalAmount": 110.00,
"creationDateTime": "2024-01-01T10:00:00"
}
},
"connect": {},
"metadata": {}
}
Updated 27 days ago