{"info":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","description":"

The Developer API is designed to allow businesses to integrate with Penny Inc system and easily make it part of their workflow, this API allow develoeprs to manage cards, cardholders, transfers and transactions.

SANDBOX: https://api-dev.thepennyinc.com/api/v1/.

PRODUCTION: https://api-prod.thepennyinc.com/api/v1/.

Contact Support: support@thepennyinc.com

Development Access

To get Access Keys to development environment, please sign up at https://central-dev.thepennyinc.com.

Go to Settings->Developer API and generate a new Key.

Authentication

All requests are authenticated using API Key which can be found in the settings section of Penny Central account.

The API Key must be sent in all requests in the headers, the header used is X-PENNY-API-KEY: <VALUE>.

Making Requests

All APIs within the Penny inc platform follow the same pattern for requests and responses.

APIs accept JSON objects in the request body, and return same response structure as follows:

   {\n        \"success\": \"false or true, indicates if an operation was successful or not.\",\n        \"result\":{\n            \"message\": \"Error message in case of success = false, or API message in case of success = true. \"\n            \"<data>\": \"this attributes may or may not exist, depending on the API you are calling, for example when calling `GET /cards`this attribute will be named `cards` and will have a list of returned cards\"\n        }\n        \n   }\n

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3428348","collectionId":"f1804e12-f883-4bd6-89b1-0d47a43af589","publishedId":"SzYbxwbE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-04-04T16:36:53.000Z"},"item":[{"name":"Cards","item":[{"name":"Order Cards","id":"b9fd7001-ffc3-4f6f-8982-ec2cce244138","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API Key

\n","key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"method\": \"UPS_NEXT_DAY_AIR\",\n \"quantity\": 120,\n \"recipient_address\": {\n \"first_name\": \"Redwan\",\n \"last_name\": \"HILALI\",\n \"address1\": \"600 California St\",\n \"address2\": \"\",\n \"city\": \"San Francisco\",\n \"zip\": \"94108\",\n \"state\": \"CA\",\n \"country\": \"US\"\n }\n}"},"url":"{{API_HOST}}/orders","description":"

Order new cards to be delivered to a specific address.

Request Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
method *	String	The shipping method to be used for the new cards. Must be one of the following: `UPS_NEXT_DAY_AIR` `UPS_SECOND_DAY` `FEDEX_PRIORITY` `UPS_GROUND` `FEDEX_2_DAYS` `FEDEX_GROUND` `USPS` `FEDEX_INTERNATIONAL` `UPS_WORLDWIDE_EXPIDETED`
quantity	Integer	Number of cards to be ordered.
recipient_address	Object	The address to which the new cards should be delivered

The recipient_address Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
first_name	String	The recipient first name.
last_name	String	The recipient last name.
line_1	String	The shipping address line 1.
line_2	String	The shipping address line 2.
state	String	The shipping address state, must be valid state in two letters (example: NY, CA..)
city	String	The shipping address city.
zip_code	String	Valid zip code.

","auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":""},"isInherited":true,"source":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","type":"collection"}},"urlObject":{"path":["orders"],"host":["{{API_HOST}}"],"query":[],"variable":[]}},"response":[{"id":"3d892098-173f-48c6-8a77-e0e4874e8c6c","name":"Server Error","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"method\": \"\",\n \"quantity\": \"\",\n \"recipient_address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n }\n}"},"url":"{{API_HOST}}/orders"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message\": \"\"\n },\n \"success\": \"\"\n}"},{"id":"49c62cb0-54dc-47a0-9afe-78d25eed5318","name":"Order Cards","originalRequest":{"method":"POST","header":[{"description":"API Key ","key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"method\": \"UPS_NEXT_DAY_AIR\",\n \"quantity\": 120,\n \"recipient_address\": {\n \"first_name\": \"Redwan\",\n \"last_name\": \"HILALI\",\n \"address1\": \"600 California St\",\n \"address2\": \"\",\n \"city\": \"San Francisco\",\n \"zip\": \"94108\",\n \"state\": \"CA\",\n \"country\": \"US\"\n }\n}"},"url":"{{API_HOST}}/admins/companies/{{COMPANY_ID}}/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin, X-HTTP-Method-Override, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"56"},{"key":"ETag","value":"W/\"38-tPFkr7UPgDG7dHv/JcXI/zliq1k\""},{"key":"Date","value":"Sat, 28 Mar 2020 17:25:44 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"message\": \"ORDER_CREATED_OK\"\n }\n}"},{"id":"4f74755d-2ad9-4de5-96a2-26ba7f41d403","name":"Bad Request or Missing Fields","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"method\": \"\",\n \"quantity\": \"\",\n \"recipient_address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n }\n}"},"url":"{{API_HOST}}/orders"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message\": \"\"\n },\n \"success\": \"\"\n}"},{"id":"ef15fc0e-1dce-49b2-b2a6-c0b5e7fe7dc5","name":"Order Created successfully, and cards will be shipped","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"method\": \"\",\n \"quantity\": \"\",\n \"recipient_address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{API_HOST}}/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message\": \"\"\n },\n \"success\": \"\"\n}"}],"_postman_id":"b9fd7001-ffc3-4f6f-8982-ec2cce244138"},{"name":"Create Virtual Card","id":"01c00e11-6497-4e33-bb4d-1e1fa2620ef9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API Key

\n","key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{API_HOST}}/orders/virtual","description":"

To create a virtual card, issue a POST request to /orders/virtual.

List all cards with ability to filter by different criterias. This endpoint supports Pagination.

By default, newly created cards aren't assigned to any cardholder, and they need to be assigned before being used.

To do so, send a PUT request to /cards/<id>/assign and include employee_id in the body in JSON format.

Notes

if a card is already assigned, the request will fail. Only unassigned cards can be assigned, you must call unassign API first in this case.
Only one card per cardholder can be assigned.

Request Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
employee_id	String	The employee to be assigned the card.

Penny Offers the possibility to reassign cards as needed, in case you need to unassign card issue a PUT request to /cards/<id>/unassign.

Notes:

If the card has any balance, you must transfer it first to business main balance (GPA).
Card state will not change (ACTIVE, SUSPENDED ...) after it is unassigned.

API Key

\n","key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{API_HOST}}/companies/{{COMPANY_ID}}/orders","description":"

To list all previous cards orders, issue a GET request to /companies/<id>/orders.

Retrieve a single card details

\n","auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":""},"isInherited":true,"source":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","type":"collection"}},"urlObject":{"path":["cards","{{CARD_ID}}"],"host":["{{API_HOST}}"],"query":[],"variable":[]}},"response":[{"id":"47f171a4-5775-4a65-9f8f-bd8d45704c69","name":"Retrieve a card","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"{{API_HOST}}/cards/{{CARD_ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"386e-u//qS991DyW16SDKoZE1edlq7nU\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Sat, 04 Apr 2020 08:42:15 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"_id\": \"5e88452beacf8b6743841ed3\",\n \"balance\": \"0.00\",\n \"description\": \"PENNY INC\",\n \"type\": \"VIRTUAL\",\n \"expiration_time\": \"2023-06-01\",\n \"expiration\": \"0623\",\n \"user_token\": \"1585988906049\",\n \"mqt_card_token\": \"222W39C2W4\",\n \"company_id\": {\n \"address\": {\n \"country\": \"US\",\n \"line_1\": \"600 California St\",\n \"zip_code\": \"94108\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\"\n },\n \"trading_address\": {\n \"country\": \"US\",\n \"line_1\": \"500 Texas St\",\n \"zip_code\": \"90908\",\n \"city\": \"Albaquerque\",\n \"state\": \"NM\"\n },\n \"incorporation\": {\n \"state_of_incorporation\": \"NV\"\n },\n \"officer\": {\n \"home\": {\n \"line_1\": \"App 14 Rabat\",\n \"zip_code\": \"90900\",\n \"city\": \"Rabat\",\n \"state\": \"NJ\",\n \"since\": \"2017-01-12T00:00:00.000Z\",\n \"phone\": \"666-503-2322\",\n \"cell\": \"343-434-3333\"\n },\n \"first_name\": \"retry\",\n \"last_name\": \"HILALI\",\n \"title\": \"CTO\",\n \"ssn\": \"232-32-3232\",\n \"dob\": \"1988-07-14T00:00:00.000Z\",\n \"is_shareholding\": true\n },\n \"signature\": {\n \"image\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAd8AAACCCAYAAAAHZ8LFAAAagUlEQVR4Xu2dC/C/WT3H38kmS7HV7k5pUS3Rxmq2Iisxk5lKWzQKhWwhxJItuVWIMrRtuYTQWrqRmbRRaca4xK5GDWLpokGIjUQx0Y5lXu359P909vn+vrfnOc/tfWZ+8/tenudcXud8n/e5fM7n3EwOJmACJmACJmACTQncrGlqTswETMAETMAETEAWXzcCEzABEzABE2hMwOLbGLiTMwETMAETMAGLr9uACZiACZiACTQmYPFtDNzJmYAJmIAJmIDF123ABEzABEzABBoTsPg2Bu7kTMAETMAETMDi6zZgAiZgAiZgAo0JWHwbA3dyJmACJmACJmDxdRswARMwARMwgcYELL6NgTs5EzABEzABE7D4ug2YgAmYgAmYQGMCFt/GwJ2cCZiACZiACVh83QZMwARMwARMoDEBi29j4E7OBEzABEzABCy+bgMmYAImYAIm0JiAxbcxcCdnAiZgAiZgAhZftwETMAETMAETaEzA4tsYuJMzARMwARMwAYuv24AJmIAJmIAJNCZg8W0M3MmZgAmYgAmYgMXXbcAETMAETMAEGhOw+DYG7uRMwARMwARMwOLrNmACJmACJmACjQlYfBsDd3ImYAImYAImYPF1GzABEzABEzCBxgQsvo2BOzkTMAETMAETsPi6DZiACZiACZhAYwIW38bAnZwJmIAJmIAJWHzdBkzABEzABEygMQGLb2PgTs4ETMAETMAELL5uAyZgAiZgAibQmIDFtzFwJ2cCJmACJmACFl+3ARMwARMwARNoTMDi2xi4kzMBEzABEzABi6/bgAmYgAmYgAk0JmDxbQzcyZmACZiACZiAxddtwARMwARMwAQaE7D4Ngbu5EzABEzABEzA4us2YAImYAImYAKNCVh8GwN3ciZgAiZgAiZg8XUbGJLAJ0t6tKQrJf3tkAk5bhMwAROYEwGL75xqaz55RXRfLOk+JcvvkvRMSc+ZTxGcUxMwARMYjoDFdzi2a475RyQ9uQLw95I+cc1QXHYTMAETCAIWX7eFIQi8WtIDqoj/QdI5QyTmOD9EwNP8bgwmMBMCFt+ZVNSMsvkJkt4u6aOqPP+6pC+dUTnmltVLJX2HpDtIeqekH/M0/9yq0PldEwGL75pqu01ZXyDp4o6kXijpq9tkYXWpfK2kyyV9fCr5n0q6x+pIuMAmMBMCFt+ZVFQP2fwqSYyOLpOEEPYdGPFeIuk7N0T8ckkP6ztRx6efl/TYDg6vlPQQ8zEBE5gmAYvvNOulz1yxDsio6EtKpDcUw6d/7DGRj5XEw/4LSpwvk/SOIvaRzDMkfW+Paa49KjpTP1GNdjMTZh9+ce2QXH4TmCoBi+9Ua6a/fLHl5yur6H5Q0tN6SuLhkuKPKBHeR0h6tqQnpDT4jO8cjidA3T1e0pklquslnZaitWX58YwdgwkMSsDiOyjeSUT+dx1bfH5f0v16yF0tsIy0mNr+N0l/IOnClMZ5kv6yhzTXHsU3SPqhE4T33ZJut3ZILr8JTJ2AxXfqNXR8/hgF3bGK5gpJjzky6l8tI96IBuHNhlb/kkTgWkl3PzI9336jt7Dvk3RugvFfkj4mvcfKedO6uxmagAlMhIDFdyIVMUA2WOv9DUmMOOvw55I+88A0H1i2tNw/3f98SY9L71n7fW2aCn26pKcemJ5vk1jfhfFHVzB+U9IXp8/wJHa2gZmACUyfgMV3+nV0SA4/T9Lryo1vLFtOPiJFhJ/lOx0QMYZb317dV6/l3l7SH1bxY3WLQZbD/gSwImf2ov6tMpvAksKDUpTfJunH90/Cd5iACbQmYPFtTXz49DB+YkqY8LuSvl7SWyRl8X29pM/ZIyu3KdOd2YCK27ssah9cCe0xo+w9srjYSzFS+7KqdBhYfYukn02f19P+iwXigpnAEghYfJdQi6fK8DeSmG7GlSPejsK6+H2S2A4U4a2S7rpj0WtrZm5DvPHfjNeqOjDy+tb04UVl+nvH5HxZRQDjtTOqz+hcYbz2/elzHJgMsX/bFWICJjAAAYvvAFBHiBIL2BgFMR35XZXgMQ38uSlfjIi/cId83lfS70i6+R4jrLclgyCMrs6X9E87pOVLPpwA0/evkHSvCgwGVnSk3iDpgvLdocsIZm4CJjASAYvvSOB7SjYc6ccI6ImSfk7Se6v42VqEkEb4Y0n3PiEPGO1gWJVdFiKkGE7h2GFTuJskxD/C88p+1J6Ku6pomK7vshD/uuI7m05RBLyWUfcOJmACMyFg8Z1JRXVkMxtVYQmLAG8aYdZ7bp9S9op2lR4/wWxV+fT0Jd6wGE1vm9ZkKpvp0FhfZsr61+aLeLScXyWJ6fo6xLpu3ubFvt57SmL062ACJjATAhbfmVRUlc2rJf1WEbpdvEZhcPWpKY5PK0ZYOVq8YDF9HS4i+Y642RPMEYG7hGzsxfUPlYSQOOxO4MslvbTj8rxUEGv7XEan6wd2j95XmoAJTIGAxXcKtXByHphaRhD549QafDSz/WQf38zvl3TLkswHquP+iBfnDYx4c0DgGX1h8LNrYN0ZAc/hX5M3pl3jWfN1XWchs4xAh4mZjW+W9FMFEIZ0bDViZsPBBExgRgQsvtOsLEQWUWTkiGEU041YFnNM3L6hXodFiE8vkbCu+6qOCHc1yKpv/ecNTh58ws7utfbXku5SXY5/7keVz+olBDo3P+yze3cH7CtNYAoELL5TqIVTeWBUi+By6DyCiwjy9+9HZBMRz8Y5REW911PEkQRGVmxTOiT8h6Rbd9xoz0u703yTpM9Il2Pd/Cll1LupzpgFqV2I7p6irzQBE2hOwOLbHPlNEoxpX4T398oIl1HuMYKbE8nbkPgcj1f81dPDfHfoiDfSq4UjPj823vFrqV0O8EyGARXLBEwz/2gZ1W4SXnKWZzPa5dQpmYAJHEzA4nswuqNujBEuU8pMJSO2fQruSeL732n9N1/Xh4ck1o3z9qSI/68kMf3tcDIBOmLwY4oZsb2yWDHj0OTJJ9zKVDWjYwcTMIGZELD4tqmobDTFa0aCiO6xU8q75B43ktdsuZBOAHnpIyCy7Cu+bYrM4rud7J2LW05ENx+9SHvBo9hZJ0Sxj8ey7TnxFSZgAoMTsPgOgxiDKUaBTB3zmsBrBK71fsyfqU4cyiVmxPQ9Axxy/6QyXZrTcls7ua2xH/pXOuoCt5G/tKWZvqY4RRmmNTtWEzCB3gn4gXg8UsQ1rJM/K1kk8xlTuX2t3R6aU46dyyffRDzhpvDQeE+6jz3F7C3OwVuONhPDaQaewbr26zIKzg5PumJhSpq1YQcTMIGZELD47l5RIbL8D7eOOLyPqeOxRrbbSvAsSZd2XNR1ItG2uPb5/h2Szqlu8JF3NyVI/fx0cRlZf/sVkthmVP9OOUrwk9LFjIzZq+1gAiYwEwJrF98sqFQZohqf8Z6R7MeVPbc4uUdgmTaOv0P23bZuGnhMekl6gDPi5Tg6RuVDh+s61ioRZE5dcrjxcAQC1s114NxkRrOnVV+wfs/5vpyjHOEnq5OkzNYETGDiBJYkviGU/A8BDTGNauA9fxHYlxqCyme8RlBjXTbEdQ4ie1JTY8oXA6j3SMIndDboGbqJ/l+VAAczXDJ0ojOI/05lRoKOUFf4k9L5y9/lLVt/JOmzizHWPmczzwCNs2gCyycwV/FFQO9XRqSILX8E9smGmPI/xDRqElGNz5dfu6dKGAL45h3WD/vm8iJJj6wixWf0Mw702NV3/saI72kl0ZN8MteHK+BiklmYHNia1JeV+hgcnKYJrJbAnMQXgWVdiz2yiG84pEBQW2zZmWsjuTD5/sUhP1taWgbOpX1u2bea02X6+3GSXiuJ4wrXFBDfbYch5D3T/1mmlVssFaypHlxWExiNwBzEF7EN0eUh3ofLxdGAj5AwnZTPL+ligYyD/tYBwcdRBHtY60DniSMM8TGNIC813ELSd+8gurn87JmGGTMFLZcKlloHLpcJTIbAlMUXH8fPKYZCHJs2lAeoyVTGQBnBuIlTkCKMWeecxoMBWHbAEfli9Mv320aEA2EaPFoszjmxyCI6OGonYALTJzDmg3gTHaaXmZa7hyQsPhFdh8MInC2Jk4ZyGLvOYxqaPHWNhPmcTtdlC7GKZvRKe36KJDxROZiACZjATfYPjokEC2UeUrg65OHr9a3ja+PBxWXhlMQ38hIuNzng4T4bivoLZQ8sB0HMMdC5oE0z7b/PuchzLKvzbAImsAeBsUdBkVVGu4gt63+Mdlu7YNwD2awu5cHPlH0EuLLFZUqBThfONxCq8zZkjHz/tqQXzsy6F89V8PdU85RanPNiAhMgMAXxxZgKQypE16PdfhsF5/iyHSXC1I/2Yw8yVr6PPQFDbCVjOYLy/NkEXHjm7OIUgxOGLLj9tmXHZgKLIjC2+F5RRmI8cD3a7bdpnSmJQ+xzeGdlfNVviv3FRt4vknSBpFtJwlf0XdMhFXVKOEGJU6JoR1h4jxVYZ8egzOI7Vg04XROYAYGxxJepxpcX5/vfOANOc8wiwhXuC3P+x6rzPhgyimeJgv9Yw58UYksaYszouJWXMka+1/dRWMdhAiawXAJjPIhDeHkgMtXsMAyBer03Uhmjzocp4SkhDkHOhw10pRmuQ2OUzAEFx864xPGRGAk6mIAJmMBOBMZ4EPOQigfWTpn0RQcRqNd7lyi+NRjaVQhxuB3dJsjEgRhnv96832UtmTToQNKmW42sD2oMvskETGBaBFqLL9OFPKj4P/Y5t9Oqif5z825Jt+mItnWd91+y/WIMQY5DNeI/n5+/JSpGxW8rJwuxjsx7/Cvz+mGSzu3wW71f7ny1CZjAKgm0fhAjuAivRwnDNjcMljhP95aSbpCET+e7lAPb7z5s0rOMPc5o5j8hTsaivdKBCfecXYKdD/KIoybzZ5ycFQd6zBKOM20CCyeQj5GlqDEwHHSA2FJ8sWiOabqF1+XoxauNrTgR59alUZ0xeu7mmwE6jmxxwkiQI/0YRYdQx8laMbKuTyCi1Fmc81GWMe3NNX2sQ8+XsHNuAvsRiA5z7kDz28tns+dz2/kc3cu/v0iRz7g2Tr6L15FGXBe/V37z/Kbj/V4njLUUXzLo6eb9GtahV9PRYRsX4dpyoD2jYfwnn3VopCu+jx8sBmx0XGC7a484ny0d4hzT4DHC7hLp/DDID4n6SMwwFuN/nE29xiMzV9w0Z1P0LIDx+4nP4j3HxIatRf69UEh+gywT8X0+kz3HlX8f8TuI/0PMPoXAEzevY0aXfPKsvU7S/26qoVbiC0g8/XBCkcPwBLKlMyfiILxx9ivuOx12JxB2CjiAGdKiOYtyPGzydFj0vuMHHyXIPX9eI+aMnnnoYGzG+nQ8FPj+PWkfNL/LOI6z7t3n+OM86MgX//P18Zp0CadLuld5UPJg4qEa30W+eB8jC/IZ77k/RiCkmzsT2zo9dEByx+VYS/bdW8kyr4zRZHQQoz1m8YuZHrQE3tHhrIUw2k4eKUZ8tMFo/zF6zCPQaG9do9WpksdhEHY395X0/K5MthLfeHB5rbdNU2HUywiN8HhJTyo9sym6l2xDZP9UeKiEa04smrc9+PdPYfg74uGZRwc51bC/iIdgPDizuIawxoOP91nUQii5Jz5nn/MXJdGP6TmujYd1ntrjM+7NnY0cb+5g5PzvYsm+jTLPpHjQh/DX9+S6jzLmKcptafB9THXmjkzMVsT95IPv8+eMomIpgu95T4cqXtcjxVzXiCZxwTfy29V5i3TD9Wwtcnn0GHmNJZRglkeau/BYwzUcqvKSskx1TV3gVuIbw/I1AJ9CGfPIl1Evo1+PfHerGR5OzNDwQAp/47vd6aumRCALeR6pdeUxxCk6HfnefcuUhbxLxPOMQXQ4suhHRyTEjI5L7vjwfddIMa7LnZq6oxTly7MJnh3Yt4b3v/4vyoFBTEV/KLQQ3zCyipHY/ln3HfsSCPG9WtKFZaoxHgo2uNpMkxEuD7fwG70vd19vAiawbgI8P1hmCT8D4Vv/JlrbQnyZuqN35UMT2jXKMLiCPYfT4+PZBlfd/MNimR8J7XTIdd12LcApmYAJDE0gjMCyY58u2wmWAR9TZ6aF+DJFggjsZYY9NLWFx0+joMIvLoKS15la1Pkc8MKITgp/tE17qZpDrTmPJjAOAUaz0VEPse3KCWvwPE/isJeNdk4tHsRkJB9rNw66dadq8T1V//yAOD8Y0cWQhalmdwzX/ftw6U0AAmHEFkaBIbKbdgLEgS35VLWdSVp8d0Y1uws5yP0RJdd4uApDjrBonF2Bjsww5b+8dAT5MTEdb4OqI6H6dhOYEYEwpMNKPjvHiRHtpqJgMZ6PLA2xParoLcQX4xXv7z2qmva+GRP3EF/OlY1DFhjhrW2fLz+yEF1Ask3DyyB7NynfYAKTJoCAIqqxvS72DedtdNsKwEg2tlDF/vfBZsVaiK+nnbdV+TDf55HvGqed6fAxvRxLHkwxs65rg6ph2ptjNYG+CcT0L8+v+B2HqMY0cXjC2pZ2PqUsBDWENrt33RZPb9+3EF8Ktiug3grmiD64WT/qdy3iyw/zoWVkm/d2MsWM6M7RUYabsgksjUDtahVnILVv9E3rrPVBJV0uV7MjlMk6drL4Lq1ZnyrPc8se33uuYKsRQsve5novOQwQXTsSWG47d8mmQyAcfZAjOsGMNgnMQKE14d8/3JrmnIeIZh/MtX/mRXWeW4gvQ3wein4Atv2RfI2kK0ujX+qaL+3q0ZU1PT3jcGfqNte2zTm1ZRHIbj1jT2v46Oa7mArmGR9GS7Gsg8Bi7xPTw0McbDBr2i3El8qwx6BxmskbJDHyxZn+Ujxc8SOnVx3eqIIsD4UQ3UX1kMdpOk51oQTCIClEMZZnwgI4fEHHdG3tyzoElfuzm8qF4hquWC3El94Rf+GkfrjSOOZMgEPg3yTpjguZdqYnzfRV+F2OsmK9HB08twATWBOBvHWGcueDMeIABa5heyH/wyc0oom45iMpuw5PWBPL5mVtIb4UykZXzav2gwniVpITjbJrz1Z13keJeWAgtpdIukeKkN45gut9un1QdhxjEsjWuxhGhqDGiDR/Tz7DAjhOOuKz+vi+GLVaUMes2S1pt3oQ86Ck15WnLCaMZTFZu0rSnSWdl0rUqs6PgRij3NqACgOOEN1j4ve9JnAogbwOGq+x1uV3lQUzj0TjDGM6jcwCxrJIntLNIsrrOMkorq3fH5p/3zcRAq0exDxMeWjazWTbin94cbaRUz1L0ocdbdU2SxtTi21CrOXWW9MwHHt2mUafSHadjZkQqI8HzFtY8NcbFrm8ZjSJyNH+ENIYQcYJNeF4IZ81HBhqy9wQ0CykM0HmbLYg0Ep8KQtrvjRQOzloUbM3phEPEHrmEfBwNZjXlgOKRocMi+V6LddTywfAHOmWcF2aR4UhYjlLeb95ndUsimEUlEUuXvPMyt+H6MVRbghoOE3gO9pVOLqPddBo//WWl3wWro2JRmpMa0m2pfjygwnDGE8/t2thz5P0TSk5prqeKumX22XhJinxQGSkwf/sDIMLPbXcXTFwCgEKoYopyfiOO2M0x3d5NJfFKcdzfmHOZyFOtZjmOkLYcnqHNKM4RH7T9pPIX33oe7Ziz9/Zuv2QWvA9oxJoKb5RUH68jIItwG2qngclByvU4XpJL5D0CkmvHjgrjDAQAka5XX6+5743t94PCc4sZnnmge/C+jREg/vZ6sGoLeKK9cAY5eUpz3BmEPsruSZPkcbIjs/zXufYbpar2yO8gRu/ozeBLgJjiG+MgPnRx1S0a2c4AmcWq+eTUuBhzd9LJb2lh6wgsoyoYptZl6s4BJcOWPz1kOzWKPL2C9pfiGJtYRoR5evjs3xtOBzIhjN57S9EOP53jfRqo5uthfAFJmAC8ycwhvgGNUZAWLPyMIsHsD0S9d+mzikj35tLukHS6yXdQtIFG5J6o6S3lqlITkR6X7U/sL4Ngb29pHsXy+r7Szr9hLhx/PFeSa8qo8N6ahRBZOo5RnyIeIhcjCYj+vxdNqzJ06J59FdPZ2ZL0pzlvFUjPre1af9t0zGawGoJjCm+eXSR1/6yj89RTptYWGtAZBG8CHi8QmCxhH5Qhz/kTcXHQvo0Sf9TBPlsSbc6gdX7Jb25WCiHmHVNjcb6Ym1ck0eaeQSZxbDr84VVn4tjAiawRAJTEN+aa4x4WNdiVBWeWRDlbMW4xProo0wxVUpcvKZjgzVxhGsk3aGsBcLzDEm3K6NWruH1RxbuHyij5F3yxYj6aknXSnr7xCyqd8m/rzEBEzCBZgSmKL5dhY99duG8O6YA61FyM3AjJBSdEpKmU8L0LJ9hvBPTsTGNmrngXvLpKb+7bDVCkPEHzb3nltEuQnzbyjqZ6WamhF9XBHcELE7SBEzABOZHYC7i20U23KwhRDHaC/EJa88YKU99LTl8sobVa7iUQwQJfB++WPN6ZBwGfZLFKkftZb/avOZ8WwcTMAETMIGRCMxZfDchCyELLzXZ2TjCxUb/GDnng5lrK9VDqyRbyJJWfh+jV/4jrNmLTu4o1CP7Q/PCfRi1XZEiuLjy9XxM3L7XBEzABEzgAAJLFN+TMMSIMm8XidfxH+EL94ZhKZu3ymQHBUz9hoBHuvXUb7zP69Utz7ZkZoDzfCPsMu18QFPyLSZgAiZgArsSWJv47splSde9SNIjU4FeLOlRSyqgy2ICJmACcyNg8Z1bje2f32dJujTddpmkJ+4fje8wARMwARPoi4DFty+S040H15EPSNl7jaQHTje7zpkJmIAJLJ+AxXf5dXydJI4RjPAuSTjIcDABEzABExiJgMV3JPANk8XYKp+jzDYsjK4cTMAETMAERiJg8R0JfMNkr5J0UUrvlZIe0jB9J2UCJmACJlARsPguv0mwz/fy4g2LbU9P8D7f5Ve6S2gCJjBtAhbfaddPX7m7WzlI4WWSOKnIwQRMwARMYEQCFt8R4TtpEzABEzCBdRKw+K6z3l1qEzABEzCBEQlYfEeE76RNwARMwATWScDiu856d6lNwARMwARGJGDxHRG+kzYBEzABE1gngf8HV9yTv+AsOl4AAAAASUVORK5CYII=\",\n \"first_name\": \"Redwan\",\n \"last_name\": \"HILALI\",\n \"email\": \"hilali.redwa.n@gmail.com\",\n \"title\": \"CTO\",\n \"phone\": \"066-665-3536\",\n \"date\": \"2020-01-05T20:39:53.972Z\"\n },\n \"auto_reload\": {\n \"trigger_amount\": null,\n \"reload_amount\": null,\n \"enabled\": false\n },\n \"active\": true,\n \"verified\": true,\n \"bank_verified\": true,\n \"approved\": true,\n \"dwolla_approved\": true,\n \"ready\": true,\n \"cleared_total\": 0,\n \"gpa\": {\n \"balances\": {\n \"USD\": {\n \"pending_credits\": 0,\n \"credit_balance\": 0,\n \"available_balance\": 0,\n \"ledger_balance\": 0,\n \"currency_code\": \"USD\"\n }\n },\n \"pending_credits\": -102,\n \"credit_balance\": 0,\n \"available_balance\": 0,\n \"ledger_balance\": 0,\n \"currency_code\": \"USD\"\n },\n \"_id\": \"5dbdc9abc0113f001e35de55\",\n \"principals\": [\n {\n \"ownership\": {\n \"percentage\": 45,\n \"since\": \"2019-01-11T23:00:00.000Z\"\n },\n \"home\": {\n \"line_1\": \"App 14 Rabat\",\n \"zip_code\": \"90900\",\n \"city\": \"Rabat\",\n \"state\": \"NJ\",\n \"since\": \"2017-01-12T00:00:00.000Z\",\n \"phone\": \"666-503-2322\",\n \"cell\": \"343-434-3333\"\n },\n \"_id\": \"5e124990964572a9a3253ae5\",\n \"first_name\": \"Redwan\",\n \"last_name\": \"HILALI\",\n \"dob\": \"1988-07-14T00:00:00.000Z\",\n \"title\": \"CTO\",\n \"ssn\": \"232-32-3232\"\n },\n {\n \"ownership\": {\n \"percentage\": 55,\n \"since\": \"2015-01-12T00:00:00.000Z\"\n },\n \"home\": {\n \"line_1\": \"Brisbane St\",\n \"zip_code\": \"88988\",\n \"city\": \"Brisban\",\n \"state\": \"OK\",\n \"since\": \"2017-01-12T00:00:00.000Z\",\n \"phone\": \"334-334-3344\",\n \"cell\": \"445-454-5444\"\n },\n \"_id\": \"5e124990964572a9a3253ae4\",\n \"first_name\": \"Tony\",\n \"last_name\": \"Ferguson\",\n \"dob\": \"1979-02-06T00:00:00.000Z\",\n \"title\": \"Manager\",\n \"ssn\": \"345-34-3333\"\n }\n ],\n \"funding_sources\": [\n {\n \"primary\": false,\n \"_id\": \"5e1250ab9cde99ac01d9c6e6\",\n \"type\": \"bank\",\n \"mqt_token\": \"https://api-sandbox.dwolla.com/funding-sources/88e14af6-9feb-48c8-84aa-2100de1b7660\",\n \"source\": {\n \"verified\": true,\n \"type\": \"bank\",\n \"plaid_public_token\": \"public-sandbox-74ae819c-15c2-4277-a167-198fd0dc81cf\",\n \"plaid_response\": {\n \"institution\": {\n \"name\": \"Wells Fargo\",\n \"institution_id\": \"ins_4\"\n },\n \"account\": {\n \"id\": \"MpKdqnQdnoHrr71v6BEjuwb94xBllDu9o8DmZ\",\n \"name\": \"Plaid Saving\",\n \"type\": \"depository\",\n \"subtype\": \"savings\",\n \"mask\": \"1111\"\n },\n \"account_id\": \"MpKdqnQdnoHrr71v6BEjuwb94xBllDu9o8DmZ\",\n \"accounts\": [\n {\n \"id\": \"MpKdqnQdnoHrr71v6BEjuwb94xBllDu9o8DmZ\",\n \"name\": \"Plaid Saving\",\n \"mask\": \"1111\",\n \"type\": \"depository\",\n \"subtype\": \"savings\"\n }\n ],\n \"link_session_id\": \"a690c2e9-c8f0-45d1-a80c-dd81b6bad67e\",\n \"public_token\": \"public-sandbox-74ae819c-15c2-4277-a167-198fd0dc81cf\"\n }\n },\n \"title\": \"Plaid Saving\"\n }\n ],\n \"created_date\": \"2020-01-05T20:39:44.038Z\",\n \"structure\": \"LLC\",\n \"registration_number\": \"12-1212121\",\n \"name\": \"Pearl DEMO\",\n \"dba_name\": \"BPN\",\n \"parent_company_name\": \"Blue\",\n \"phone\": \"123-456-7890\",\n \"date_established\": \"2017-01-12T00:00:00.000Z\",\n \"website\": \"www.redwan.com\",\n \"company_state\": \"YES\",\n \"number_of_employees\": 43,\n \"time_in_business\": \"2019-01-11T23:00:00.000Z\",\n \"primary_business_nature\": {\n \"value\": \"9ed3f670-7d6f-11e3-b1ce-5404a6144203\",\n \"label\": \"Retail\"\n },\n \"ownership\": \"PRIVATE\",\n \"has_principal\": true,\n \"is_subsdiary\": false,\n \"comdata_custid\": \"TPENN\",\n \"__v\": 2,\n \"balance_card\": {\n \"ok\": true,\n \"card\": {\n \"cardNumber\": \"556735XXXXXX0620\",\n \"cardDetails\": {\n \"accountCode\": \"GC702\",\n \"customerId\": \"TPENN\",\n \"discretionaryData\": null,\n \"trackingNumber\": null,\n \"cardStatus\": \"A\",\n \"profileFlag\": \"N\",\n \"profileValue\": \"000\",\n \"profileDescription\": null,\n \"cardFirstName\": \"PEARL DEMO\",\n \"cardLastName\": \"PROGRAM\",\n \"driverLicenseNumber\": null,\n \"driverLicenseState\": null,\n \"tripNumber\": null,\n \"vehicleNumber\": null,\n \"employeeNumber\": \"5E124990964572A\",\n \"vehicleVINNumber\": null,\n \"vehicleDescription\": null,\n \"vehicleLicensePlateNumber\": null,\n \"registrationExpiration\": null,\n \"miscellaneous1\": null,\n \"miscellaneous2\": null,\n \"cardExpiration\": \"2023-06-01\",\n \"cardToken\": \"222U42T2R6\",\n \"cardBlockReasonCode\": \"0000\",\n \"cardBlockReasonDesc\": null\n },\n \"amountLimits\": {\n \"dailyAmountLimit\": \"9999.00\",\n \"dailyAmountLimitUsed\": \"0.00\",\n \"dailyAmountLimitHold\": \"0.00\",\n \"dailyAmountLimitAvailable\": \"9999.00\",\n \"dailyTxnLimit\": \"9999\",\n \"dailyTxnLimitUsed\": \"0\",\n \"dailyTxnLimitHold\": \"0\",\n \"dailyTxnLimitAvailable\": \"9999\",\n \"cycleAmountLimit\": \"0.00\",\n \"cycleAmountLimitUsed\": \"0.00\",\n \"cycleAmountLimitHold\": \"0.00\",\n \"cycleAmountLimitAvailable\": \"0.00\",\n \"cycleTxnLimit\": \"9999\",\n \"cycleTxnLimitUsed\": \"0\",\n \"cycleTxnLimitHold\": \"0\",\n \"cycleTxnLimitAvailable\": \"9999\"\n },\n \"mailingDetails\": {\n \"mailMethod\": \"0\",\n \"mailName\": null,\n \"mailAttentionTo\": null,\n \"mailAddress1\": null,\n \"mailAddress2\": null,\n \"mailCity\": null,\n \"mailState\": null,\n \"mailZip\": null,\n \"mailCountry\": null\n }\n }\n },\n \"dwolla_link\": \"https://api-sandbox.dwolla.com/customers/f5ffb9c5-6205-477a-8425-0679df2674fd\",\n \"dwolla_kyc\": [\n [\n {\n \"headers\": {\n \"location\": \"https://api-sandbox.dwolla.com/customers/f5ffb9c5-6205-477a-8425-0679df2674fd\"\n },\n \"body\": \"\\\"\\\"\",\n \"status\": 201\n }\n ]\n ],\n \"balance\": \"0.00\"\n },\n \"pan\": \"556735XXXXXX4756\",\n \"employee_id\": null,\n \"state\": \"ACTIVE\",\n \"cvv\": \"520\"\n }\n}"}],"_postman_id":"0b7a18cb-3216-4c21-b659-1eeae7b18bdf"},{"name":"Enable Card","id":"89ba4dae-7251-4bcd-b88e-b16ba881e4ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{API_HOST}}/cards/{{CARD_ID}}/enable","description":"

By default, newly ordered cards are unactivated, in order to start using cards, they must be activated and assigned to a cardholder.

To activate a card, issue a PUT request to /cards/<id>/enable.

In case you need to temporary suspend a card, issue a PUT request to /cards/<id>/disable.

This will temporarily disable the card, it is possible to re-enable it again as many time as needed. However, if you need to permanently Disable / Terminate the card, use the DELETE card API.

Note: Disabling a card will make it unusable everywhere, and every attempt to use the card will be rejected, and all transactions will be declined.

If for some reason you want to delete a card, you can issue a DELETE request to /cards/<id>.

Note that this will permanently delete the card from the system, and the card will be terminated and won't be able to use it anywhere.

This API allows the update of card address and zip code.

Create a new cardholder with user and cardholder role, the new user will receive an email with credentials to access the system.

Update cardholder details

Retrieve a single cardholder by ID

Delete a cardholder from the system, the delete operation will fail if the cardholder has a card assigned or has a balance over $0.

This endpoints allows you to list all cardholders.

This endpoint supports pagination

Penny API allows you to move funds between accounts using REST API calls (Transfers API), a transfer is the action of moving funds between an account holder to another account holder.

Penny have two types of transfers:

Business - Cardholder: This moves funds from (or to) business Penny Account to (or from) Cardholder Penny Account. Example (send USD500 from Business account to User X, or send back USD100 from User X to the Business Penny Account).
Cardholder - Cardholder: This allows you to move funds from Cardholder X to Cardholder Y assuming they are within same business.

To Transfer funds between accounts, issue a POST request to /transfers endpoint and include the body in JSON format.

The parameters to sent are:

sender: The ID of the cardholder to be used as origin of fund transfer. in case you are sending funds from Business Account, don't send this parameters in the JSON.
receiver: The ID of the cardholder to receive the funds, in the case you want to send funds to business account, remove this from JSON.
sender_is_company: set to true if you are sending funds from Business to Cardholder. (sender attribute must be removed from the JSON in this case).
receiver_is_company: set to true if you are sending funds to Business from Cardholder. (receiver attribute must be removed from the JSON in this case).
amount: The amount to be sent.

To fetch a list of transactions, you can issue a GET request to /companies/<business_id>/transactions.

This endpoint supports pagination.

Transactions Types

Below is a list of transaction types and their description. each transaction returned from the API will have of the following types:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Transaction Type	Description
authorization.pending	Purchase Authorized, But still Pending
authorization.reversed	Represent a partial / full refund from merchants
authorization.expired	Expired authorization that didnt post within 30 days.
authorization.posted	Purchase Transioned to Cleared state
authorization.declined	Declined Authorization
authorization.credit	Refund / Reversed / Cancelled Authorization
gpa.ach.pending	An ach load created but pending
gpa.ach.failed	ACH Failed for some reason
gpa.ach.processed	ACH Successfully Processed, Funds reached Destination
gpa.ach.cancelled	ACH was cancelled
gpa.credit.paymentcard	Fund Load via Credit/Debit Card
transfer.peer	Transfer Initiated (Card/Card or Business/Card)

Transaction Statuses

Along with transaction type, the status field indicate the current transaction status, the table below lists the different state of a transaction:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
PENDING	Transaction is initiated, but didn't reacha final state yet.
CLEARED	Transaction completed with success.
DECLINED	Transaction rejected
REVERSED	Represent a refund, could be refund or a cancelled ACH
EXPIRED	Represent a an expired Authorization
CREDIT	Represent a credit.

Filter Transactions by card

\n","type":"text/plain"},"key":"card_id","value":"{{CARD_ID}}"},{"description":{"content":"

Filter by Employee/Card holder

\n","type":"text/plain"},"key":"employee_id","value":"{{CARDHOLDER_ID}}"},{"description":{"content":"

Search by Keyword

\n","type":"text/plain"},"key":"q","value":null},{"key":"pageSize","value":"100"},{"key":"page","value":"1"},{"description":{"content":"

Filter by date range YYYY-MM-DD

\n","type":"text/plain"},"key":"from_date","value":""},{"description":{"content":"

Filter by Date Range YYYY-MM-DD

\n","type":"text/plain"},"key":"to_date","value":null}],"variable":[]}},"response":[{"id":"f36cb89e-b329-4e55-9e32-77ef5c851ce2","name":"List Transactions","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"{{API_HOST}}/companies/{{COMPANY_ID}}/transactions?","host":["{{API_HOST}}"],"path":["companies","{{COMPANY_ID}}","transactions"],"query":[{"key":"","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"a43-Wbjj1iqmYTdT3z/pieaJuwgcg7M\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Sat, 04 Apr 2020 10:20:51 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"count\": 2,\n \"start_index\": 0,\n \"end_index\": 2,\n \"is_more\": false,\n \"transactions\": [\n {\n \"_id\": \"5e88585257f4d36a1f227935\",\n \"mcc_name\": \"\",\n \"created_time\": \"2020-04-03T21:50:09.000Z\",\n \"state\": \"CLEARED\",\n \"type\": \"transfer.peer\",\n \"amount\": 100,\n \"original_amount\": 100,\n \"mqt_token\": \"5e88585257f4d36a1f227935\",\n \"company_id\": \"5dbdc9abc0113f001e35de55\",\n \"employee_id\": {\n \"employee_number\": null,\n \"balance\": \"0\",\n \"is_admin\": false,\n \"groups\": [],\n \"_id\": \"5e8855166fef3269e36d440d\",\n \"company_id\": \"5dbdc9abc0113f001e35de55\",\n \"user_id\": {\n \"address\": {\n \"country\": \"US\",\n \"line_1\": \"600 California St\",\n \"zip_code\": \"94108\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\"\n },\n \"first_login\": false,\n \"_id\": \"5e8855156fef3269e36d440c\",\n \"last_login\": \"2016-11-03T02:10:04.114Z\",\n \"last_name\": \"User\",\n \"first_name\": \"Demo 23\",\n \"email\": \"\",\n \"avatar_link\": \"https://api.thepennyinc.com/users/581a9c7cb98f055656962a10/avatar\"\n }\n },\n \"card_id\": {\n \"_id\": \"5e88452beacf8b6743841ed3\",\n \"balance\": \"0.00\",\n \"description\": \"PENNY INC\",\n \"type\": \"VIRTUAL\",\n \"expiration_time\": \"2023-06-01\",\n \"expiration\": \"0623\",\n \"user_token\": \"1585988906049\",\n \"mqt_card_token\": \"222W39C2W4\",\n \"company_id\": \"5dbdc9abc0113f001e35de55\",\n \"pan\": \"5567XXXXXXXX4756\",\n \"employee_id\": \"5e8855166fef3269e36d440d\"\n },\n \"business_involved\": true,\n \"gpa_order\": null,\n \"card_acceptor\": {\n \"name\": \"Transfer from Demo 23 USER\"\n },\n \"is_debit\": false,\n \"receipt_uploaded\": false,\n \"peer_transfer\": {\n \"memo\": \"Transfer from Demo 23 USER\"\n },\n \"is_cancellable\": false\n },\n {\n \"_id\": \"5e88582257f4d36a1f227932\",\n \"mcc_name\": \"\",\n \"created_time\": \"2020-04-03T21:49:21.000Z\",\n \"state\": \"CLEARED\",\n \"type\": \"transfer.peer\",\n \"amount\": 100,\n \"mqt_token\": \"5e88582257f4d36a1f227932\",\n \"company_id\": \"5dbdc9abc0113f001e35de55\",\n \"employee_id\": {\n \"employee_number\": null,\n \"balance\": \"0\",\n \"is_admin\": false,\n \"groups\": [],\n \"_id\": \"5e8855166fef3269e36d440d\",\n \"company_id\": \"5dbdc9abc0113f001e35de55\",\n \"user_id\": {\n \"address\": {\n \"country\": \"US\",\n \"line_1\": \"600 California St\",\n \"zip_code\": \"94108\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\"\n },\n \"first_login\": false,\n \"_id\": \"5e8855156fef3269e36d440c\",\n \"last_login\": \"2016-11-03T02:10:04.114Z\",\n \"last_name\": \"User\",\n \"first_name\": \"Demo 23\",\n \"email\": \"\",\n \"avatar_link\": \"https://api.thepennyinc.com/users/581a9c7cb98f055656962a10/avatar\"\n }\n },\n \"card_id\": {\n \"_id\": \"5e88452beacf8b6743841ed3\",\n \"balance\": \"0.00\",\n \"description\": \"PENNY INC\",\n \"type\": \"VIRTUAL\",\n \"expiration_time\": \"2023-06-01\",\n \"expiration\": \"0623\",\n \"user_token\": \"1585988906049\",\n \"mqt_card_token\": \"222W39C2W4\",\n \"company_id\": \"5dbdc9abc0113f001e35de55\",\n \"pan\": \"5567XXXXXXXX4756\",\n \"employee_id\": \"5e8855166fef3269e36d440d\"\n },\n \"business_involved\": true,\n \"gpa_order\": null,\n \"card_acceptor\": {\n \"name\": \"Transfer to Demo 23 USER\"\n },\n \"is_debit\": true,\n \"receipt_uploaded\": false,\n \"peer_transfer\": {\n \"memo\": \"Transfer to Demo 23 USER\"\n },\n \"is_cancellable\": false\n }\n ]\n }\n}"}],"_postman_id":"6eb2a944-6d67-4f50-82be-9f594cf113ee"}],"id":"62c72d5d-50eb-4eb9-9a2b-64bca0e85cc7","event":[{"listen":"prerequest","script":{"id":"38dbf85c-8a1a-47e2-a87a-526c595e7099","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4a5904a7-bf0b-4b21-a266-7dd0d69d8654","type":"text/javascript","exec":[""]}}],"_postman_id":"62c72d5d-50eb-4eb9-9a2b-64bca0e85cc7","description":"","auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":""},"isInherited":true,"source":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Subscriptions","item":[{"name":"New Subscription","id":"377ede6e-25f9-4294-8c4e-4e47107e4900","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"endpoint\": \"https://api.example3\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,\",\n \"events\": [\"transactions\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/companies/:id/subscriptions","description":"

To create / configure a webhook endpoint, issue a POST request to /subscriptions with following parameters:

endpoint: this the URL in your environment, which will receive the JSON payload from Penny whenever an event occurs.
secret_token: a 32-character string that Penny will send in the Authorization header the POST request to your endpoint.
events: list of events to be processed by the endpoint being configured. Only transactions supported for now.

Your Company ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8cdee64c-e83f-433a-bd9e-8a7ff767c0ed","name":"New Subscription","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"endpoint\": \"https://api.example\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,\",\n \"events\": [\"transactions\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HOST}}/companies/:id/subscriptions","host":["{{HOST}}"],"path":["companies",":id","subscriptions"],"variable":[{"key":"id","value":"5eb64eea8a6b7847dc78abc0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Apr 2021 15:47:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"349"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=JR4vNlYLphEkBlh9oqMFyQwkCQAdgQC1G26AaGJnXRxmBRqHFu9B0iOcxt+gFXrs70E8u/7nFN09DGhuUL56TvTDgi3jhdQSLtTj2f46dkaB0aydpmsI2v7l5Vx9; Expires=Mon, 03 May 2021 15:47:29 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=JR4vNlYLphEkBlh9oqMFyQwkCQAdgQC1G26AaGJnXRxmBRqHFu9B0iOcxt+gFXrs70E8u/7nFN09DGhuUL56TvTDgi3jhdQSLtTj2f46dkaB0aydpmsI2v7l5Vx9; Expires=Mon, 03 May 2021 15:47:29 GMT; Path=/; SameSite=None; Secure"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Language","value":"en"},{"key":"ETag","value":"W/\"15d-zngQetUPcPH9CRrciOV66viPfZQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"subscription\": {\n \"events\": [\n \"transactions\"\n ],\n \"enabled\": true,\n \"_id\": \"6086e0928f82be76200c1f51\",\n \"endpoint\": \"https://api.google\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,\",\n \"business\": \"5eb64eea8a6b7847dc78abc0\",\n \"createdAt\": \"2021-04-26T15:47:30.412Z\",\n \"updateAt\": \"2021-04-26T15:47:30.412Z\"\n },\n \"message\": \"Subscription Created.\"\n }\n}"}],"_postman_id":"377ede6e-25f9-4294-8c4e-4e47107e4900"},{"name":"Update Subscription","id":"7305e388-7e25-4bd3-8294-4654118027ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"endpoint\": \"https://34385da2a827.ngrok.io/events\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,_updated\",\n \"events\": [\"transactions\"],\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/companies/:id/subscriptions/:subscriptionId/","description":"

To update a webhook subscription, you can issue a PUT request to /subscriptions/subscription_id, all fields can be updated:

endpoint: this the URL in your environment, which will receive the JSON payload from Penny whenever an event occurs.
secret_token: a 32-character string that Penny will send in the Authorization header the POST request to your endpoint.
events: list of events to be processed by the endpoint being configured. Only transactions supported for now.
enabled: if you would like to disable the webhook ( set to false to disable the webhook).

\n","auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":""},"isInherited":true,"source":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","type":"collection"}},"urlObject":{"path":["companies",":id","subscriptions",":subscriptionId",""],"host":["{{HOST}}"],"query":[],"variable":[{"id":"49952159-047b-4067-85a1-45310fe7f036","type":"any","value":"{{COMPANY_ID}}","key":"id"},{"id":"5797b107-3ca4-4cc6-9d95-f49f2dbded0a","type":"any","value":"","key":"subscriptionId"}]}},"response":[{"id":"7b4624f3-4772-4dc9-b7b5-67d3f40f9a63","name":"New Subscription","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"endpoint\": \"https://api.example\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,\",\n \"events\": [\"transactions\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HOST}}/companies/:id/subscriptions","host":["{{HOST}}"],"path":["companies",":id","subscriptions"],"variable":[{"key":"id","value":"5eb64eea8a6b7847dc78abc0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Apr 2021 15:47:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"349"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=JR4vNlYLphEkBlh9oqMFyQwkCQAdgQC1G26AaGJnXRxmBRqHFu9B0iOcxt+gFXrs70E8u/7nFN09DGhuUL56TvTDgi3jhdQSLtTj2f46dkaB0aydpmsI2v7l5Vx9; Expires=Mon, 03 May 2021 15:47:29 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=JR4vNlYLphEkBlh9oqMFyQwkCQAdgQC1G26AaGJnXRxmBRqHFu9B0iOcxt+gFXrs70E8u/7nFN09DGhuUL56TvTDgi3jhdQSLtTj2f46dkaB0aydpmsI2v7l5Vx9; Expires=Mon, 03 May 2021 15:47:29 GMT; Path=/; SameSite=None; Secure"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Language","value":"en"},{"key":"ETag","value":"W/\"15d-zngQetUPcPH9CRrciOV66viPfZQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"subscription\": {\n \"events\": [\n \"transactions\"\n ],\n \"enabled\": true,\n \"_id\": \"6086e0928f82be76200c1f51\",\n \"endpoint\": \"https://api.google\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,\",\n \"business\": \"5eb64eea8a6b7847dc78abc0\",\n \"createdAt\": \"2021-04-26T15:47:30.412Z\",\n \"updateAt\": \"2021-04-26T15:47:30.412Z\"\n },\n \"message\": \"Subscription Created.\"\n }\n}"},{"id":"83f406fa-450f-4b9a-a05c-cd762cc8386c","name":"Update Subscription","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"endpoint\": \"https://api.example_updated\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,_updated\",\n \"events\": [\"transactions\"],\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HOST}}/companies/:id/subscriptions/:subscriptionId/","host":["{{HOST}}"],"path":["companies",":id","subscriptions",":subscriptionId",""],"variable":[{"key":"id","value":"5eb64eea8a6b7847dc78abc0"},{"key":"subscriptionId","value":"6086e0928f82be76200c1f51"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Apr 2021 15:53:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"396"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=mqsXb1i6zj9XoLOtd6nr7XBA5xkcNYXotdRRCGkPenzoLojCznqL8kLxE8urCSTWYkk4iEYJceXi2ap2GLGPDWAAPH7oRrCfAxknTouEnCgo6X4ym7rnYOxca3Qk; Expires=Mon, 03 May 2021 15:53:46 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=mqsXb1i6zj9XoLOtd6nr7XBA5xkcNYXotdRRCGkPenzoLojCznqL8kLxE8urCSTWYkk4iEYJceXi2ap2GLGPDWAAPH7oRrCfAxknTouEnCgo6X4ym7rnYOxca3Qk; Expires=Mon, 03 May 2021 15:53:46 GMT; Path=/; SameSite=None; Secure"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Language","value":"en"},{"key":"ETag","value":"W/\"18c-/TnBTNnNVCzGdrtgFRpKk0tb0S4\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"subscription\": {\n \"events\": [\n \"transactions\"\n ],\n \"enabled\": false,\n \"_id\": \"6086e0928f82be76200c1f51\",\n \"endpoint\": \"https://api.example_updated\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,_updated\",\n \"business\": \"5eb64eea8a6b7847dc78abc0\",\n \"createdAt\": \"2021-04-26T15:47:30.412Z\",\n \"updateAt\": \"2021-04-26T15:53:46.247Z\",\n \"__v\": 0\n },\n \"message\": \"Subcription has been updated Successfully.\"\n }\n}"}],"_postman_id":"7305e388-7e25-4bd3-8294-4654118027ba"},{"name":"List Subscriptions","id":"b96c442b-c3b9-4d91-a10a-da1e3a390bbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/companies/:id/subscriptions","auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":""},"isInherited":true,"source":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","type":"collection"}},"urlObject":{"path":["companies",":id","subscriptions"],"host":["{{HOST}}"],"query":[],"variable":[{"id":"eb1b5ddb-38da-48d1-b74e-10f0a7ff3cb8","type":"any","value":"{{COMPANY_ID}}","key":"id"}]}},"response":[{"id":"a24fedea-18c7-481f-995b-eadd20d38e38","name":"List Subscriptions","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HOST}}/companies/:id/subscriptions","host":["{{HOST}}"],"path":["companies",":id","subscriptions"],"variable":[{"key":"id","value":"5eb64eea8a6b7847dc78abc0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Apr 2021 15:50:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"892"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=rMLxTcUoPp8HmNLmzBgjCssRjCLbx+3RbZ7aOS5+CWpMF/vKkcOHFfsoikXqXXrU/WIpwomeqZi1q/MwZvHTx2zPWj7ESstgbhFudjdTmh6w7OFFZmWb7LqRsZyc; Expires=Mon, 03 May 2021 15:50:45 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=rMLxTcUoPp8HmNLmzBgjCssRjCLbx+3RbZ7aOS5+CWpMF/vKkcOHFfsoikXqXXrU/WIpwomeqZi1q/MwZvHTx2zPWj7ESstgbhFudjdTmh6w7OFFZmWb7LqRsZyc; Expires=Mon, 03 May 2021 15:50:45 GMT; Path=/; SameSite=None; Secure"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Language","value":"en"},{"key":"ETag","value":"W/\"37c-CN3hpxxUDxcC/kZ+txfI2TM8izM\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"subscriptions\": [\n {\n \"events\": [\n \"transactions\"\n ],\n \"enabled\": true,\n \"_id\": \"6086e0928f82be76200c1f51\",\n \"endpoint\": \"https://api.google\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,\",\n \"business\": \"5eb64eea8a6b7847dc78abc0\",\n \"createdAt\": \"2021-04-26T15:47:30.412Z\",\n \"updateAt\": \"2021-04-26T15:47:30.412Z\",\n \"__v\": 0\n },\n {\n \"events\": [\n \"transactions\"\n ],\n \"enabled\": true,\n \"_id\": \"6086e1458f82be3ed50c1f52\",\n \"endpoint\": \"https://api.example2\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,\",\n \"business\": \"5eb64eea8a6b7847dc78abc0\",\n \"createdAt\": \"2021-04-26T15:50:29.520Z\",\n \"updateAt\": \"2021-04-26T15:50:29.520Z\",\n \"__v\": 0\n },\n {\n \"events\": [\n \"transactions\"\n ],\n \"enabled\": true,\n \"_id\": \"6086e14b8f82be5eaf0c1f53\",\n \"endpoint\": \"https://api.example3\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,\",\n \"business\": \"5eb64eea8a6b7847dc78abc0\",\n \"createdAt\": \"2021-04-26T15:50:35.908Z\",\n \"updateAt\": \"2021-04-26T15:50:35.908Z\",\n \"__v\": 0\n }\n ]\n }\n}"}],"_postman_id":"b96c442b-c3b9-4d91-a10a-da1e3a390bbe"},{"name":"Delete Subscription","id":"0702cf2f-895d-4167-b20f-6cf71a913b80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"endpoint\": \"https://api.example_updated\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,_updated\",\n \"events\": [\"transactions\"],\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/companies/:id/subscriptions/:subscriptionId/","auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":""},"isInherited":true,"source":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","type":"collection"}},"urlObject":{"path":["companies",":id","subscriptions",":subscriptionId",""],"host":["{{HOST}}"],"query":[],"variable":[{"id":"a7100407-860f-4c58-8ed1-b29f386ada89","type":"any","value":"Your Company ID","key":"id"},{"id":"4ff587c9-de12-4d30-9887-3cdb2ae8277f","type":"any","value":"Subscription ID","key":"subscriptionId"}]}},"response":[{"id":"712294a0-a4a8-4473-b7a3-bd685ba47151","name":"Delete Subscription","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"endpoint\": \"https://api.example_updated\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,_updated\",\n \"events\": [\"transactions\"],\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HOST}}/companies/:id/subscriptions/:subscriptionId/","host":["{{HOST}}"],"path":["companies",":id","subscriptions",":subscriptionId",""],"variable":[{"key":"id","value":"5eb64eea8a6b7847dc78abc0"},{"key":"subscriptionId","value":"6086e0928f82be76200c1f51"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Apr 2021 15:53:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"67"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=hjyekhoDryWrUhEF/263TjP6aIZ9tVDDGTzQOz5Gf2dryNHzi8N+qN9fVPHHdXAPgsO2q/OzyVswL/ErqZCqgReM258TVUN9UJ0kO3VCDGDDqc8Omv+S38euI0T3; Expires=Mon, 03 May 2021 15:53:56 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=hjyekhoDryWrUhEF/263TjP6aIZ9tVDDGTzQOz5Gf2dryNHzi8N+qN9fVPHHdXAPgsO2q/OzyVswL/ErqZCqgReM258TVUN9UJ0kO3VCDGDDqc8Omv+S38euI0T3; Expires=Mon, 03 May 2021 15:53:56 GMT; Path=/; SameSite=None; Secure"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Language","value":"en"},{"key":"ETag","value":"W/\"43-Ah5p3SGSTX1uMdgsy3hxmmr3Sk8\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"message\": \"Success Delete Subscription\"\n }\n}"},{"id":"d01a32ef-cf47-4642-a67c-8db343652f24","name":"New Subscription","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"endpoint\": \"https://api.example\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,\",\n \"events\": [\"transactions\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{HOST}}/companies/:id/subscriptions","host":["{{HOST}}"],"path":["companies",":id","subscriptions"],"variable":[{"key":"id","value":"5eb64eea8a6b7847dc78abc0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Apr 2021 15:47:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"349"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=JR4vNlYLphEkBlh9oqMFyQwkCQAdgQC1G26AaGJnXRxmBRqHFu9B0iOcxt+gFXrs70E8u/7nFN09DGhuUL56TvTDgi3jhdQSLtTj2f46dkaB0aydpmsI2v7l5Vx9; Expires=Mon, 03 May 2021 15:47:29 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=JR4vNlYLphEkBlh9oqMFyQwkCQAdgQC1G26AaGJnXRxmBRqHFu9B0iOcxt+gFXrs70E8u/7nFN09DGhuUL56TvTDgi3jhdQSLtTj2f46dkaB0aydpmsI2v7l5Vx9; Expires=Mon, 03 May 2021 15:47:29 GMT; Path=/; SameSite=None; Secure"},{"key":"Vary","value":"Origin, X-HTTP-Method-Override, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Language","value":"en"},{"key":"ETag","value":"W/\"15d-zngQetUPcPH9CRrciOV66viPfZQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"subscription\": {\n \"events\": [\n \"transactions\"\n ],\n \"enabled\": true,\n \"_id\": \"6086e0928f82be76200c1f51\",\n \"endpoint\": \"https://api.google\",\n \"secret_token\": \"ht}2{yGuY}[&Z[V9hWQ@6#}5t}GcW95,\",\n \"business\": \"5eb64eea8a6b7847dc78abc0\",\n \"createdAt\": \"2021-04-26T15:47:30.412Z\",\n \"updateAt\": \"2021-04-26T15:47:30.412Z\"\n },\n \"message\": \"Subscription Created.\"\n }\n}"}],"_postman_id":"0702cf2f-895d-4167-b20f-6cf71a913b80"}],"id":"149f59ee-8bb4-4ddc-8dfe-fa7064fcd63c","description":"

Subscriptions represents your webhooks endpoint, you can configure up to 5 webhooks, you can configure it to process different type of events ( transactions, cards, users...), you can also configure a webhook to receive all events as well.

Note: at this moment, only transactions event are supported.

\n","event":[{"listen":"prerequest","script":{"id":"a97aa9f3-c074-4a25-97cf-5d0d8aef43d6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5533bf99-b673-426b-8123-072e826272c4","type":"text/javascript","exec":[""]}}],"_postman_id":"149f59ee-8bb4-4ddc-8dfe-fa7064fcd63c","auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":""},"isInherited":true,"source":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","type":"collection"}}},{"name":"Events","item":[{"name":"Transactions","item":[{"name":"New Bank Load Sample","id":"d4fe34a0-c7e4-4d1c-bac1-15f824d171c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\": 'transactions',\n \"eventID\": '608d38108f82be60460c1f54',\n \"transaction\": {\n \"id\": '5roeo939nn0957584747487',\n \"type\": 'gpa.ach.pending',\n \"business\": '5roeo939nn0957584747487',\n \"status\": 'PENDING',\n \"amount\": 1000,\n \"transaction_date\": '2021-05-01T11:14:21.770Z',\n \"posted_date\": null,\n \"advanced_details\": {\n \"advanced_transaction\": null,\n \"advanced_on\": null,\n \"paidback_transaction\": null,\n \"paidback_on\": null,\n \"original_ach\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://YOU_ENDPOINT_HERE/","description":"

This is sample payload when new gpa.ach.pending is created ( new funds load from bank source)

This is sample payload when new transfer.peer is created.

This is sample payload when new gpa.ach.pending is created ( new funds load from bank source)

This is sample payload when new authorization.pending is created ( new purchase )

Transaction events include activities such as authorizations, postings and refunds, bank loads, transfers etc. When a transaction occurs, Penny will send your webhook a payload to notify you, same happens when the same transaction is posted / cleared or refunded.

Transaction Types Supported

The following are the types of transactions supported in webhooks, each transaction type might have slightly different payload ( each category such as: authorization., gpa., transfer.*)

gpa.credit
\n
gpa.debit
\n
gpa.ach.pending
\n
gpa.ach.processed
\n
gpa.ach.failed
\n
gpa.ach.cancelled
\n
gpa.ach.advanced
\n
gpa.ach.advanced.paidback
\n
gpa.ach.reversed
\n
gpa.credit.paymentcard
\n
transfer.peer
\n
authorization.credit
\n
authorization.pending
\n
authorization.posted
\n
authorization.declined
\n
authorization.reversed
\n
authorization.expired
\n

\n","event":[{"listen":"prerequest","script":{"id":"87cc74bf-94a0-49fa-9590-32374cce9a97","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"edd95999-7a2b-471b-96ef-501d82f8ea83","type":"text/javascript","exec":[""]}}],"_postman_id":"0c3f2f28-19e9-409f-a800-0b583ba4c91a","auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":""},"isInherited":true,"source":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","type":"collection"}}}],"id":"746546e1-14f0-46f6-8bea-d7f10490b6a6","description":"

Penny platform supports event notifications for these types of events:

Transaction events

The type field provided in the webhook payload defines the type of the event.

\n","event":[{"listen":"prerequest","script":{"id":"9cadfb83-99ba-429a-a43a-d31e3bca1549","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ff61caef-74e9-4af6-af5a-ed82572688bc","type":"text/javascript","exec":[""]}}],"_postman_id":"746546e1-14f0-46f6-8bea-d7f10490b6a6","auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":""},"isInherited":true,"source":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","type":"collection"}}}],"id":"1a5f7a97-8cda-49be-b12f-3d08d67f8ac2","description":"

Webhooks are notifications about API events, sent as they occur. Penny sends these notifications to an endpoint hosted in your environment and configured to receive and process them.

Using webhooks

When a webhook-enabled event occurs, Penny sends an HTTPS POSTrequest containing information about the event to a preconfigured endpoint hosted on your system. You must have an environment configured to listen for and process event notifications in order to take advantage of this functionality.

Characteristics

Penny webhook system handles notification messages by:

Retrying failed notification messages.
Including a Bearer Auth (e.g API Key / Secret ) header in the notification message.

Number of retry attempts

In case of a messaging failure, Penny will attempt to resend the message 10 times. A messaging failure is defined as any HTTP response code other than 200.

Retry interval

The interval between each retry is about 15mins.

Authentication

Penny includes a secret key in the header ( Authorization header ) in the notification message. Your environment must be configured to perform this type of authentication.

\n","event":[{"listen":"prerequest","script":{"id":"ee0b49fe-2716-4ef2-999f-b872de7d6fb2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eeaf8108-e1a1-4cb1-84b7-1ec9ddcd8652","type":"text/javascript","exec":[""]}}],"_postman_id":"1a5f7a97-8cda-49be-b12f-3d08d67f8ac2","auth":{"type":"apikey","apikey":{"value":"{{API_KEY}}","key":""},"isInherited":true,"source":{"_postman_id":"f1804e12-f883-4bd6-89b1-0d47a43af589","id":"f1804e12-f883-4bd6-89b1-0d47a43af589","name":"Penny API","type":"collection"}}},{"name":"Business Balance","id":"8355464a-1e1d-4410-b022-3495a8a7b9ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"{{API_HOST}}/companies/{{COMPANY_ID}}/stats","description":"

To retrieve the business main balance, issue a request to GET /companies/<id>/stats.