Welcome to the PiP iT Global API! You can use our API to access PiP iT Global API endpoints to carry out requests, create orders, make payments, check for confirmations and more.
\nPlease Note
\n\n\nMany of our endpoints require an authorization token, authToken, that is returned after a successful logn. You must provide this token in the header of your request for a qualified call to our API. Check the HEADERS entry for each endpoint on when to pass your authToken.
\n
Please Note
You can use https://beta-system.pipit.global or Beta testing. The client dashboard is here https://beta-dashboard.pipit.global . Please note that data can disappear from beta at any time.
The live dashboard is here [https://dashboard.pipit.global] where you can create a live test account. Note that any test payments made will not be settled back to you until you have a contract with Pipit Global.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9064048","collectionId":"a633d964-7855-4e87-8abb-adfa2c65a908","publishedId":"TVejgVeB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-03-21T11:30:11.000Z"},"item":[{"name":"Login","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"586147d3-b0d7-4162-bba0-a37a04e959b0","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"auth\", jsonData.authToken);\r","\r","console.log(JSON.stringify(postman.getEnvironmentVariable(\"auth\"), null, \"\"));"],"type":"text/javascript"}}],"id":"6cc5ec44-7346-405b-a154-5727b80642d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"{{username}}\",\n \"password\": \"{{password}}\"\n}"},"url":"{{host}}/api/v2/login","description":"\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Length: 0\nSet-Cookie: JSESSIONID=C089BA3EAD86D257BAA77CABACC7FACC7FAF6; Path=/;HttpOnly\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Length: 0\n\n\nExample Response
\n
HTTP/1.1 201 Created\nLocation: {{host}}/api/order/6377839876703799318\nContent-Type:application/json;charset=UTF-8\n\n{\n \"id\": 5715,\n \"barcode\": \"630070010575276263100002050\",\n \"reference\": \"276263\",\n \"vendorReference\": \"Sample Order\",\n \"currencyCode\": \"GBP\",\n \"orderValue\": 20,\n \"totalValue\": 20.5,\n \"fee\": 0.5,\n \"createdDate\": \"2019-03-13T16:04:02Z\",\n \"expiryDate\": \"2019-03-15T12:00:00Z\",\n \"status\": \"PENDING\"\n}\n\nMerchant Callbacks
\nIf Pipit Global is providing live payment information (as opposed to in a batch process) to a merchant then merchants are able to enable live callbacks from Pipit Global to their own system. Callbacks are enabled via the 'callback' (Y or N) and 'callback_url' fields in their merchant profile.
\nCallbacks are done only once per status change so they can be reconciled with the order status lists from the RESTApi as defined previously if the merchant’s server was unable to received the callbacks at some stage during the day.
\nOrder creation, payment and expiry are notified via the callback.
\nPayment Received
\nWhen a payment is received on the Pip-it system then a callback message is generated to the merchant’s servers using the Callback_URL provided by the merchant and set in their account profile (also the callbacks = 'Y' field must be set).
\nThe POST request will contain the following fields:
\nThe Internet Merchant can identify this callback as a paid order callback because it contains the PAID_DATE field.
\nFor example, in the case of a merchant providing ‘http://www.myshop.com/pip-itcallback’ as the callback URL and the barcode being
\n'605002264492001076102918376' then the http POST would be:
\n\nThis Payment message would be received on the merchant’s server and then the goods will be dispatched by the merchant to the customer.
\nIf the merchant has set the 'Secret Key' parameter, then this message will also be signed using a Sha-2 hash in a similar fashion as for the new order message described earlier.
\nFor the basic example we used above, this can be worked out as so (where “secret” is the secret key in this case): cleartext = ”60500226449200107610291837612345678920131114103000secret”;
sha-2(cleartext) = e9798b09e37edef38f16a021c5b12ca41ad837e2;
This would then give the following URL:
\n\nThe merchant’s servers would then be expected to check the SIGN field to ensure that the message had indeed come from the PiP iT servers.
\nOrder Created
\nThere is also an order created callback. It has the same format as above but with CREATE_DATE substituting for PAID_DATE. It is activated when an order is created.
\nOrder Expired
\nThere is also an order expired callback. It has the same format as above but with EXPIRE_DATE substituting for PAID_DATE. It is activated when an order expires.
\nWe have updated the FX. When you create an order in one currency but specify a different 'settlementCountry' or 'settlementCurrency' we then also return the FX rate in the order reply. e.g.
\nThere are two modes of operation:
\nHere you specify how much you want the payer to pay in local currency band you want to know how much you get receive in your choosen settlement currency. If you create an order for CLP 50,000 and specify you want settlement in USD like so:
\n{
\"orderCurrencyCode\": \"CLP\",
\"country\": \"CHL\",
\"settlementCurrency\": \"USD\",
\"clientOrderReference\": \"your ref\",
\"clientName\": \"{{client-username}}\",
\"orderValue\": \"50000\",
\"customerMobiPhoneNumberExt}}\",
\"customerEmail\": \"email@email.com\",
\"replyUrl\": \"https://your.callback.com\"
}
You will get this is return:
\n{
\"barcode\": \"382220025\",
\"reference\": \"500381\",
\"clientReference\": \"your ref\",
\"partnerReference\": \"Ln7HMNoCS0\",
\"currencyCode\": \"CLP\",
\"orderValue\": 50000.00,
\"totalValue\": 50000.00,
\"fee\": 0.00,
\"createdDate\": \"2022-08-02T06:57:18Z\",
\"expiryDate\": \"2022-08-03T05:59:59Z\",
\"status\": \"PENDING\",
\"orderType\": \"CashIn\",
\"settlementBarcode\": \"654210479\",
\"settlementCurrency\": \"USD\",****\"settlementValue\": 51.40
}
When that order is paid you will receive USD$ 51.40 minus fees. We actually create two associated orders; the local one to be paid and the USD one to hold the FX. So you can see both on your dashboard and via the API. When the local order is paid so is the FX and all the settlement and notifications function as you would expect.
\nObviously, if we can't guarantee the FX rate the create will fail with an explanatory message.
\nYou can always create orders just in local currency but then you'll just get the rate on the day of settlement.
\nThis system is just where we can guarantee the rate.
\nThis works right now for LATAM and Africa, and we are adding more all the time.
\nHere you specify how much you want to receive when an order is paid. You aren't especially concerned with how much actually needs to be paid in the local currency. e.g you create an order for USD$ 300 and you specify you want it to be paid in Chile in CLP like so:
\n{
\"orderCurrencyCode\": \"USD\",\"orderValue\": \"300\",\"paymentCountry\": \"CHL\",
\"clientOrderReference\": \"your ref\",
\"clientName\": \"{{client-username}}\",
\"orderValue\": \"300\",
\"customerMobiPhoneNumberExt\": \"{{phonenumber}},
\"customerEmail\": \"email@email.com\",
\"replyUrl\": \"https://your.callback.com\"
}
You will get this is return:
\n{
\"barcode\": \"382220025\",
\"reference\": \"500381\",
\"clientReference\": \"your ref\",
\"partnerReference\": \"Ln7HMNoCS0\",
\"currencyCode\": \"USD\",****\"orderValue\": 300.00,
\"totalValue\": 300.00,
\"fee\": 0.00,
\"createdDate\": \"2022-08-02T06:57:18Z\",
\"expiryDate\": \"2022-08-03T05:59:59Z\",
\"status\": \"PENDING\",
\"orderType\": FX Order\",
\"paymentBarcode\": \"654210479\",\"paymentCurrency\": \"CLP\",\"paymentValue\": \"291856.63\"
}
In this case you will need to provide the 'paymentBarcode' as the order reference to the payer as that is what they actually pay. When the order is paid locally you will receive the USD value you originally requested.
\n","urlObject":{"path":["api","merchant","v2","orders"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ffa28f3-c83f-4acd-9f06-a7db03ab9a9e"},{"name":"Retrieve a Cash-In Order","event":[{"listen":"test","script":{"id":"df97c7b8-5691-4d95-ab57-e495b0fa5463","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"barcode\", jsonData.barcode);\r","postman.setEnvironmentVariable(\"totalValue\", jsonData.totalValue);\r","postman.setEnvironmentVariable(\"orderCurrencyCodeCreated\", jsonData.currencyCode);"],"type":"text/javascript"}}],"id":"e0b8928d-2500-4495-aee9-028e9586963a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{host}}/api/order/{{barcode}}","description":"\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"id\": 5715,\n \"barcode\": \"630070010575276263100002050\",\n \"reference\": \"276263\",\n \"vendorReference\": \"Sample Order\",\n \"currencyCode\": \"GBP\",\n \"orderValue\": 20,\n \"totalValue\": 20.5,\n \"fee\": 0.5,\n \"createdDate\": \"2019-03-13T16:04:02Z\",\n \"expiryDate\": \"2019-03-15T12:00:00Z\",\n \"status\": \"PENDING\"\n}\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"barcode\": \"6377839862260014614\",\n \"createdDate\": \"2019-01-07T19:47:28Z\",\n \"currencyCode\": \"EUR\",\n \"customerDetails\": {\n \"addressLine1\": \"7 Vancouver Place\",\n \"addressLine2\": \"Northcliff\",\n \"addressLine3\": \"Extension\",\n \"addressLine4\": \"15\",\n \"addressLine5\": \"2195\",\n \"addressLine6\": \"Gauteng\",\n \"country\": \"South Africa\",\n \"email\": {{customerEmail}},\n \"name\": {{customerName}},\n \"timezone\": \"SAST\"\n },\n \"expiryDate\": \"2019-01-08T19:47:28Z\",\n \"language\": \"ENG\",\n \"orderValue\": 621.01,\n \"reference\": \"1461\",\n \"status\": \"PENDING\",\n \"totalValue\": 627.22,\n \"vendorReference\": \"ZZ-3722\"\n}\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n{\n \"content\": [\n {\n \"barcode\": \"6377839815483408088\",\n \"createdDate\": \"2019-01-07T07:01:25Z\",\n \"expiryDate\": \"2019-01-08T07:01:25Z\",\n \"orderValue\": 1234.0,\n \"reference\": \"340808\",\n \"status\": \"PENDING\",\n \"totalValue\": 1246.34,\n \"vendorReference\": \"1234\"\n },\n {\n \"barcode\": \"6377839860745768754\",\n \"createdDate\": \"2019-01-07T13:24:48Z\",\n \"expiryDate\": \"2019-01-08T13:24:48Z\",\n \"orderValue\": 1234.0,\n \"reference\": \"576875\",\n \"status\": \"PENDING\",\n \"totalValue\": 1246.34,\n \"vendorReference\": \"1234\"\n }\n ],\n \"first\": true,\n \"last\": true,\n \"number\": 0,\n \"numberOfElements\": 2,\n \"size\": 20,\n \"sort\": null\n}\n\n\nExamples
\n
Query Parameters\nsort: (string)\nsize: (integer)\npage: (integer)
\n\n\nFind pending orders sorted by createdDate:
\n
curl -v -b cookies.txt \"{{host}}/merchant/orders/pending?sort=createdDate\"\n\n\nFind pending orders sorted by createdDate ascending, page size of 2:
\n
curl -v -b cookies.txt \"{{host}}/merchant/orders/pending?sort=createdDate,asc&size=2\"\n\n\nFind pending orders sorted by createdDate ascending, page size of 2, and 3rd page:
\n
curl -v -b cookies.txt \"{{host}}/merchant/orders/pending?sort=createdDate,asc&size=2&page=3\"\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n{\n \"content\": [\n {\n \"barcode\": \"605002828627001075113012260\",\n \"createdDate\": \"2007-11-30T10:16:23Z\",\n \"expiryDate\": \"2007-11-30T10:26:37Z\",\n \"orderValue\": 10.0,\n \"reference\": \"828627\",\n \"status\": \"EXPIRED\",\n \"totalValue\": 10.75,\n \"vendorReference\": \"1234\"\n },\n {\n \"barcode\": \"605002673473013332120413085\",\n \"createdDate\": \"2007-12-04T10:57:52Z\",\n \"expiryDate\": \"2007-12-04T11:12:02Z\",\n \"orderValue\": 131.32,\n \"reference\": \"673473\",\n \"status\": \"EXPIRED\",\n \"totalValue\": 133.32,\n \"vendorReference\": \"order_id\"\n }\n ],\n \"first\": true,\n \"last\": true,\n \"number\": 0,\n \"numberOfElements\": 2,\n \"size\": 20,\n \"sort\": null\n}\n\n\nExamples
\n
Query Parameters\nsort: (string)\nsize: (integer)\npage: (integer)
\n\n\nFind expired orders sorted by expiryDate:
\n
curl -b cookies.txt \"{{host}}/merchant/orders/expired?sort=expiryDate\"\n\n\nShow 5 results per page:
\n
curl -b cookies.txt \"{{host}}/merchant/orders/expired?size=5\"\n\n\nSort by expiry date, desc, show 5 results per page, and 3rd page:
\n
curl -b cookies.txt \"{{host}}/merchant/orders/expired?sort=expiryDate,desc&size=5&page=3\"\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n{\n \"content\": [\n {\n \"barcode\": \"605002062654016668031412380\",\n \"createdDate\": \"2019-03-14T11:15:51Z,\n \"expiryDate\": \"2019-03-17T11:15:51Z,\n \"orderValue\": 164.43,\n \"paymentDate\": \"\"2019-03-15T09:35:44Z\",\n \"reference\": \"62654\",\n \"status\": \"PAID\",\n \"totalValue\": 166.68,\n \"vendorReference\": \"order_id\"\n },\n...\n {\n \"barcode\": \"6377839896340627813\",\n \"createdDate\": \"2019-01-05T09:19:26Z\",\n \"expiryDate\": \"2019-01-06T09:19:26Z\",\n \"orderValue\": 1234.0,\n \"reference\": \"62781\",\n \"status\": \"PAID\",\n \"totalValue\": 1246.34,\n \"vendorReference\": \"1234\"\n }\n ],\n \"first\": true,\n \"last\": false,\n \"number\": 0,\n \"numberOfElements\": 20,\n \"size\": 20,\n \"sort\": null\n}\n\n\n\nExamples
\n
Query Parameters\nsort: (string)\nsize: (integer)\npage: (integer)
\n\n\nFind paid orders sorted by expiryDate:
\n
curl -b cookies.txt \"{{host}}/merchant/orders/paid?sort=expiryDate\"\n\n\nShow 5 results per page:
\n
curl -b cookies.txt \"{{host}}/merchant/orders/paid?size=5\"\n\n\nSort by expiry date, desc, show 5 results per page, and 3rd page:
\n
curl -b cookies.txt \"{{host}}/merchant/orders/paid?sort=expiryDate,desc&size=5&page=3\"\nYou will be unable to mark an order paid until you have contacted PiPiT Global's sales team to sign up to our service.
\n\n\nExample Request
\n
{\n \"clientname\": \"Your Company Name\",\n \"pipit-ref\": \"630070010575276263100002050\",\n \"location-ref\": \"You supply this trackable location\",\n \"payment-ref\": \"This is a supplied reference\",\n \"total-value\": \"20.50\",\n \"sign\": \"15b16e2e566ee881750946ee45632e9cd47684b12a29143ad14c88adbc066936\",\n \"currency\": \"EUR\",\n \"address-line-1\": \"address-line-1\",\n \"address-line-2\": \"address-line-2\",\n \"address-line-3\": \"address-line-3\",\n \"address-line-4\": \"address-line-4\",\n \"city\": \"city\",\n \"post-code\": \"A Code\",\n \"country\": \"A Country\",\n \"latitude\": \"53.2724178\",\n \"longitude\": \"-9.0492046\"\n}\n\n\nExample Response
\n
HTTP/1.1 200 \nLocation: {{host}}/api/merchant/v2/payorder\nContent-Type:application/json;\n{\n \"timestamp\": \"2019-05-27T15:32:03Z\",\n \"code\": \"PAYMENT_SUCCESSFUL\",\n \"message\": \"PayzoneIRL Payment Request Received: from IP (0:0:0:0:0:0:0:1)...barcode=630070017517011456600012050...order found...order value(amount) (incl fee) matches...currently unpaid...This is a payment message. PAID!\",\n \"path\": \"/api/merchant/v2/payorder\"\n}\nAlthough the address information is not required we encourage you to supply as much information as possible when marking an order paid. This ensures all parties are complient with international rules on financial transactions.
\nIn order to secure transactions you must supply your secretkey as part of the seed for a sha256 hash value. This hash is created by concatenating pipit-ref + clientOrderReference + currency + secretkey. We can supply you with a Postman collection to aid you in your integration with our API. \nYour secret key is obtained via our Client Dashboard.
\nFor nodejs integrations the crypto-js is an excellent resource and is used in our Postman scripts. Please use an equivalent library for your code base language.
\ncrypto-js example
\nvar sigString = \"630070010575276263100002050\" + \"This is a sample order\" + \"EUR\" + \"8d3a1d0292ec496da68da6599d214622\";\nCryptoJS.SHA256(sigString);\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n{\n \"content\": [\n {\n \"barcode\": \"6377839815483408088\",\n \"createdDate\": \"2019-01-07T07:01:25Z\",\n \"expiryDate\": \"2019-01-08T07:01:25Z\",\n \"orderValue\": 1234.0,\n \"reference\": \"340808\",\n \"status\": \"PENDING\",\n \"totalValue\": 1246.34,\n \"vendorReference\": \"1234\"\n },\n {\n \"barcode\": \"6377839860745768754\",\n \"createdDate\": \"2019-01-07T13:24:48Z\",\n \"expiryDate\": \"2019-01-08T13:24:48Z\",\n \"orderValue\": 1234.0,\n \"reference\": \"576875\",\n \"status\": \"PENDING\",\n \"totalValue\": 1246.34,\n \"vendorReference\": \"1234\"\n }\n ],\n \"first\": true,\n \"last\": true,\n \"number\": 0,\n \"numberOfElements\": 2,\n \"size\": 20,\n \"sort\": null\n}\n\n\nExamples
\n
Query Parameters\nsort: (string)\nsize: (integer)\npage: (integer)
\n\n\nFind pending orders sorted by createdDate:
\n
curl -v -b cookies.txt \"{{host}}/merchant/orders/pending?sort=createdDate\"\n\n\nFind pending orders sorted by createdDate ascending, page size of 2:
\n
curl -v -b cookies.txt \"{{host}}/merchant/orders/pending?sort=createdDate,asc&size=2\"\n\n\nFind pending orders sorted by createdDate ascending, page size of 2, and 3rd page:
\n
curl -v -b cookies.txt \"{{host}}/merchant/orders/pending?sort=createdDate,asc&size=2&page=3\"\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"timestamp\": \"2019-03-13T16:38:53Z\",\n \"code\": \"MERCHANT_REGISTERED\",\n \"message\": \"An email has been sent to your email address. Please follow the instructions in the email to verify your account.\",\n \"path\": \"/api/merchant/register\"\n}\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"timestamp\":\"2019-01-07T12:29:49Z\",\n \"code\":\"MERCHANT_VERIFIED\",\n \"message\":\"Your account has been verified successfully\",\n \"path\":\"/api/merchant/verify/NzA1NjczMzMtYzIzNS00NDcxLThiMzctYjQxZTFlMzVhOTcy\"\n}\nVerification of a merchants account allows the merchant to:
\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"notificationEmailAddress\": {{customerEmail}},\n \"orderCallbackUrl\": {{host}},\n \"orderExpiryTimeHours\": 24,\n \"secretKey\": null,\n \"website\": null\n}\n(Required) The bearer token returned from the login action
\n"}],"body":{"mode":"raw","raw":"{\r\n \"notificationEmailAddress\": \"{{customerEmail}}\",\r\n \"orderCallbackUrl\": \"{{orderCallbackUrl}}\",\r\n \"orderExpiryTimeHours\": 22,\r\n \"secretKey\": \"meowmeow\",\r\n \"website\": null,\r\n \"oldPassword\": \"myfirstsecret\",\r\n \"newPassword\": \"mycurrentsecret\"\r\n}"},"url":"{{host}}/api/merchant/profile","description":"\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"code\": \"PROFILE_UPDATED\",\n \"message\": \"Your account has been updated successfully.\",\n \"path\": \"/api/merchant/profile\",\n \"timestamp\": \"2019-03-14T11:15:51Z\"\n}\nIf a parameter is specified (even if it is null) it is assumed that the intent is to update the parameter (possibly to a null value). To leave a parameter unchanged, do not include it in the payload.
\n","urlObject":{"path":["api","merchant","profile"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"608e4855-d8b3-44f2-b182-75c8642707b4"},{"name":"Request a Password Reset Token","id":"31ba2edb-d557-42ae-97c2-48c07aaa0d51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{auth}}"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{userName}}\"\r\n}"},"url":"{{host}}/api/merchant/reset-password-token","description":"\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"timestamp\": \"2019-03-14T11:15:51Z\",\n \"code\": \"MERCHANT_RESET_PASSWORD_TOKEN_GENERATED\",\n \"message\": \"An email has been sent to your email address with instructions on how to reset your password.\",\n \"path\": \"/api/merchant/reset-password-token\"\n}\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"code\":\"MERCHANT_RESET_PASSWORD_SUCCESS\",\n \"message\":\"Your password has been reset.\",\n \"timestamp\": \"2019-03-14T11:15:51Z,\n \"path\":\"/api/merchant/reset-password\"\n}\n\nThe token that needs to be supplied is sent in an email to the notification address of the merchant's account after successfully requesting a password reset token.
\nDear ACME TRADING,
\nA request to reset your Pip-it password has been received.\nIn order to change your password, please click the following link:
\n{{host}}api/merchant/reset-password/ZWI5MThhNGItOTBkZS00ZDI3LTk3ZjYtNTE1ZDA1MGVhMTMw\n
\nPlease note that this link will expire at 22:09, 25 Jan, 2019
Regards, The Pip-it Team
\nIn this example, the token is: ZWI5MThhNGItOTBkZS00ZDI3LTk3ZjYtNTE1ZDA1MGVhMTMw
Clicking the link in the email will allow you to reset the password using a HTML form. The following sections describe the REST API for performing the same operation.
\n","urlObject":{"path":["api","merchant","reset-password"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a3dbbfb-345b-4ec6-9a9f-db08aa130583"},{"name":"Retrieve an Order Using a Barcode","id":"afad6fcd-63ab-419f-8e5d-5f6e5ea7304d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{auth}}"}],"url":"{{host}}/api/merchant/order/{{barcode}}","description":"\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"barcode\":\"6377839824167832902\",\n \"reference\":\"783290\",\n \"vendorReference\":\"ABC-123\",\n \"orderValue\":123.58,\n \"totalValue\":124.82,\n \"createdDate\":\"2019-03-07T12:40:12Z\",\n \"expiryDate\":\"2019-03-10T12:40:12Z\",\n \"status\":\"PENDING\"\n}\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"timestamp\": \"2019-03-14T11:00:28Z\",\n \"code\": \"MERCHANT_REGISTERED\",\n \"message\": \"An email has been sent to your email address. Please follow the instructions in the email to verify your account.\",\n \"path\": \"/api/merchant/v2/signUp\"\n}\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"timestamp\":\"2019-03-07T12:29:49Z\",\n \"code\":\"MERCHANT_VERIFIED\",\n \"message\":\"Your account has been verified successfully\",\n \"path\":\"/api/merchant/verify/NzA1NjczMzMtYzIzNS00NDcxLThiMzctYjQxZTFlMzVhOTcy\"\n}\nVerification of a merchants account allows the merchant to:
\nLog in and use the merchant REST API\nCreate an order using the merchant's username
\n","urlObject":{"path":["api","merchant","v2","verify"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d868c9c-0ded-4217-91b1-54784dea5305"},{"name":"Reset the Password Using the Token","id":"ce395b3e-ec49-4b89-8563-0939aa645542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"ZWI5MThhNGItOTBkZS00ZDI3LTk3ZjYtNTE1ZDA1MGVhMTMw\",\r\n \"password\": \"p@ssword1\"\r\n}"},"url":"{{host}}/api/merchant/v2/reset-password","description":"\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"timestamp\": \"2019-03-14T12:00:37Z\",\n \"code\": \"MERCHANT_RESET_PASSWORD_SUCCESS\",\n \"message\": \"Your password has been reset.\",\n \"path\": \"/api/merchant/v2/reset-password\"\n}\n\nThe token that needs to be supplied is sent in an email to the notification address of the merchant's account after successfully requesting a password reset token.
\nDear ACME TRADING,
\nA request to reset your Pip-it password has been received.\nIn order to change your password, please click the following link:
\n{{host}}/api/merchant/v2/reset-password/ZWI5MThhNGItOTBkZS00ZDI3LTk3ZjYtNTE1ZDA1MGVhMTMw\n
\nPlease note that this link will expire at 22:09, 25 Jan, 2019
Regards, The Pip-it Team
\nIn this example, the token is: ZWI5MThhNGItOTBkZS00ZDI3LTk3ZjYtNTE1ZDA1MGVhMTMw
Clicking the link in the email will allow you to reset the password using a HTML form. The following sections describe the REST API for performing the same operation.
\n","urlObject":{"path":["api","merchant","v2","reset-password"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce395b3e-ec49-4b89-8563-0939aa645542"},{"name":"Request a Password Reset Token","id":"4c632e8d-446b-4c9e-9fc2-62d8b28e021f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{vendorName}}\"\r\n}"},"url":"{{host}}/api/merchant/v2/reset-password/request-token","description":"\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type: application/json;charset=UTF-8\n{\n \"timestamp\": \"2019-03-14T11:58:31Z\",\n \"code\": \"MERCHANT_RESET_PASSWORD_TOKEN_GENERATED\",\n \"message\": \"An email has been sent to your email address with instructions on how to reset your password.\",\n \"path\": \"/api/merchant/v2/reset-password/request-token\"\n}\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n{\n \"content\": [\n {\n \"id\": 6150,\n \"vendor\": \"PiP Payments Ltd\",\n \"currency\": \"GBP\",\n \"reportDate\": \"2019-2-11T00:00:00Z\",\n \"reportEndDate\": \"2098-2-11T00:00:00Z\",\n \"reportStartDate\": \"2019-1-29T00:00:00Z\",\n \"reportRunDate\": \"2019-2-12T04:10:00Z\",\n \"totalSalesSoFar\": 1001.5,\n \"totalVendorSalesSoFar\": 999.5,\n \"totalCountSoFar\": 4,\n \"totalValueOwedSoFar\": 965.12,\n \"previouslyPaidThisMonth\": 0,\n \"unpaidLastMonth\": 0,\n \"totalPaidThisTime\": 963.12,\n \"totalOwedThisMonth\": 963.12\n }\n ],\n \"totalPages\": 15,\n \"last\": false,\n \"totalElements\": 15,\n \"numberOfElements\": 1,\n \"sort\": [\n {\n \"direction\": \"ASC\",\n \"property\": \"reportStartDate\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": false,\n \"ascending\": true\n }\n ],\n \"first\": false,\n \"size\": 1,\n \"number\": 2\n}\n\n\n\nExamples
\n
Query Parameters
\nsort: (string)\nsize: (integer)\npage: (integer)
\n\n\nFind settled orders sorted by start date:
\n
curl -H \"{{auth}}\" {{host}}/merchant/v2/settled?sort=reportStartDate\n\n\nSorted by start date, showing 2 results per page,:
\n
curl -H \"{{auth}}\" {{host}}/merchant/v2/settled?sort=reportStartDate,asc&size=2\n\n\nSort by start date, showing 2 results per page, and the 3rd page:
\n
curl -H \"{{auth}}\" {{host}}/merchant/v2/settled?sort=reportStartDate,asc&size=2&page=3\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n{\n \"content\": [\n {\n \"id\": 6150,\n \"vendor\": {{vendorName}},\n \"currency\": \"GBP\",\n \"reportDate\": \"2019-2-11T00:00:00Z\",\n \"reportEndDate\": \"2019-2-11T00:00:00Z\",\n \"reportStartDate\": \"2019-1-29T00:00:00Z\",\n \"reportRunDate\": \"2019-2-12T04:10:00Z\",\n \"totalSalesSoFar\": 1001.5,\n \"totalVendorSalesSoFar\": 999.5,\n \"totalCountSoFar\": 4,\n \"totalValueOwedSoFar\": 965.12,\n \"previouslyPaidThisMonth\": 0,\n \"unpaidLastMonth\": 0,\n \"totalPaidThisTime\": 963.12,\n \"totalOwedThisMonth\": 963.12\n }\n ],\n \"totalPages\": 15,\n \"last\": false,\n \"totalElements\": 15,\n \"numberOfElements\": 1,\n \"sort\": [\n {\n \"direction\": \"ASC\",\n \"property\": \"reportStartDate\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": false,\n \"ascending\": true\n }\n ],\n \"first\": false,\n \"size\": 1,\n \"number\": 2\n}\n\n\n\nExamples
\n
Query Parameters\nsort: (string)\nsize: (integer)\npage: (integer)
\n\n\nFind settled Euro orders between two dates, sorted by start date:
\n
curl -H \"{{auth}}\" {{host}}/merchant/v2/settled/EUR/2001-01-01/2002-01-02?sort=reportStartDate\n\n\nSorted by start date, showing 2 results per page,:
\n
curl -H \"{{auth}}\" {{host}}/merchant/v2/settled/EUR/2001-01-01/2002-01-02?sort=reportStartDate,asc&size=2\n\n\nSort by start date, ascending, showing 2 results per page, and the 3rd page:
\n
curl -H \"{{auth}}\" ${{host}}/merchant/v2/settled/EUR/2001-01-01/2002-01-02?sort=reportStartDate,asc&size=2&page=3\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n{\n \"id\": 6077,\n \"barcode\": \"6300708045050663\",\n \"reference\": \"804505\",\n \"vendorReference\": \"ABC-123\",\n \"currencyCode\": \"EUR\",\n \"orderValue\": 123.58,\n \"totalValue\": 124.08,\n \"fee\": 0.5,\n \"createdDate\": \"2019-02-28T15:51:42Z\",\n \"expiryDate\": \"2019-03-01T15:51:42Z\",\n \"status\": \"PENDING\",\n }\n}\n\nGet a Fx Quotation.
\n","urlObject":{"path":["api","billstack","v2","quoteMePrice"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"054919d2-c4f0-4526-bbd0-eeaefb2af40f"}],"id":"eb69f6e0-0327-4285-9047-1a58d73e58d9","event":[{"listen":"prerequest","script":{"id":"690a0d1c-b0a3-485c-a9d5-be214089667c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e8ba384c-b7f1-4bda-92ed-6033bdf03542","type":"text/javascript","exec":[""]}}],"_postman_id":"eb69f6e0-0327-4285-9047-1a58d73e58d9","description":""},{"name":"Services","item":[{"name":"Retrieve List of All Countries","id":"fc14e807-a5bc-40fa-baaa-2fda2aee5cb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{auth}}"}],"url":"{{host}}/api/merchant/v2/countries","description":"\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n[\n {\n \"code\": \"UK\",\n \"title\": \"United Kingdom\"\n },\n {\n \"code\": \"IE\",\n \"title\": \"Ireland\"\n },\n {\n \"code\": \"DE\",\n \"title\": \"Germany\"\n },\n {\n \"code\": \"AU\",\n \"title\": \"Australia\"\n },\n {\n \"code\": \"CH\",\n \"title\": \"Switzerland\"\n },\n {\n \"code\": \"IT\",\n \"title\": \"Italy\"\n },\n {\n \"code\": \"SA\",\n \"title\": \"Saudi Arabia\"\n }\n]\n\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n[\n {\n \"serviceName\": \"CashIn-Live\"\n },\n {\n \"serviceName\": \"CashIn-Batch\"\n },\n {\n \"serviceName\": \"Billers-Live\"\n },\n {\n \"serviceName\": \"Billers-Batch\"\n }\n]\n\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n{\n \"bands\": [\n {\n \"frequency\": null,\n \"notification\": \"callback\",\n \"time\": \"08:20Z\",\n \"feePerOrder\": 0.5,\n \"percentage\": 1,\n \"min\": 20,\n \"max\": 999.99\n }\n ]\n}\n\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n[\n {\n \"serviceName\": \"CashIn-Live\"\n },\n {\n \"serviceName\": \"CashIn-Batch\"\n },\n {\n \"serviceName\": \"Billers-Live\"\n },\n {\n \"serviceName\": \"Billers-Batch\"\n }\n]\n\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n{\n \"bands\": [\n {\n \"frequency\": null,\n \"notification\": \"callback\",\n \"time\": \"08:20Z\",\n \"feePerOrder\": 0.5,\n \"percentage\": 1,\n \"min\": 20,\n \"max\": 999.99\n }\n ]\n}\n\n\n\nExample Response
\n
HTTP/1.1 200 OK\nContent-Type:application/json;charset=UTF-8\n{\n \"bands\": [\n {\n \"frequency\": null,\n \"notification\": \"callback\",\n \"time\": \"08:20Z\",\n \"feePerOrder\": 0.5,\n \"percentage\": 1,\n \"min\": 20,\n \"max\": 999.99\n }\n ]\n}\n\n