Authorisation Control Webhook
Outgoing authorisation control webhook endpoint
Payment API
Account Details
- Overview
- Create an account
- Update an account
- Get account information
Authorisation Control
- Overview
- Authorisation Control Webhook
Authorisation Forwarding
- Overview
- Forward authorisation webhook
Card details
- Overview
- Create card
- Update card
- Get application
- Update application
- Get card
- Get plastic
- Get EMV scripts
- Update plastic
Customer
- Overview
- Get customer information
- Create a customer
- Update a customer
- Customer hierarchy
Exchange Rates API
- Overview
- Get ECB exchange rate
- Get ECB supported currencies
- Get FX exchange rates
ID
- Overview
- Initiate 3rd party authentication flow
- Callback to complete authentication flow
Instalment
- Overview
- Instalment Operations
Invoice
- Overview
- Get invoice information
- Update an invoice
Notification
- Overview
- Receive a notification
PIN
- Overview
- PIN operations with pre-shared key
- PIN operations using PKI
PIN Control
- Overview
- PIN Control handling
Purchase Details
- Overview
- Trigger repricing
- Get purchase details
- Create purchase details
- Update purchase details
Repricing
- Overview
- Create repricing agreements
- Get repricing agreements
- Update repricing agreements
- Create price lists
- Get price lists
- Update price lists
Transaction
- Overview
- Test transactions
- Test authorizations
- Get transaction data
- Create transactions
- Create fees
- Update a transaction
- Authorization Holds (BETA)
- Batch payment
Transfer API
- Overview
- Post account to account transfer
- Account to account batch transfer
- Post card to card transfer
Wallet
- Overview
- Push Provision
- Activation data
- Get tokens
Test API
- Overview
- test-auth-request-templates
- test-authorizations
Hierarchy API
- Overview
- Card Hierarchy Management
- Card Hierarchy Group Management
- Card Management in Card Hierarchy Groups
Spend Control API
- Overview
- Rule Sets Endpoints
- Rules Endpoints
- Spend Control Test Endpoint
- STIP External Account Balance Endpoints (BETA)
- STIP Spend Control Test Endpoint (BETA)
Authorisation Control Webhook
Outgoing authorisation control webhook endpoint
This is not an endpoint. This is the description of a request that is sent to issuers’ decision-making systems
POST
/
auth
curl --request POST \
--url http://localhost/auth \
--header 'Content-Type: application/json' \
--data '{
"metadata": {
"id": "<string>",
"traceId": "<string>",
"linkId": "<string>",
"messageCategory": "REQUEST"
},
"customer": {
"customerId": "<string>"
},
"account": {
"accountId": "<string>",
"availableAmount": {
"amount": 3.14,
"currency": "EUR"
}
},
"card": {
"cardId": "<string>",
"expiration": {
"year": 2019,
"month": 1
}
},
"transactionData": {
"transactionType": "RETAIL",
"transactionAmount": {
"amount": 3.14,
"currency": "EUR"
},
"settlementAmount": {
"amount": 3.14,
"currency": "EUR"
},
"replacementAmount": {
"amount": 3.14,
"currency": "EUR"
},
"transactionDateTime": "2023-11-07T05:31:56Z",
"authResponseCode": {
"code": "00"
},
"cardEntryMode": "UNKNOWN",
"authValidityInDays": 123,
"cardholderPresent": true,
"retrievalReferenceNumber": "<string>",
"authCode": "<string>",
"merchantInitiated": true,
"cardholderVerifications": [
"WALLET"
],
"transactionFees": [
{
"feeType": "MARKUP_FEE",
"feeAmount": {
"amount": 3.14,
"currency": "EUR"
}
}
],
"schemeTransactionLinkId": "<string>",
"incremental": true
},
"merchantData": {
"merchantId": "<string>",
"subMerchantId": "<string>",
"merchantName": "<string>",
"merchantCity": "<string>",
"merchantCountry": "FIN",
"acquirerCountry": "FIN",
"merchantCategory": {
"code": "5734",
"codeDescription": "<string>",
"group": "CASH"
},
"acquirerId": "<string>",
"terminalId": "<string>",
"partialApprovalCapable": true
},
"token": {
"tokenId": "<string>",
"tokenCategory": "APPLE_PAY",
"deviceType": "UNKNOWN_DEVICE"
}
}'
{
"transactionData": {
"authResponseCode": {
"code": "00"
},
"partialApprovalAmount": {
"amount": 3.14,
"currency": "EUR"
},
"availableBalance": {
"amount": 3.14,
"currency": "EUR"
}
}
}
Body
application/json
Response
200 - application/json
The response is of type object
.
curl --request POST \
--url http://localhost/auth \
--header 'Content-Type: application/json' \
--data '{
"metadata": {
"id": "<string>",
"traceId": "<string>",
"linkId": "<string>",
"messageCategory": "REQUEST"
},
"customer": {
"customerId": "<string>"
},
"account": {
"accountId": "<string>",
"availableAmount": {
"amount": 3.14,
"currency": "EUR"
}
},
"card": {
"cardId": "<string>",
"expiration": {
"year": 2019,
"month": 1
}
},
"transactionData": {
"transactionType": "RETAIL",
"transactionAmount": {
"amount": 3.14,
"currency": "EUR"
},
"settlementAmount": {
"amount": 3.14,
"currency": "EUR"
},
"replacementAmount": {
"amount": 3.14,
"currency": "EUR"
},
"transactionDateTime": "2023-11-07T05:31:56Z",
"authResponseCode": {
"code": "00"
},
"cardEntryMode": "UNKNOWN",
"authValidityInDays": 123,
"cardholderPresent": true,
"retrievalReferenceNumber": "<string>",
"authCode": "<string>",
"merchantInitiated": true,
"cardholderVerifications": [
"WALLET"
],
"transactionFees": [
{
"feeType": "MARKUP_FEE",
"feeAmount": {
"amount": 3.14,
"currency": "EUR"
}
}
],
"schemeTransactionLinkId": "<string>",
"incremental": true
},
"merchantData": {
"merchantId": "<string>",
"subMerchantId": "<string>",
"merchantName": "<string>",
"merchantCity": "<string>",
"merchantCountry": "FIN",
"acquirerCountry": "FIN",
"merchantCategory": {
"code": "5734",
"codeDescription": "<string>",
"group": "CASH"
},
"acquirerId": "<string>",
"terminalId": "<string>",
"partialApprovalCapable": true
},
"token": {
"tokenId": "<string>",
"tokenCategory": "APPLE_PAY",
"deviceType": "UNKNOWN_DEVICE"
}
}'
{
"transactionData": {
"authResponseCode": {
"code": "00"
},
"partialApprovalAmount": {
"amount": 3.14,
"currency": "EUR"
},
"availableBalance": {
"amount": 3.14,
"currency": "EUR"
}
}
}