Merchant payments
This API allows you to provide detailed payment data to your customers. The API retrieves comprehensive payment data using specific criteria and periods of time.
Version note:
Please be aware that these API interfaces may be changed and improved (e.g. addition of fields).
The "Try out" feature does not work at this time because the sandbox is being improved to support new functionality.
Merchant payments
Merchant payments
This API allows you to provide detailed payment data to your customers. The API retrieves comprehensive payment data using specific criteria and periods of time.
Why use it?
Currently the merchant can only retrieve this payment data via a separate merchant portal. This API enables you to use certain criteria (e.g. paymentId, paymentReference, merchantHierarchyId, merchantId, contractId and iban) to call payments data.
USE CASE
Provide specific payment data on demand to your customer
A merchant would like to know what amount is funded on a particular date. The Payments API allows the merchant to search for a particular payment to its bank account using different criteria such as paymentId, data, amount, iban etc.
PaymentAmount is reconciliated at an aggregated level as TransactionTotalAmount minus the different fees categories. Using the TransactionLink in a particular payment the merchant can quickly move to the associated transactions.
Are you looking for more information?
Transactions
#version 2.0.2 (30-08-2023)
-Add new v2.1 Id list call, returns a list of transactions instead of 0/1 transaction
/v2.1/acquirers/{acquirerId}/transactions/{transactionId}
Note: In CNP the actionType CAPTURE_SPLIT can result in multiple cleared transactions with the same transactionId. In this unique case, please differentiate between transactions using the cleared transaction acquirerReferenceNumber and Capture request fields captureSequenceNumber, actionId.
-The status of the following v2.0 Id call has changed to deprecated, please use v2.1 call.
/v2.0/acquirers/{acquirerId}/transactions/{transactionId}
Note: The above deprecated v2.0 call will remain available temporarily (up to 31-10-2024) allowing clients 6 months to migrate from current v2.0 Id call to v2.1.
-Changes to search call (/v2.0/acquirers/{acquirerId}/transactions)
- Add query parameter actionId and pspReference
- Rename query parameter merchantTransactionRefNo to merchantReference (old one still available but deprecated)
-Add 5 new fields in a transaction response: captureSequenceNumber, captureSequenceCount, schemeMerchantId, schemeTransactionId, paymentInitiationChannel
-Changes in TransactionIdentification (part of Transaction, Authorization and Lifecycle):
- Rename field merchantTransactionReference to merchantReference (old field is deprecated, but still available up to 31-10-2024)
- Add field actionId, pspReference, retrievalReferenceNumber
-Changes in ContractIdentification (part of Transaction, Authorization and Lifecycle)
- Add field pspId
#version 2.0.1 (17-10-2022)
- Add 7 new fields to a transaction: result3ds, version3ds, cavv, xid, ucaf, mitCause, initiatorType
Version note:
Please be aware that these API interfaces may be changed and improved (e.g. addition of fields).
The "Try out" feature does not work at this time because the sandbox is being improved to support new functionality.
Generic Page test
Hero
Hero text
Card group title
Transactions
Transactions
This API allows you to provide detailed transaction data to your merchant customers. The API enables you to retrieves comprehensive transaction data based on merchant payments, contract entity and on specific periods of time.
Why use it?
Currently the merchant can only retrieve this transaction data via a separate merchant portal. This API enables you to use certain criteria (e.g. merchantId, transactionId and acquirerRefNo) to retrieve transactions data.
USE CASE
Provide specific transaction data on demand to your customer
Reconciliation for (sub-)merchants
As a PSP you would like to show the transactions of a merchant payment in your own Merchant portal to (sub-)merchants.
In the Merchant Payments API you can search for and identify a merchant payment (payout) to your sub-merchant.
In the Transactions API you can search and retrieve the transactions that MATCH with the merchant payment (payout) to your sub-merchant.
The (sub-)merchant can retrieve the transaction data from your portal and use it to reconcile card transactions with the merchant payment (payout) for his/her own administration.
Note: If the (sub-)merchant wants an extract it may be more convenient to search for and retrieve a Reconciliation Statement from the Statements API.
Are you looking for more information?
WL 1-Click Resources References
Resources | Resource Reference This reference act as a key for the resource |
Issuer External Reference This optional reference is used to ease API integration with clients |
Issuer | issuerId | - |
Product | productReference | issuerProductExternalReference |
Customer | customerReference | issuerCustomerExternalReference |
Address | addressReference | issuerAddressExternalReference |
Contract | contractReference | issuerContractExternalReference |
Card Contract | cardContractReference | issuerCardContractExternalReference |
Card | cardReference | issuerCardExternalReference |
Order | orderReference | - |
Account | accountReference | issuerAccountExternalReference |
Operation | operationId | - |
Authorization | transactionId | - |
Authorization Business Case | businessCaseId | - |
Temporary Credit Limit | temporaryCreditLimitReference | - |
Authorization Restriction | authorizationRestrictionReference | - |
Authorization Restriction Override | authorizationRestrictionOverrideReference | - |
Velocity Limit | velocityLimitReference | - |
Velocity Limit Override | velocityLimitOverrideReference | - |
Velocity Limit Override
A default Velocity Limit could be override by Velocity Limit Overrides
The Velocity Limit Override can be done for a specific period using the attributes activationStartTime
and activationEndTime
A Velocity Limit Override could change following attributes of the Velocity Limit
maximumAmount
: Allowed maximum cumulated authorization amountmaximumAmountCheck
: Switch indicating whether the cumulated authorization amount of the time period is compared to a maximum or notmaximumCount
: Allowed maximum number of authorizations in the time periodmaximumCountCheck
: Switch indicating whether the number of authorizations in the time period is compared to a maximum or not
In our solution each Authorization Restriction Override is identified by an velocityLimitOverrideReference
It is possible to use this reference in order to
- Retrieve velocity limit override using the API
GET /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}
- Update velocity limit override using the API
PUT
/issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}
- Delete velocity limit override using the API
DELETE
/issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}
All the Velocity Limit Overrides which are applied on a Velocity Limit can be retrieved by the API that List velocity limit overrides for velocity limit GET /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitsReference}/velocity-limits-overrides/
Velocity Limit
The purpose of a Velocity Limit is to limit a transaction in terms of amount and frequency, e.g. it might be allowed to withdraw 2,500€ per day on POS terminals in Europe
These rules are implemented with an initial customer specific Product setup and are set per default set as blocked or unblocked
The standard Velocity Limits are permanent and can be changed by creating some Velocity Limit Overrides
The standard Velocity Limits for Card Control are
- Cash (ATM, branch, POS)
- eCommerce
- POS
- NFC
Each standard Velocity Limits are set with
- a minimum amount and a flag, if this amount should be checked
- a maximum amount and a flag, if this amount should be checked
- a maximum counter and a flag, if this amount should be checked
A default velocity limit can further be combined with a country or a region, e.g.
- ATM daily limit in Italy
- ATM daily limit in the European Economic Area (w/o Italy)
- ATM daily limit worldwide (w/o the EEA)
When an account is created, the default Velocity Limits defined on Product level are applied
In order to List velocity limits for account, the API GET /issuers/{issuerId}/accounts/{accountReference}/velocity-limits
should be used by providing the issuerId
of the Issuer and accountReference
identifying the Account
In our solution each Velocity Limit is identified by an velocityLimitReference
and it's possible to Retrieve velocity limit using GET /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}
API