{"info":{"_postman_id":"8077f35e-e40b-431b-8598-82d98edaa591","name":"Aur Web Api - EN","description":"

Aur Posi - Web Api

\n

Current API endpoints are:

\n

Production: https://api.aurapp.is/figo/api/v1/store/web

\n

Test: https://test-backendapi.aurapp.is/figo/api/v1/store/web

\n

Access

\n

An API Key is required to be sent as part of every request, in the form of an figo-web-token request header.

\n

Callback

\n

The callback is an optional POST request sent to the external system when a charge request changes its state.

\n

Response fields are the same as in Get Status. Customer can choose to which URL the callback will be sent. The string: /orderupdate will be appended to the callback URL.

\n

Every callback request expects HTTP 200 OK response.

\n

The following is an example of a JSON sent to the external system:

\n
{\n    \"code\": 0,\n    \"message\": \"OK\",\n    \"state\": \"WAIT\",\n    \"orderid\": \"12345\",\n    \"token\": \"HxfMXM4Hm8x0JgLjUGGRsc1MlvCEe4khKA10j4Zpxt3+0IiD60x59rN2EgqL9XuRs+X4xL64tfdNN eTw2e9y3ngqjkkpkZiw\",\n    \"expires\": \"20160315121056\",\n    \"hmac\": \"aa2c845bbd9dc71e0c711e25c71dd056dc24e8dccd114c11c3c9700207a2fccf\",\n    \"amount\": 0,\n    \"transactionid\": null,\n    \"transactiondate\": null\n}\n\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Aur Posi - Web Api","slug":"aur-posi-web-api"},{"content":"Access","slug":"access"},{"content":"Callback","slug":"callback"}],"owner":"6855208","collectionId":"8077f35e-e40b-431b-8598-82d98edaa591","publishedId":"UVR5s9Vq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-12-13T14:32:49.000Z"},"item":[{"name":"Create charge request","id":"a05a0e02-712b-4b33-a658-2f97aa340e86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"figo-web-token","value":"{{webToken}}","description":"

Issued web token from Aur.

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"msisdn\": \"1234567\",\n \"amount\": 500,\n \"description\": \"Aur Posi Web Api\",\n \"orderid\": \"12345\",\n \"hmac\": \"aa2c845bbd9dc71e0c711e25c71dd056dc24e8dccd114c11c3c9700207a2fccf\"\n}"},"url":"https://api.aurapp.is/figo/api/v1/store/web/purchase","description":"

Required body parameters

\n

msisdn

\n

String The phone number of the recipient. Exactly 7 digits.

\n

amount

\n

double Amount to charge.

\n

description

\n

String Description for the purchase (shown in the users phone).

\n

hmac

\n

String hmac sha256 signature for the data. It is generated with the web key from Aur and the data is the msisdn and amount. E.g. if the msisdn is 1234567 and the amount is 500 then the data is \"1234567500\".

\n

Optional body parameters

\n

timeout

\n

int Timeout of the request in seconds. Defaults to 300.

\n

image

\n

String Base64 encoded image which appears with the charge request in the users phone.

\n

orderid

\n

String Order id from the external system.

\n

callbackUrl

\n

String The callback url that the callback will be sent to.

\n

Response fields

\n

code

\n

The request is successful if code is 0. Otherwise an error code is returned along with an error message.

\n

message

\n

Empty upon successful request, otherwise an error message is returned.

\n

token

\n

Upon succesful request, a token is returned that can be used to check the status of the request.

\n

expires

\n

Timestamp that indicates expiration time of the request if the user does not confirm nor cancel the request.

\n

deepLink

\n

Link to open the app at the right location, it is usefull if the charge reqeust is initiated from a app so that your app can have direct link into the Aur app.

\n","urlObject":{"protocol":"https","path":["figo","api","v1","store","web","purchase"],"host":["api","aurapp","is"],"query":[],"variable":[]}},"response":[{"id":"bd8d8acf-d45e-4e06-9a46-633402fb932e","name":"Example Charge Request","originalRequest":{"method":"POST","header":[{"key":"figo-web-token","value":"{{webToken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"msisdn\": \"1234567\",\n \"amount\": 500,\n \"description\": \"Aur Posi Web Api\",\n \"orderid\": \"12345\",\n \"hmac\": \"aa2c845bbd9dc71e0c711e25c71dd056dc24e8dccd114c11c3c9700207a2fccf\",\n \"callbackUrl\": \"https://example.com/aur/callback\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.aurapp.is/figo/api/v1/store/web/purchase"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"message\": \"\",\n \"token\": \"HxfMXM4Hm8x0JgLjUGGRsc1MlvCEe4khKA10j4Zpxt3+0IiD60x59rN2EgqL9XuRs+X4xL64tfdNN eTw2e9y3ngqjkkpkZiw\",\n \"expires\": \"20160315121056\",\n \"deepLink\": \"aur://tlist/1234\"\n}"}],"_postman_id":"a05a0e02-712b-4b33-a658-2f97aa340e86"},{"name":"Get Status","id":"3bf63189-96db-48a6-a5a3-51b1a0180d75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"figo-web-token","value":"{{webToken}}","description":"

Issued web token from Aur.

\n"},{"key":"request-token","value":"{{requestToken}}","description":"

Token returned from Charge Request.

\n"}],"url":"https://api.aurapp.is/figo/api/v1/store/web/transaction","description":"

Response fields

\n

state

\n

Indicates current status of the purchase request. Can be one of the following:

\n

WAIT - The request is still pending.

\n

FINISHED - Purchase request has been confirmed.

\n

CANCELLED - Charge request has been cancelled.

\n

code

\n

Code is 0 upon successful request. Otherwise an error code is returned along with an error message.

\n

message

\n

Empty upon succesful request, otherwise an error message is returned.

\n

orderid

\n

Order id which was sent with the original charge request (given that it was provided)

\n

token

\n

Request token returned in the original charge request.

\n

hmac

\n

The hmac value of state+expires+token (and +orderid if it is present)

\n

amount

\n

The amount of a succesful purchase.

\n

transactionid

\n

The transaction id of a succesful purchase.

\n

transactiondate

\n

The timestamp of a succesful purchase.\n

\n","urlObject":{"protocol":"https","path":["figo","api","v1","store","web","transaction"],"host":["api","aurapp","is"],"query":[],"variable":[]}},"response":[{"id":"2e3154d0-7bb9-4f76-bd5a-8a5ff893a62c","name":"Pending Charge Request","originalRequest":{"method":"GET","header":[{"key":"figo-web-token","value":"{{webToken}}","description":"Issued web token from Aur."},{"key":"request-token","value":"{{requestToken}}","description":"Token returned from Charge Request."}],"url":"https://api.aurapp.is/figo/api/v1/store/transaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"message\": \"OK\",\n \"state\": \"WAIT\",\n \"orderid\": \"12345\",\n \"expires\": \"20160315143131\",\n \"token\": \"HxfMXM4Hm8x0JgLjUGGRsc1MlvCEe4khKA10j4Zpxt3+0IiD60x59rN2EgqL9XuRs+X4xL64tfdNN eTw2e9y3ngqjkkpkZiw\",\n \"hmac\": \"aa2c845bbd9dc71e0c711e25c71dd056dc24e8dccd114c11c3c9700207a2fccf\",\n \"amount\": 500,\n \"transactionid\": \"72BAYROZ778S\",\n \"transactiondate\": \"20160315142723\"\n}"},{"id":"30b907ec-6f16-44af-ab94-919abac23309","name":"Successful Charge Request","originalRequest":{"method":"GET","header":[{"key":"figo-web-token","value":"{{webToken}}","description":"Issued web token from Aur."},{"key":"request-token","value":"{{requestToken}}","description":"Token returned from Charge Request."}],"url":"https://api.aurapp.is/figo/api/v1/store/transaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"code\": 0,\n\t\"message\": \"OK\",\n\t\"state\": \"FINISHED\",\n\t\"orderid\": \"12345\",\n\t\"expires\": \"20160315143131\",\n\t\"token\": \"HxfMXM4Hm8x0JgLjUGGRsc1MlvCEe4khKA10j4Zpxt3+0IiD60x59rN2EgqL9XuRs+X4xL64tfdNN eTw2e9y3ngqjkkpkZiw\",\n\t\"hmac\": \"aa2c845bbd9dc71e0c711e25c71dd056dc24e8dccd114c11c3c9700207a2fccf\",\n\t\"amount\": 500,\n\t\"transactionid\": \"72BAYROZ778S\",\n\t\"transactiondate\": \"20160315142723\"\n}"},{"id":"5553a753-32b9-4453-a2f4-9d94fa5c067c","name":"Cancelled Charge Request","originalRequest":{"method":"GET","header":[{"key":"figo-web-token","value":"{{webToken}}","description":"Issued web token from Aur."},{"key":"request-token","value":"{{requestToken}}","description":"Token returned from Charge Request."}],"url":"https://api.aurapp.is/figo/api/v1/store/transaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"message\": \"OK\",\n \"state\": \"CANCELLED\",\n \"orderid\": \"12345\",\n \"expires\": \"20160315143131\",\n \"token\": \"HxfMXM4Hm8x0JgLjUGGRsc1MlvCEe4khKA10j4Zpxt3+0IiD60x59rN2EgqL9XuRs+X4xL64tfdNN eTw2e9y3ngqjkkpkZiw\",\n \"hmac\": \"aa2c845bbd9dc71e0c711e25c71dd056dc24e8dccd114c11c3c9700207a2fccf\",\n \"amount\": 500,\n \"transactionid\": \"72BAYROZ778S\",\n \"transactiondate\": \"20160315142723\"\n}"},{"id":"a26b0a19-2dd3-4a20-be29-20997b846aa9","name":"Canceled Charge Request","originalRequest":{"method":"GET","header":[{"key":"figo-web-token","value":"{{webToken}}","description":"Issued web token from Aur."},{"key":"request-token","value":"{{requestToken}}","description":"Token returned from Charge Request."}],"url":"https://api.aurapp.is/figo/api/v1/store/transaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"message\": \"OK\",\n \"state\": \"CANCELED\",\n \"orderid\": \"12345\",\n \"expires\": \"20160315143131\",\n \"token\": \"HxfMXM4Hm8x0JgLjUGGRsc1MlvCEe4khKA10j4Zpxt3+0IiD60x59rN2EgqL9XuRs+X4xL64tfdNN eTw2e9y3ngqjkkpkZiw\",\n \"hmac\": \"aa2c845bbd9dc71e0c711e25c71dd056dc24e8dccd114c11c3c9700207a2fccf\",\n \"amount\": 500,\n \"transactionid\": \"72BAYROZ778S\",\n \"transactiondate\": \"20160315142723\"\n}"}],"_postman_id":"3bf63189-96db-48a6-a5a3-51b1a0180d75"},{"name":"Cancel charge request","id":"703c0fe9-0c5b-4b8a-88ce-d534fec4a755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"figo-web-token","value":"{{webToken}}","description":"

Issued web token from Aur.

\n"},{"key":"request-token","value":"{{requestToken}}","description":"

Token returned from Charge Request.

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.aurapp.is/figo/api/v1/store/web/cancel","description":"

Description

\n

Request for cancelling charge requests.

\n

Response body parameters are similar to those in Get Status request.\n

\n","urlObject":{"protocol":"https","path":["figo","api","v1","store","web","cancel"],"host":["api","aurapp","is"],"query":[],"variable":[]}},"response":[{"id":"a8e0c3fc-0424-4e83-b20d-171ec09c753c","name":"Cancel charge request","originalRequest":{"method":"DELETE","header":[{"key":"figo-web-token","value":"{{webToken}}","description":"Issued web token from Aur."},{"key":"request-token","value":"{{requestToken}}","description":"Token returned from Charge Request."}],"body":{"mode":"raw","raw":""},"url":"https://api.aurapp.is/figo/api/v1/store/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"message\": \"OK\",\n \"state\": \"CANCELLED\",\n \"expires\": \"20160515221426\",\n \"amount\": 0,\n \"transactionid\": null,\n \"transactiondate\": null\n}"}],"_postman_id":"703c0fe9-0c5b-4b8a-88ce-d534fec4a755"}]}