![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168453742_tel_wallet.png\")
| The HaitiPay platform is designed to support several types of transactions and payment applications. HaitiPay allows any phone to be used as for electronic transactions, such as bill payment, money transfers to others, point of sale purchases, etc. The HaitiPay platform offers the following features to users:purchase goods and services at their favorite local stores. Unbanked merchants will be able to accept payments and formalize their business transactions.
\nHaitiPay electronic wallet: Anyone with a mobile phone can easily and securely: store, send and spend money using the HaitiPay electronic wallet. The funds are placed in the wallet in different ways, by recharging in cash of the counter at agent locations, by wallet to wallet transfers, by disbursement of wages or by linking it to a bank account. The HaitiPay wallet can be used to pay bills, shop in stores on the web, or transfer money to other users.
\n\n\n💡 Follow instructions below to request access to this workspace and test the HaitiPay API.
\n
In the HaitiPay ecosystem, acceptors are defined as entities accepting electronic money. This can be either an agent receiving electronic money against cash in an Over The Counter (OTC) cash-in transaction, or a merchant providing goods and services against electronic money from clients. This API exposes methods to search clients, accounts, to authorize and post various transactions such as: Cash-in, Cash-out, Payment, Paybill, or Reversal of transaction.
\n\n\nHaitiPay uses an omni-channel platform, built to be fundamentally inclusive, while remaining
\nindependent from telecomoperator channels.End-users can activate their wallets/accounts with any phone, even with a feature phone that only handles audio, IVR, SMS and USSD. They can also use the HaitiPay mobile wallet app (IOS or Android), as well as a responsive web portal.HaitiPay agents and merchants can use a wide range of devices from an entry level Android smartphone to Mobiwire and Ingenico terminals.\nHaitiPay uses enablers to integrate and manage channels supplied by third parties.
\n\nA
\ncompanion cardcan be issued for the HaitiPay end-user, linked to his wallet/account. This allows the end-user to pay in MasterCard and VISA networks.####
The HaitiPay platform is designed to support several types of transactions and payment applications. HaitiPay allows any phone to be used as for electronic transactions, such as bill payment, money transfers to others, point of sale purchases. Here is a list of Digital Financial Services that can be delivered with the HaitiPay Platform:
\nUNIVERSAL MOBILE PHONE \n |
WALLET/ACCOUNT : The end-user’s mobile phone number is his wallet/account number. The wallet can be used with a feature phone, using IVR or USSD or with the smartphone app Haiwhich can be downloaded onto any Android or IOS device. The end-user then has easy access to his balance and transaction history. The wallet/account is mutli-currency. To create a wallet/account, clients are onboarded by an agent, with KYC tools.|| ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168474365_Cash-in_Cash_out.png\")
|
OTC CASH-IN & CASH-OUT : The end-user can visit an agent, representing the bank in the field, to securely perform a cash-in or a cash-out, crediting or debiting his wallet/account. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168483633_Bill_Voucher.png\")
|
BILL PAYMENT/VOUCHERS : The end-user can pay his bills securely and conveniently on his feature phone or mobile wallet app, or by paying with cash at a point of service. The HaitiPay platform connects to the partner’s billing back-office to verify reference numbers and authorize transactions. For this service it is possible to use IVR, app or USSD channels , as well as the responsive web portal. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168493639_airtime_topUp.png\")
|
AIR TIME TOP-UP : The end-user can top-up his airtime by using his feature phone, with IVR or USSD, or with his smartphone, through the web portal or with the HaitiPay mobile wallet. The end-user can also visit an agent to perform this service. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168502176_P2P_TP.png\")
|
P2P TRANSFERS : End-users can send money in many different ways, be it over the counter with an agent or directly from their feature phone or mobile wallet app. It is also possible to use IVR, USSD, app and web channels for transfers without the assistance of an agent. When receiving cash from another individual, the recipient can choose to leave it on his wallet/account. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168511220_Savings_TP.png\")
|
SAVINGS : Real-time transactions are transforming the end-user’s behavior around saving. He can credit a savings account as soon as he receives money (salary, pension, transfer). This flexibility, with the balances of his different accounts, gives him the opportunity to organize and manage hhiser savings in a completely new way. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168533518_Loans_TP.png\")
|
LOANS : Real-time technology and wide scale mobile phone deployment will transform the loan distribution process. With new forms of scoring and risk management, end-users will be able to obtain loans directly on their phones in a fraction of the time classically required. HaitiPay will power microcredit and meso-finance loans. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168541363_Salary+BulkP2P_TP.png\")
|
SALARIES & PENSIONS (BULK2P) : End-users can receive their salaries directly on their wallet/account. Companies can partner with HaitiPay to send payroll to their employees. SMS, USSD and the mobile wallet app are used for this service.|| ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168557005_Merchant_TP.png\")
|
MERCHANT PAYMENTS : End-users can securely and conveniently pay in stores with their phones using their wallets/accounts. Any cell phone can be used, no matter the telecom operator or type of phone. Merchants can partner with the HaitiPay HaitiPay to accept HaitiPay payments in their stores, offering their customers a convenient contactless payment experience that is extremely secure and user-friendly. The merchant downloads the Merchant app from Google Play or from the App Store, onto a POS terminal or Android device. NSDTâ„¢is used for securing transactions at the point of sale. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168567191_ePAYMENT_TP.png\")
|
E-PAYMENTS : End-users can pay online with their wallets/accounts. At checkout on the e-commerce website, the end- user is redirected to the HaitiPay online payment system. E-commerce companies can partner with HaitiPay to offer a secure and simple payment experience to their customers. HaitiPay includes a Woocommerce payment module that allows any e-commerce website powered by Woocommerce to accept payments online by incorporating the HaitiPay payment solution into its website. This service is only available in countries with HaitiPay HaitiPay. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168575287_Subsidies_TP.png\")
|
SUBSIDIES : The HaitiPay can partner with non-governmental organizations to distribute subsidies digitally. The recipients of the subsidies are notified and can then visit a network of dedicated merchants in order to buy the subsidized goods. The administrator of the service decides what percentage, if any, the beneficiary of the service must personally pay. During the transaction in the store, the merchant is paid in real-time for the full cost of the product, directly on his HaitiPay account. HaitiPay partners with non-governmental organizations and merchants in order to set up the service. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168584543_Cash2Good_TP.png\")
|
CASH2GOOD : HaitiPay’s Cash2Good enables P2P transfers that can be used in a dedicated network of stores. An end-user receiving Cash2Good will be able to spend the money at a specific network of merchants, chosen by the sender. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168592814_Cash_Collection_TP.png\")
|
CASH COLLECTION : The network of agents set up by HaitiPay can be used for cash collection by third parties. For example, a loan recipient of a local microfinance institution can visit a point of service to perform weekly loan repayments. This is done over the counter. || ![\"\"](\"https://paper-attachments.dropbox.com/s_49ED6FB24CD8D267294A2C87BEAA57320D554EDC44C2CF475C7395FBC14CA423_1596168600303_ATM_WithDrawal_TP.png\")
|
ATM WITHDRAWAL : End-users can withdraw cash from their wallets/accounts at an ATM. HaitiPay’s APIs enable simple integration with existing ATMs. For smartphones with the HaitiPay app or from the dedicated web portal, a one-time passcode is generated, that is then immediately used to withdraw cash from the ATM. With a feature phone, USSD is used to generate the passcode. It is also possible to install a solution that works directly with NSDT™ on the ATMs. |
\nAPI DESCRIPTION
\nThis API allows third party platforms to request HaitiPay to execute transactions on behalf of a Merchant or an Agent.A Client user in HaitiPay has one Wallet account named reserve account and as many dedicated account as he owns dedicated money at merchants or group of merchants.This API offers the following features:> - Credit or Debit a client's reserve or dedicated accounts.
\n\n\n
\n- On Behalf of an Agent execute
\nCash-InandCash-Out.
\n\n\n
\n- On Behalf of a Merchant
\nCreditorDebitdedicated merchant or merchant group account).- \n
Transfer Moneyfrom a Sender to a Recipient. This transfer can be fromreserve accounttoreserve accountor fromdedicated accounttodedicated accountor fromreserve accounttodedicated account.
\n\n\n
\n- \n
Change PINthe client's 4 digits secret code.
To access the HaitiPay Acceptor API you must have a registered acceptor account on the HaitiPay platform. An API key for this acceptor must be created for you by HaitiPay Administration.
\nIn order to obtain an Access Token, you must POSTto the URL https://sandbox.haitipay.com/api/acceptor/v1/oauth2/ token using a Content-type: application/json header and a JSON body containing the following items:
Request body example
\n{ \n\"grant_type\":\"client_credentials\", \n\"client_id\":\"eza9eza21eaz951ea8f2ffs9fgdfsdd3\", \n\"client_secret\":\"eb5d1477-0dab-4b36-bc3e-9da6d6cc25ba\"\n}\nCalling the URL as described above will yield a response similar to this (actual token cut off with [...] for brevity):
{\n\"token_type\": \"Bearer\",\n\"expires_in\":59940,\n\"access_token\":\"eyJ0eXAiOiJKV1Qi0MzI5Oi0MzI5ODDNiMzJj[...]\"\n}\nThe thus obtained access token must be provided in the HTTP request header Authorization for each API call prefixed by the word Bearer (with the trailing space):
Authorization: Bearer your_api_token
The access token has the same lifetime as a user's session, with the significant difference that it's lifetime is not extended upon each API action.
\nTherefore, the access token will expire after it's predefined lifetime has expired, resulting in a HTTP 401 Unauthorized response with the message Access token is invalid.
\nIt is the API consumer's responsibility to detect such response, to obtain a new access token using the process described above, and optionally to issue the failed request a new.
\nPlease request an invitation to access the HaitiPay API\n by sending an email to admin@haitipay.com\n With your name and company information.
\nWithin 24 hrs you will receive a confirmation that will allow you to access the \n HaitiPay workspace.
\nIt is important we understand the Business Models you want to implement.\nGet in touch and let us know how we can help.
\nContact support at devsupport@haitipay.com\nto get help from our team.
\nSome of this API endpoints use the Server Sent Events standard.
\nThe server keeps the HTTP response opened over time and send a series of event messages at arbitrary times.\nThe stream is opened until server has no more events to send, decides that the connection has been open long enough and can be considered stale, or until the client explicitly closes the initial request.\nThe Server Sent Events standard specifies how the messages should be formatted.
\nHere’s a template for a single event message:
\nid: <event id>\\n\nevent: <event type>\\n\ndata: <event data>\\n\n\\n\n\\n\nid: A unique ID for this eventevent: Specifies the type of event in the case where one event stream may have distinctly different event types.data: The message body, in our case a json encoded objectThe following endpoints use Server Sent Events :
\nPATCH /authentications/{transactionToken}/nsdt/verify)PATCH /authentications/{transactionToken}/pincode-client-ivr/verify)The Acceptor API uses consistent error representation across all the endpoints.
Here is a list of Common errors that could lead an API client to suggest actions to the final user.
This API allows Acceptors (Agents and Merchants) to perfom operations and transactions on the HaitiPay platform.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Acceptor API Description","slug":"acceptor-api-description"},{"content":"A MOBILE-CENTRIC BANKING PLATFORM","slug":"a-mobile-centric-banking-platform"},{"content":"Authentication","slug":"authentication"},{"content":"Server Sent Events","slug":"server-sent-events"},{"content":"API error codes signification","slug":"api-error-codes-signification"},{"content":"Introduction","slug":"introduction"}],"owner":"9000398","collectionId":"4b325080-0b2a-4e0c-ae05-cc2e868b12aa","publishedId":"UVXqEsq3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-24T02:17:30.000Z"},"item":[{"name":"clients","item":[{"name":"SearchClients","id":"accfe0dd-0a2f-4068-b95e-76bb8fffd85d","request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"https://sandbox.haitipay.com/api/acceptor/v1/clients?phone=50937027447&idNumber=dolor anim aliqua&externalId=1421","description":"Search for a client
\n","urlObject":{"path":["clients"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[{"description":{"content":"the client mobile phone number
\n","type":"text/plain"},"key":"phone","value":"50937027447"},{"description":{"content":"the client identity number
\n","type":"text/plain"},"key":"idNumber","value":"dolor anim aliqua"},{"description":{"content":"the client external identifier
\n","type":"text/plain"},"key":"externalId","value":"1421"}],"variable":[]}},"response":[{"id":"86f3776d-9f66-43a3-adbd-3f51389e12da","name":"Client information","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Search client accounts
\n","urlObject":{"path":["clients",":clientId","accounts"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[{"key":"id","value":"ACC123"},{"key":"iban","value":"FR791680810000000538"},{"key":"status","value":"OPENED"},{"key":"status","value":"OPENED"},{"key":"type","value":"dolor anim aliqua"},{"description":{"content":"Pagination page number
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"The number of items per page
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"Field to define the sort order. To indicate sorting direction, ascending (oldest first) fields may be prefixed with +. Descending (newer first) fields may be prefixed with -
\n","type":"text/plain"},"key":"sort","value":"id"}],"variable":[{"id":"a8dd9654-63a4-450b-b632-4b9fe4ae5ced","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"CLI123","key":"clientId"}]}},"response":[{"id":"ce99e9e9-bfcd-432f-b206-6a480dcf8b07","name":"The client accounts","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Cashin pre-authorization
\n","urlObject":{"path":["transactions","cashin"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[]}},"response":[{"id":"3e82a0aa-9da7-4918-bfef-803c1138bfdf","name":"Preauth successful","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Cashin transaction
\n","urlObject":{"path":["transactions","cashin",":transactionToken"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"ba5da33b-aaef-4672-9efe-3ac1e1528cf3","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"d3d45ced-babe-4392-a149-8569025a33ca","name":"Request successful, transaction was made","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Cashout pre-authorization
\n","urlObject":{"path":["transactions","cashout"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[]}},"response":[{"id":"f88f4d4b-ecd8-424a-b7d6-d49d6a2a9255","name":"Preauth successful","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Cashout transaction
\n","urlObject":{"path":["transactions","cashout",":transactionToken"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"b01668d5-4bb3-4bed-8bc9-b4581f626dde","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"e74a0860-3ccd-4b8a-97db-f9fda4e550e4","name":"Request successful, transaction was made","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Payment pre-authorization
\n","urlObject":{"path":["transactions","payment"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[]}},"response":[{"id":"7440d50c-7010-4529-962a-c612cc6352b9","name":"Preauth successful","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Payment transaction
\n","urlObject":{"path":["transactions","payment",":transactionToken"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"5db19d4a-9c02-451a-8023-d781cc3edaf5","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"86755b3c-1df8-4fdc-a443-e1316566a015","name":"Request successful, transaction was made","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Paybill pre-authorization
\n","urlObject":{"path":["transactions","paybill",":transactionToken"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"2ee63934-48bb-4e32-8bfd-ffaa2a68153c","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"7f802be5-2aa5-4d9c-a448-bd8261602e83","name":"Request success but more inputs are required","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Paybill transaction
\n","urlObject":{"path":["transactions","paybill",":transactionToken"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"2beb5fff-6479-4bd9-8532-21b708ed6fb0","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"029204dd-32c7-4012-ab9b-9d8993d38125","name":"Success response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"function paybill(apiClient, billIssuerId, clientIdentifier) {\n // initiate paybill transaction\n let response = apiClient.post(\"/transactions/paybill\", {billIssuerId: billIssuerId, clientIdentifier: clientIdentifier});\n let transactionToken = response.body.transactionToken;\n let userSubmittedValues = null;\n\n // making multiple preauth\n while(true) {\n response = apiClient.patch(\"/transactions/paybill/\" + transactionToken, {inputs: userSubmittedValues});\n if (response.code === 201) {\n break;\n }\n userSubmittedValues = askUserInput(response.body.inputs);\n }\n \n // making authentification\n makeAuth(transactionToken)\n\n // making transaction\n apiClient.post(\"/transactions/paybill/\" + transactionToken);\n}\n\nfunction askUserInput(inputs) {\n // ui logic to ask user to fill inputs\n}\n\nfunction makeAuth(transactionToken)\n{\n // logic to make authentication\n}\nReversal pre-authorization
\n","urlObject":{"path":["transactions","reversal"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[]}},"response":[{"id":"d450a17a-c320-4529-9df3-4a75ee6db72b","name":"Preauth successful","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Reversal transaction
\n","urlObject":{"path":["transactions","reversal",":transactionToken"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"d06526bf-86e0-4da3-8a5f-b73043a63746","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"2fcf85d2-74cb-4f98-a94f-afade6b06571","name":"Request successful, transaction was made","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Should be called when requested authentication mode is OTP_CLIENT
(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"a8d1f4fb-aac3-477a-92a3-571980be1013","name":"OTP was sent","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Should be called when requested authentication mode is OTP_CLIENT, after that OTP was sent
(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"0cec8db4-dd54-4ab1-9354-c088bbe39956","name":"Authentication successful","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Can cancel an ongoing transaction
\n","urlObject":{"path":["authentications",":transactionToken"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"a6f04aea-af89-467a-a293-a4bcf699332a","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"bce02f4b-6a10-4725-b95c-07cc32a4e551","name":"Transaction was cancelled","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Should be called when requested authentication mode is PINCODE_ACCEPTOR
(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"f9488950-3f1e-48a2-ae65-6d266302fee4","name":"Authentication successful","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Should be called when requested authentication mode is PINCODE_CLIENT
Notice
\nCalling this endpoint with an invalid keyboard ID will put the transaction authentication mode to ERROR state.\nIf no fallback is defined, then the transaction authentication state becomes AUTH_KO and cannot be authenticated anymore.
Invalid keyboard ID is defined by:
\n(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"dd30ea80-425f-428c-8a62-c120dc35a755","name":"Authentication successful","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Should be called when requested authentication mode is PINCODE_CLIENT_IVR.
This endpoint uses Server Sent Events
\n","urlObject":{"path":["authentications",":transactionToken","pincode-client-ivr","verify"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"632e96db-d05f-40c3-99f2-28e293f3a669","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"6cfe0378-878b-4029-8dcc-883d48016c47","name":"Server sent events stream about the client pincode on IVR process","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Should be called when requested authentication mode is NSDT_CLIENT.
This endpoint uses Server Sent Events
\nWhen event call status is CONNECTED, the API Client should start playing NSDT token.
When event call status is in SUCCESS, HANG_UP, TIMEOUT, the API Client should stop playing NSDT token.
(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"8443e37d-a7dc-49b2-baab-bd64f8ea2ffc","name":"Server sent events stream about the NSDT process","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Should be called when requested authentication mode is QR_CODE_CLIENT.
This endpoint uses Server Sent Events
\n","urlObject":{"path":["authentications",":transactionToken","qr-code","verify"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"cb8eafae-b316-433f-99d0-a967a8416d69","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"7d172574-2a80-43e3-8862-2decc4f4a602","name":"Server sent events stream about the QR code process","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Should be called when requested authentication mode is TRANSACTION_CODE
Transaction code available amount will be checked against total amount of transaction.
\n","urlObject":{"path":["authentications",":transactionToken","transaction-code"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"445cdbfe-1169-4269-be58-3e88d6e1a544","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transactionToken"}]}},"response":[{"id":"eed9c03d-0fca-44f9-830d-856830258bdd","name":"Authentication successful","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"KYC field auto-complete
\n","urlObject":{"path":["autocomplete",":inputId"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[{"description":{"content":"(Required) Current user input, to be completed
\n","type":"text/plain"},"key":"userInput","value":"dolor anim aliqua"}],"variable":[{"id":"584a33cf-a483-4bd1-a066-bdc38ae505fa","description":{"content":"(Required) KYC field identifier
\n","type":"text/plain"},"type":"any","value":"FIELD123","key":"inputId"}]}},"response":[{"id":"d803077a-9961-4def-a869-ee20cf0fc95d","name":"list of possible values found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.haitipay.com/api/acceptor/v1/autocomplete/:inputId?userInput=dolor anim aliqua","host":["https://sandbox.haitipay.com/api/acceptor/v1"],"path":["autocomplete",":inputId"],"query":[{"key":"userInput","value":"dolor anim aliqua"}],"variable":[{"key":"inputId","value":"FIELD123","description":"(Required) KYC field identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"inputId\": \"FIELD123\",\n \"userInput\": \"dolore minim\",\n \"possibleValues\": [\n {\n \"value\": \"Value123\",\n \"label\": \"ut amet\"\n },\n {\n \"value\": \"Value123\",\n \"label\": \"aute mollit\"\n }\n ]\n}"},{"id":"00e4dc5b-2e15-44e4-b080-79dfa18f5197","name":"KYC field not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.haitipay.com/api/acceptor/v1/autocomplete/:inputId?userInput=dolor anim aliqua","host":["https://sandbox.haitipay.com/api/acceptor/v1"],"path":["autocomplete",":inputId"],"query":[{"key":"userInput","value":"dolor anim aliqua"}],"variable":[{"key":"inputId","value":"FIELD123","description":"(Required) KYC field identifier"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"a112b0db-b888-4f44-b971-63d3c91ee0e0"},{"name":"ActivateDevice","id":"d01ffbd8-b328-4b7a-93be-e1a0c228219f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"device-id\": \"A12B3C4D5E\",\n \"activation-code\": \"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.haitipay.com/api/acceptor/v1/devices/activation","description":"This operation will proceed the activation of a previously registered device on the platform.
\nAPI client will get an API Key in response to a successful activation.\nThis API key is linked to the device and its owner's Acceptor.
\nThese are highly sensitive data, client app must store them in a secure manner.
\n","urlObject":{"path":["devices","activation"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[]}},"response":[{"id":"6d88aefc-f3de-4c91-8197-8f086d84d30f","name":"Device association succeded","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"device-id\": \"A12B3C4D5E\",\n \"activation-code\": \"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.haitipay.com/api/acceptor/v1/devices/activation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"key-id\": \"/ZlE/ /ZlE/ /ZlE/ /ZlE/ /ZlE/ /ZlE/ /ZlE/ /ZlE/\",\n \"key-secret\": \"/clR/ /clR/ /clR/ /clR/ /clR/ /clR/ /clR/ /clR/ /clR/ /clR/ /clR\"\n}"},{"id":"978708c0-1057-478a-8bc4-94b338349db5","name":"Request could not be processed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"device-id\": \"A12B3C4D5E\",\n \"activation-code\": \"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.haitipay.com/api/acceptor/v1/devices/activation"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 1234,\n \"message\": \"something went wrong because requirement X was not met.\",\n \"hint\": \"\\\"myAttribute\\\" must be a string, int given\"\n }\n}"}],"_postman_id":"d01ffbd8-b328-4b7a-93be-e1a0c228219f"},{"name":"GetIdentity","id":"64a5209f-a72c-4f6b-8d99-3a800e296610","request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"GET","header":[],"url":"https://sandbox.haitipay.com/api/acceptor/v1/acceptor","description":"Get Acceptor Identity Info
\n","urlObject":{"path":["acceptor"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[]}},"response":[{"id":"5b8d757f-6847-46c8-bf17-c9982ecee9eb","name":"The Acceptor Identity structured object","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Search accounts
\n","urlObject":{"path":["accounts"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[{"key":"id","value":"ACC123"},{"key":"iban","value":"FR791680810000000538"},{"key":"status","value":"OPENED"},{"key":"status","value":"OPENED"},{"key":"type","value":"dolor anim aliqua"},{"description":{"content":"Pagination page number
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"The number of items per page
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"Field to define the sort order. To indicate sorting direction, ascending (oldest first) fields may be prefixed with +. Descending (newer first) fields may be prefixed with -
\n","type":"text/plain"},"key":"sort","value":"id"}],"variable":[]}},"response":[{"id":"dc97d0b1-90c1-4ef8-ab1b-bce1e5cf757b","name":"The accounts","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"List Accounting Entries For Acceptor
\n","urlObject":{"path":["accounting-entries"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"accountId","value":"ACC123"},{"description":{"content":"Date et heure du début de l’intervalle de recherche
\n","type":"text/plain"},"key":"startDate","value":"2015-12-03T03:33:33.974Z"},{"description":{"content":"Date et heure de la fin de l’intervalle de recherche
\n","type":"text/plain"},"key":"endDate","value":"2015-12-03T03:33:33.974Z"},{"key":"id","value":"ACO4"},{"key":"type","value":"TRANSFER"},{"key":"transactionId","value":"TRX123"},{"key":"transactionType","value":"ACCOUNT_TO_ACCOUNT"},{"key":"externalId","value":"EXT123456789"},{"description":{"content":"Pagination page number
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"The number of items per page
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"Field to define the sort order. To indicate sorting direction, ascending (oldest first) fields may be prefixed with +. Descending (newer first) fields may be prefixed with -
\n","type":"text/plain"},"key":"sort","value":"id"}],"variable":[]}},"response":[{"id":"478ba694-241a-4756-9380-8320711051c8","name":"Searched List Of Accounting Entries","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Update Information Of Delegate User By Acceptor
\n","urlObject":{"path":["delegate-users",":userId"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[{"id":"d412d3ad-3ca6-4ae4-aa53-8c77a49cc632","description":{"content":"(Required) User Id of the delegate user
\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"012dd32e-dcba-4593-aec0-1cc161d8ee3b","name":"Delegate user information were updated","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Bill issuers list
\n","urlObject":{"path":["billers"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[{"description":{"content":"root item to use to get a subset of this tree
\n","type":"text/plain"},"key":"billItemId","value":"dolor anim aliqua"}],"variable":[]}},"response":[{"id":"bf8931f5-46b5-49da-9390-7844fbf34d6b","name":"Returns the bill issuers list ordered by categories","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Notice: a Keyboard can only be used once. If the secret code validation fails, you will have to generate a new Keyboard to make a new attempt.
\n","urlObject":{"path":["keyboard",":transaction-token"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[{"description":{"content":"the font to use in images
\n","type":"text/plain"},"key":"font","value":"dolor anim aliqua"},{"description":{"content":"the text color
\n","type":"text/plain"},"key":"color","value":"#000000"},{"description":{"content":"size of the image in pixel
\n","type":"text/plain"},"key":"width","value":"328"},{"description":{"content":"size of the font
\n","type":"text/plain"},"key":"fontSize","value":"328"}],"variable":[{"id":"c5e5b171-9943-4c04-a943-af5c0911baba","description":{"content":"(Required) the transaction token to authenticate
\n","type":"text/plain"},"type":"any","value":"dolor anim aliqua","key":"transaction-token"}]}},"response":[{"id":"875af4cb-6366-4f92-b19e-832ad5a9e2d9","name":"returns a keyboard safe to use to input client secret code","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Notice: Verify the validity of the pincode's acceptor whenever needed!
\n","urlObject":{"path":["pincode-acceptor","verify"],"host":["https://sandbox.haitipay.com/api/acceptor/v1"],"query":[],"variable":[]}},"response":[{"id":"091e4811-fac9-4e20-bd42-a52bff0257cb","name":"On successful pincode validation","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"