Callback type | Callback context | Parameter name | Type | Parameter description | URL/Header/Payload Example | Callback format |
1 | TopUp | id | N/A | Transaction id | POST https://YourCallbackUrl/?id=TOPUP123&error=0&status=1&type=1&initialOrderID=&amount= | application/x-www-form-urlencoded |
error | N/A | Error codes for failed payments : 0 = 0XXX operation succeeded or still processing 10 = 1XXX operation rejected because of bad request configuration 11 = 2XXX operation rejected because of bad reference usage 12 = 3XXX operation rejected because of bad account configuration 13 = 4XXX operation rejected because of the bank or the supplier 14 = 5XXX operation rejected because of a system error 15 = 6XXX operation rejected because of anti-fraud engine |
||||
status | N/A | Transaction status : -1 = unknow 0 = waiting 1 = completed 2 = refunded 3 = refused 4 = waiting for validation 5 = cancelled 6 = waiting to be sent |
||||
type | N/A | Callback type | ||||
initialOrderID | N/A | Initial transaction orderid | ||||
amount | N/A | Transaction amount | ||||
4 | KYC demand | type | string | Callback type | { "type": "4", "status": "Incomplete", "appUserId": "rx193bo32", "diligences": [ { "diligenceType": "PASSPORT", "status": "Validated" } ] } |
JSON body |
status | string | Status of the KYC demand : - initialized - incomplete - complete - pending |
||||
appUserId | string | User unique identifier | ||||
diligences -> reason | string | Reason of acceptance or rejection of diligence | ||||
diligences -> diligenceType | string | Sent everytime the status of the KYC demand is updated. Type of diligence : - ID_CARD - PASSPORT - VETERAN_CARD - MILITARY_ID - RES_CARD - EMPL_CONTRACT - PAYSLIP - CESU - PENSION_RET - STUDENT_ID - TAX_NOTICE - INCOME_TAX - ASDIR - RSA - RMI - DIS_CERTIF - PROOF_FAM_ALLOW - ACC_STAT - SCTIN - ACC_AGG - SELFIE |
||||
diligences -> status | string | Status of diligence : - Validated - Refused - To_Review_Manually |
||||
5 | Registration of a bank card for TopUp | type | N/A | Callback type | POST https://YourCallbackUrl?type=5&id=yvzinayg1&userid=SBTEIX-29 | application/x-www-form-urlencoded |
id | N/A | Saved card Appcardid | ||||
userid | N/A | Appuserid related to the appcardid | ||||
15 | FreezeUser | type | N/A | Callback type | POST POST https://YourCallbackUrl?type=15&userstatus=2&userid=x03ksnze9 | application/x-www-form-urlencoded |
userstatus | N/A | User new status : 1 = OK (not frozen) 2 = frozen |
||||
userid | N/A | Appuserid | ||||
16 | SCTIn | id | string | Transaction id | { "id": "10743", "reference": "o0pbb6ryc", "status": "1", "userid": "dnboz3uht", "type": "16" } |
JSON body |
reference | string | Transaction orderid | ||||
status | string | Transaction status :
1 = succeeded 2 = refund |
||||
userid | string | User unique identifier (AppUserId) | ||||
type | string | Callback type | ||||
17 | SCTOut | id | string | Transaction id | { "id": "10763", "reference": "be9286c4-9d2f-48c7-985f-4f81a017b933", "status": "1", "userid": "peaLfrHbf", "type": "17" } |
JSON body |
reference | string | Transaction orderid | ||||
status | string | Transaction status : 0 = pending 1 = succeeded 2 = refund 3 = failed |
||||
userid | string | User unique identifier (AppUserId) | ||||
type | string | Callback type | ||||
18 | SDDOut (Xpollens account is credited) | id | string | Transaction id | JSON body | |
reference | string | Transaction orderid | ||||
status | string | Transaction status :
0 = pending 1 = succeeded 2 = refund 3 = failed |
||||
userid | string | User unique identifier (AppUserId) | ||||
type | string | Callback type | ||||
19 | SDDIn (Xpollens account is debited) | id | string | Transaction id | { "id": "10735", "reference": "S-MONEY-20210223161700000112", "status": "1", "userid": "K-oZktdWv", "type": "19" } |
JSON body |
reference | string | Transaction orderid | ||||
status | string | Transaction status : 0 = pending 1 = succeeded 2 = refund 3 = failed |
||||
userid | string | User unique identifier (AppUserId) | ||||
type | string | Callback type | ||||
20 | Card Operation Status change | Id | string | Xpollens internal card id | { "id": "464890", "reference": "8Y8Loh9L8E6FJsA7J1Tyrg", "type": "20", "appCardId": null, "transactionAmount": "11.9", "currencyCodeTransaction": "978", "cardHolderBillingAmount": "", "cardHolderBillingConversionRate": "", "availableBalance": "0.96", "actionCode": "0", "merchantType": "5814", "cardAcceptorIdentificationCodeName": "MC DONALD S\\\\GRENOBLE", "status": "0", "ert": "10", "cardDataInputMode": "9", "tokenRequestorId": "", "terminalCountryCode": "250", "userId": "dyYiUtSrj", "executedDate": "01/12/2022 14:44:09" } |
JSON body |
reference | string | Operation orderid | ||||
type | string | Callback type | ||||
appCardId | string | Reference or alias of the card | ||||
transactionAmount | string | Amount in local currency, decimal | ||||
currencyCodeTransaction | string | Transaction currency code (ISO 4217 numeric code) | ||||
cardHolderBillingAmount | string | Amount in euro (used for foreign currency transactions), decimal | ||||
cardHolderBillingConversionRate | string | Exchange rate (used for foreign currency transactions), decimal value in string data type | ||||
availableBalance | string | Balance after authorization, decimal | ||||
actionCode | string | Response codes (authorization and reasons for refusal) | ||||
merchantType | string | Merchant category code | ||||
cardAcceptorIdentificationCodeName | string | Merchant information (name, adress,etc…) | ||||
status | string | Operation status : 0 = waiting 1 = completed 2 = refunded 3 = failed 5 = cancelled 7 = expired |
||||
ert | string | Regulatory and technical environment (ATM, online payment, etc…) | ||||
cardDataInputMode | string | Contact or contactless | ||||
tokenRequestorID | string | Id of the token requestor (such as ApplePay, GooglePay, etc…) | ||||
terminalCountryCode | string | Country where the payment took place | ||||
userid | string | User unique identifier (AppUserId) | ||||
executedDate | string | Executed date of the operation. Warning: unusual date format: "dd/MM/yyyy hh:mm:ss" | ||||
21 | Card creation (or card change status) | id | number | Xpollens internal card id | { "id": 0, "reference": "card-lHXYoKrpn", "type": 21, "cardType": 4, "action": 0, "status": 1, "opposedReason": 0 } |
JSON body |
reference | string | Reference or alias of the card | ||||
type | number | Callback type | ||||
cardType | number | Type of the ordered card : 1 = classic virtual 2 = classic physical 3 = premium virtual 4 = premium physical |
||||
action | number | Action done on the card : 0 = creation 1 = cancellation 2 = refabrication 3 = renewal 4 = update |
||||
status | number | Status of the card : 0 = ordered 1 = sent 2 = activated 3 = expired 4 = opposed 5 = failed 6 = deactivated 7 = cancelled |
||||
opposedReason | number | Reason of card opposition : This field is different than '0' only when the card is opposed. 07 = special conditions 34 = suspected fraud 41 = lost 43 = stolen |
||||
24 | Card Operation Clearing processing Id | id | string | Xpollens internal card id | { "id": "1691", "reference": "1691", "type": "24" } |
JSON body |
reference | string | Batch file clearing report reference | ||||
type | string | Callback type | ||||
29 | P2P | id | string | Transaction id | { "id": "mmd8l3e3l", "receiver": "2voh0r42a", "sender": "999OB-COM", "type": "29" } |
JSON body |
receiver | string | Benefeciary account AppUserId | ||||
sender | string | Sender account AppUserId | ||||
type | string | Callback type | ||||
31 | KYC complementary diligence SCT_IN / InstanPayment | type | string | Callback type |
{ "type": "31", "status": "To_Review_Manually", "appUserId": "NemaabcJs", "diligenceType": "SCTIN", "reason": "The beneficiary's name is different of the transmitter's name", "amount": 125, "transferDate": "2021-09-01T11:00:38.477+00:00", "transmitterFullname": "Epp Sandra", "score": { "name": 0, "firstName": 0 } } |
JSON body |
status | string | Status of diligence : - Validated - Refused - To_Review_Manually |
||||
appUserId | string | User unique identifier | ||||
diligenceType | string | Type of diligence : - SCT_In - InstantPayment_In |
||||
reason | string | Reason of acceptance or rejection of the diligence | ||||
amount | number | Amount of the money in transfer (integer, in cents of euro) | ||||
transferDate | dateTime | Date of the money in transfer | ||||
transmitterFullName | string | Firstname and lastname (and birthname if existing) of the transmitter | ||||
operationType | string | Type of operation : - SCT_In - InstantPayment_In |
||||
orderId | string | Transaction orderid | ||||
score -> name | number | Result of the identity matching algorithm (percentage) | ||||
score -> firstname | number | Result of the identity matching algorithm (percentage) | ||||
32 | Risk Level change | eventDate | string | Date of the risk level event change | { "eventDate": "2021-02-26T11:26:50.4394587+00:00", "appUserId": "xXfIQ1G6y", "riskLevel": "Medium", "type": "32" } |
JSON body |
appUserId | string | External customer reference | ||||
riskLevel | string | Level of customer risk : - low - medium - high |
||||
type | string | Callback type | ||||
33 | Client debt created | type | number | Callback type | { "type": 33, "date": "2021-02-26T10:01:34.447732+00:00", "id": "ECDDAD31242", "userId": "94j8Jnw9d", "originAmount": 4, "status": 0, "debtAmount": 4, "debtReason": "P2P", "lossAndProfitBalance": 159567.93 } |
JSON body |
date | string | Origin operation creation date | ||||
id | string | Origin operation id | ||||
userid | string | AppUserId, User unique identifier | ||||
originAmount | number | Amount of the debt origin operation (integer, cents of euro) | ||||
status | number | Debt status : In progress = 0 Closedwithrecovery = 1 Closedwithoutrecovery = 2 |
||||
debtAmount | number | Amount of the debt (integer, cents of euro) | ||||
debtReason | string | Functional cases leading to the debt creation : - P2P - CardOperation - JRI |
||||
lossAndProfitBalance | number | Balance of loss and profit account after the debt creation (decimal, in euro) | ||||
34 | User's onboarding state (called user record) | type | string | Callback type | { "type": "34", "userRecordStatus": "InProgress", "appUserId": "70rot07ay", "publicUserCode": "363O2TWZ3787" } |
JSON body |
userRecordStatus | string | Status of the user record : 1 = initialized 2 = inProgress 4 = validated 5 = refused |
||||
appUserId | string | User unique identifier | ||||
publicUserCode | string | Corresponds to issuerClientID in Antelop system. It is used to create the wallet in the Antelop system. | ||||
35 | Callback for strong authentication (wallet enrollment) | type | string | Callback type | { "type": "35", "AppUserId": "610152c9J", "ActivationCode": "0xd14c7c77a134d87b45ec82cac16ac631", "ErrorMessage": null, "ExtraData": { "WebViewUrl": "https://example.com/api/v2/static/dist/index.html?technicalId=D6C39X" } } |
JSON body |
AppUserId | string | User unique identifier | ||||
ActivationCode | string | Code used to activate wallet (32 char) | ||||
ErrorMessage | string | Error message if an error occured | ||||
ExtraData | object | Webview URL | ||||
36 | Callback
for strong authentication (sensitives actions) |
AuthenticationId | string | Id of the authentication operation (used to link to the synchronous response) | Warning: the payload data structure depends on
the sensitive action API request. { "Header": { "AuthenticationId": "3285f14c-d0e3-4218-9482-30dd9f0c814f", "Type": 36, "AppUserId": "jHiBCTeAK", "AuthenticationResultDate": "2021-10-13T08:32:23+00:00", "RequestProcessDate": "2021-10-13T08:32:24.1177698+00:00", "RequestResponseCode": 200, "RequestDate": "2021-10-13T08:31:21.5157898+00:00", "Status": "Succeeded", "Reason": null }, "Payload": "{\"Id\":29141,\"AppUserId\":\"jHiBCTeAK\",\"Type\":1,\"Role\":2,\"Profile\":{\"Civility\":1,\"FirstName\":\"John\",\"LastName\":\"Doe\",}" } |
JSON |
Type | number | Callback type | ||||
AppUserId | string | User unique identifier | ||||
AuthenticationResultDate | string | Effective authentication result date | ||||
RequestProcessDate | string | Effective end date for the operation | ||||
RequestResponseCode | number | Http status code of the operation | ||||
Status | string | Status of the authentication | ||||
Reason | string | Reason of failure : - TIMEOUT: customer did not authenticate in due time - CANCELED: customer CANCELED the authentication request - FAILED: customer did not successfully authenticate |
||||
37 | Refund TopUp | id | N/A | Transaction id | POST http://YourCallbackUrl/?id=refund-TOPUP123-1&error=0&status=0&type=37&initialOrderID=TOPUP123&amount=600 | application/x-www-form-urlencoded |
error | N/A | Error codes for failed payments : 0 = 0XXX operation succeeded or still processing 10 = 1XXX operation rejected because of bad request configuration 11 = 2XXX operation rejected because of bad reference usage 12 = 3XXX operation rejected because of bad account configuration 13 = 4XXX operation rejected because of the bank or the supplier 14 = 5XXX operation rejected because of a system error 15 = 6XXX operation rejected because of anti-fraud engine |
||||
status | N/A | Transaction status : -1 = unknow 0 = waiting 1 = completed 2 = refunded 3 = refused 4 = waiting for validation 5 = cancelled 6 = waiting to be sent |
||||
type | N/A | Callback type | ||||
initialOrderID | N/A | Initial transaction orderid | ||||
amount | N/A | Transaction amount | ||||
38 | InstantPaymentIn | id | string | Transaction id | { "id": "227", "orderId": "test-ip0306201-4", "userId": "h9jZLHfV3", "operationAmount": "0.14", "status": "3", "rejectReason": "500", "type": "38" } |
JSON body |
orderId | string | Transaction orderid | ||||
userid | string | User unique identifier (AppUserId) | ||||
operationAmount | string | Transaction amount (decimal, in euro) | ||||
status | string | Transaction status :
Status enumeration : 0 = pending 1 = succeeded 2 = refund 3 = failed |
||||
rejectReason | string | Reject reason if applicable | ||||
type | string | Callback type | ||||
39 | InstantPaymentOut | id | string | Transaction id | { "id": "227", "orderId": "test-ip0306201-4", "userId": "h9jZLHfV3", "operationAmount": "0.14", "status": "3", "rejectReason": "AM02", "type": "39" } |
JSON body |
orderId | string | Transaction orderid | ||||
userid | string | User unique identifier (AppUserId) | ||||
operationAmount | string | Transaction amount (decimal, in euro) | ||||
status | string | Transaction status : 0 = pending 1 = succeeded 2 = refund 3 = failed |
||||
rejectReason | string | Reject reason if applicable | ||||
type | string | Callback type | ||||
40 | FundReservation | type | string | Callback type | { "type": "40", "operationId": "229", "orderId": "test-ip-out-nm75", "userId": "h9jZLHfV3", "operationAmount": "0.13", "authorizationBalanceAmount": "984.68", "dispositionCheckStatusId": "3" } |
JSON body |
operationId | string | Transaction id | ||||
orderId | string | Transaction orderid | ||||
userId | string | User unique identifier (AppUserId) | ||||
operationAmount | string | Transaction amount (decimal, in euro) | ||||
authorizationBalanceAmount | string | Authorization balance | ||||
dispositionCheckStatusId | string | Disposition check status : 1 = notReceived 2 = requested 3 = authorized 10 = refused 11 = canceled |
||||
41 | RecallInstantPaymentIn | id | string | Transaction id | { "id": "2484", "orderId": "ExmX3X5LlEWlmZXVi5xmVg", "userId": "phNgHPAfF", "operationAmount": "3.75", "status": "1", "rejectReason": null, "type": "41" } |
JSON body |
orderId | string | Transaction orderid | ||||
userid | string | User unique identifier (AppUserId) | ||||
operationAmount | string | Transaction amount (decimal, in euro) | ||||
status | string | Transaction status : 0 = pending 1 = succeeded 2 = refund 3 = failed |
||||
rejectReason | string | Reject reason if applicable | ||||
type | string | Callback type | ||||
42 | RecallInstantPaymentOut | id | string | Transaction id | { "id": "2484", "orderId": "ExmX3X5LlEWlmZXVi5xmVg", "userId": "phNgHPAfF", "operationAmount": "3.75", "status": "1", "rejectReason": null, "type": "42" } |
JSON body |
orderId | string | Transaction orderid | ||||
userid | string | User unique identifier (AppUserId) | ||||
operationAmount | string | Transaction amount (decimal, in euro) | ||||
status | string | Transaction status : 0 = pending 1 = succeeded 2 = refund 3 = failed |
||||
rejectReason | string | Reject reason if applicable | ||||
type | string | Callback type | ||||
43 | legalEntity | type | string | Callback type | { "type": "43", "legalEntityId": "7eadc6e17100J", "registrationNumber": "4eea2dd8529e", "registrationCountry": "AU", "legalEntityCreationStatus": "Succeeded", "registrationCity": "Melbourne", "companyName": "NM Corporation", "tradeName": "NM & her sons", "naceCode": "P85.1", "legalForm": "5499", "creationDate": "1982-12-08", "legalEntityRecordStatus": "Initialized", "onboardingDate": "2022-02-15T19:32:10.9931518+00:00", "turnOver": "360250.99", "currency": "EUR", "highFinancialIncome": false, "listedInStockMarkets": false, "regulated": false, "address": { "street": "51 Pender Street", "supplementIn": "Enter via garden in the back", "supplementOut": "Residential house", "area": "East-Thornbury", "zipCode": "3071", "city": "Thornbury", "country": "AU" } } |
JSON body |
legalEntityId | string | Legal entity unique identifier | ||||
registrationNumber | string | Legal identification number of the legal entity (e.g. SIREN number in France) |
||||
registrationCountry | string | Registration country of the legal entity (ISO 3166-1 Code) | ||||
legalEntityCreationStatus | string | Legal entity creation status : - succeeded - failed |
||||
registrationCity | string | Legal entity registration city | ||||
companyName | string | Name of the legal entity | ||||
tradeName | string | Commercial name of the legal entity | ||||
naceCode | string | Legal entity type of economical activity | ||||
legalForm | string | Legal entity legal form | ||||
creationDate | dateTime | Creation date of the legal entity | ||||
legalEntityRecordStatus | string | Onboarding status of the legal entity | ||||
turnOver | string | Turnover of N-1 year, decimal | ||||
HighFinancialIncome | boolean | High financial income : - true - false |
||||
ListedInStockMarkets | boolean | Listed in stock markets : - true - false |
||||
Regulated | boolean | Regulated : - true - false |
||||
Address -> street | string | Address informations of the legal entity | ||||
Address -> supplementIn | string | |||||
Address -> supplementOut | string | |||||
Address -> area | string | |||||
Address -> zipCode | string | |||||
Address -> city | string | |||||
Address -> country | string | |||||
44 | FatcaEai Callback | appUserId | string | User unique identifier | { "appUserId": "100120227", "diligences": [ {"files": [ "W9.png" ], "status": "Validated", "reason": null}], "fatcaEaiStatus": "NOK", "date": "2022-01-14T13:19:04+00:00", "type": "44" } |
JSON body |
diligences | array | Customer uploaded fatcaEai diligence(s) with each diligence status and reason information discriminated | ||||
status | string | Global factaEai status of the custumer | ||||
reason | string | Reasons of refusal if applicable | ||||
date | string | Date of last costumer fatcaEai status | ||||
type | string | Callback type | ||||
45 | Account status | type | string | Callback type | { "type": "45", "accountId": "f37bf7a2-d25f-4dc8-a4e8-b530a3a60f65", "appUserId": "ly_uTfks-", "accountStatus": "Frozen" } |
JSON body |
appUserId | string | User unique identifier | ||||
accountId | string | Account unique identifier | ||||
accountStatus | string | Account status : - Activated - Frozen - Closed - ClosureRequested - PendingClosure |