{"info":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","description":"

Third Party API for Large Customers access, this API is only accessible by developers who need to manage multiple businesses.

\n

SANDBOX: https://sandbox-oem.thepennyinc.com/v2/.

\n

PRODUCTION: Reach out to our support Team to get your Production and Development Keys, as well as the Production endpoint.

\n

If you only need to manage your own business, you caan use the Standard Developer API.

\n

In Order to get access to this API, please reach out to Penny Inc Support Team:

\n

Contact Support: support@thepennyinc.com

\n

Making Requests

\n

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

\n

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

\n
   {\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":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","publishedId":"SWLb9V6b","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF9800"},"publishDate":"2020-01-12T19:14:54.000Z"},"item":[{"name":"Migration Guide - V1 to V2","item":[],"id":"413899c8-3a2a-4ab6-9548-1497f893e80b","description":"

Migration Guide - DeliverLogic

\n

V2 API version is more stable, and we highly recommend that you migrate your environment soon.

\n

Some APIs were removed or updated, and some were added, this guide should help you quickly spot the changes needed, if you need help please reach out to support@thepennyinc.com

\n

The major changes are on the business object creation and adding new bank account (removed).

\n

Other minor changes have been made to Transaction Types and Statuses.

\n

Creating Businesses

\n

To create a business, the API has changed and requires more data to make the Verification and Approval easier and quicker.

\n

Those changes are mainly there to increase the chances of an auto-approval for new business, therefore reducing the delay between the business creation and granting them access to the platform.

\n\n

Bank Verification

\n

The APIs to verify and get verifications deposits have been REMVOED. Penny Inc partnered with Plaid to offer instant verification for bank accounts. At the moment adding new bank account can only be done through the user interface.

\n

Business Approval

\n

Only Penny Inc staff can approve or reject a business, the API to do so has been REMOVED in V2.

\n

Business Funding Sources

\n

New API to list current funding sources for a specific business have been added. Refer to the documentation for more details.

\n

Transaction Types

\n

Transaction types were changed, please refer to Transactions APIs for new types and statuses.

\n","event":[{"listen":"prerequest","script":{"id":"1fd4137a-245b-4eec-850c-c9e805be4df8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0ee838d9-9d8a-4d78-941b-7f051130bafa","type":"text/javascript","exec":[""]}}],"_postman_id":"413899c8-3a2a-4ab6-9548-1497f893e80b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}}},{"name":"cards","item":[{"name":"Order Cards","id":"5a86653c-32e0-46c1-8e3d-ccf01130e2c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":"","description":"

API Key

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"{{COMPANY_ID}}\",\n \"method\": \"UPS_NEXT_DAY_AIR\",\n \"quantity\": 30,\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":"https://sandbox-oem.thepennyinc.com/v2/cards/order","description":"

Order new cards for a company.

\n

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\n\n\n\n\n\n
AttributeTypeDescription
company_id *Stringthe company ID to order the cards for
method *StringThe 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
quantityIntegerNumber of cards to be ordered.
recipient_addressObjectThe address to which the new cards should be delivered
\n

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\n
AttributeTypeDescription
first_nameStringThe recipient first name.
last_nameStringThe recipient last name.
line_1StringThe shipping address line 1.
line_2StringThe shipping address line 2.
stateStringThe shipping address state, must be valid state in two letters (example: NY, CA..)
cityStringThe shipping address city.
zip_codeStringValid zip code.
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}},"urlObject":{"path":["cards","order"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"6e133a13-f62f-4ad2-9de8-f6ca00e550cf","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":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards/order"},"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}"},{"id":"6eaa9f01-b2ef-4a61-b281-36e61e00606e","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":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards/order"},"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":"6eacf858-7775-47db-ae86-33779c64eff0","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":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards/order"},"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}"}],"_postman_id":"5a86653c-32e0-46c1-8e3d-ccf01130e2c2"},{"name":"List All Cards","id":"d77669c1-b21a-45c1-aaf9-13898bfb46c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/cards?company_id={{COMPANY_ID}}","description":"

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

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}},"urlObject":{"path":["","cards"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[{"disabled":true,"description":{"content":"

Filter cards by status: ACTIVE, SUSPENDED,TERMINATED,UNACTIVATED

\n","type":"text/plain"},"key":"state","value":""},{"disabled":true,"description":{"content":"

Page number to fetch, by default the API will return 30 elements on each page

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

By default the page size is 30, but can be customized using pageSize parameter.

\n","type":"text/plain"},"key":"pageSize","value":""},{"disabled":true,"description":{"content":"

filter by card type: VIRTUAL or PHYSICAL

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

Search by keyword

\n","type":"text/plain"},"key":"q","value":""},{"key":"company_id","value":"{{COMPANY_ID}}"}],"variable":[]}},"response":[{"id":"17998ab1-384f-4030-8553-db8ec427a3ff","name":"Missing Parameters","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards?company_id=&state=&page=&pageSize=&type=&q=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","cards"],"query":[{"key":"company_id","value":""},{"key":"state","value":""},{"key":"page","value":""},{"key":"pageSize","value":""},{"key":"type","value":""},{"key":"q","value":""}]}},"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":"7edfcb5b-b21e-4bb3-b11a-fb837e2427fa","name":"List of cards by company ","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards?company_id=&state=&page=&pageSize=&type=&q=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","cards"],"query":[{"key":"company_id","value":""},{"key":"state","value":""},{"key":"page","value":""},{"key":"pageSize","value":""},{"key":"type","value":""},{"key":"q","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"cards\": [\n {\n \"balance\": \"\",\n \"company\": {\n \"approved\": \"\",\n \"bank_verified\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"ready\": \"\",\n \"structure\": \"\"\n },\n \"cvv\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"expiration_time\": \"\",\n \"id\": \"\",\n \"pan\": \"\",\n \"state\": \"\",\n \"state_reason\": \"\",\n \"type\": \"\",\n \"cardholder\": {\n \"balance\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\"\n }\n },\n {\n \"balance\": \"\",\n \"company\": {\n \"approved\": \"\",\n \"bank_verified\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"ready\": \"\",\n \"structure\": \"\"\n },\n \"cvv\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"expiration_time\": \"\",\n \"id\": \"\",\n \"pan\": \"\",\n \"state\": \"\",\n \"state_reason\": \"\",\n \"type\": \"\",\n \"cardholder\": {\n \"balance\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\"\n }\n }\n ],\n \"count\": \"\",\n \"end_index\": \"\",\n \"is_more\": \"\",\n \"start_index\": \"\"\n },\n \"success\": \"\"\n}"},{"id":"b7f41a50-b396-498e-a234-a2aefc0b5265","name":"Server Error","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards?company_id=&state=&page=&pageSize=&type=&q=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","cards"],"query":[{"key":"company_id","value":""},{"key":"state","value":""},{"key":"page","value":""},{"key":"pageSize","value":""},{"key":"type","value":""},{"key":"q","value":""}]}},"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}"}],"_postman_id":"d77669c1-b21a-45c1-aaf9-13898bfb46c4"},{"name":"Assign a card","id":"018484df-2749-4736-a98f-7faa2f19cf35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"{{COMPANY_ID}}\",\n \"employee_id\": \"{{EMPLOYEE_ID}}\"\n}"},"url":"https://sandbox-oem.thepennyinc.com/v2/cards/{{CARD_ID}}/assign","description":"

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

\n

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

\n

Notes

\n
    \n
  • both objects - card and cardholder/employee - must be within the same company referenced by company_id.
    • \n
  • 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.
    • \n
  • Only one card per cardholder can be assigned.
    • \n
\n

Request Attributes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeTypeDescription
company_idStringThe company_id that the cardholder and card belongs to.
employee_idStringThe employee to be assigned the card.
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}},"urlObject":{"path":["cards","{{CARD_ID}}","assign"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"0e42ab1a-ac11-4d9f-8e00-1a0c179ba5e3","name":"Bad Request","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"employee_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//assign"},"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":"c345c9d1-b568-46f3-8cbf-f7e8b427b03e","name":"Server Error","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"employee_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//assign"},"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":"dd8c9d8c-9b4c-4fa1-8c35-227344efc5e8","name":"Card Assigned Successfully.","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"employee_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//assign"},"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":"018484df-2749-4736-a98f-7faa2f19cf35"},{"name":"Unassign a card","id":"59f41684-50ee-4c6b-9f0c-fbaade6fab6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"{{COMPANY_ID}}\",\n \"employee_id\": \"{{EMPLOYEE_ID}}\"\n}"},"url":"https://sandbox-oem.thepennyinc.com/v2/cards/{{CARD_ID}}/unassign","description":"

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

\n

Notes:

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

Request Attributes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeTypeDescription
company_idStringThe company_id that the cardholder and card belongs to.
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}},"urlObject":{"path":["cards","{{CARD_ID}}","unassign"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"3a1bdfd4-c38b-468c-b87a-f2ceb13c6799","name":"500 response","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//unassign"},"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":"472a4cc6-53c8-4d6a-8495-3b650c19ca71","name":"200 response","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//unassign"},"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}"},{"id":"e0ba3cca-4ead-44d6-bb47-84aef73fd54a","name":"400 response","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//unassign"},"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}"}],"_postman_id":"59f41684-50ee-4c6b-9f0c-fbaade6fab6e"},{"name":"Enable a card","id":"5ddcccee-47c0-4056-8006-766e6b1ed769","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"{{COMPANY_ID}}\",\n \"employee_id\": \"{{EMPLOYEE_ID}}\"\n}"},"url":"https://sandbox-oem.thepennyinc.com/v2/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.

\n

To activate a card, issue a PUT request to /cards/<id>/enable, and include the company_id in the body of the request.

\n

Request Attributes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeTypeDescription
company_idStringThe company_id that the cardholder and card belongs to.
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}},"urlObject":{"path":["cards","{{CARD_ID}}","enable"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"0992d037-8521-40df-9767-7e38322dd738","name":"500 response","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//enable"},"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":"0cc612fd-e88e-489c-916d-27e93b8f9589","name":"200 response","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//enable"},"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}"},{"id":"f772cdcf-ad63-41cb-b5f7-3b10102e5eea","name":"400 response","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//enable"},"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}"}],"_postman_id":"5ddcccee-47c0-4056-8006-766e6b1ed769"},{"name":"Disable a card","id":"c65b0166-54ae-436e-ae48-e20cec12208c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"{{COMPANY_ID}}\"\n}"},"url":"https://sandbox-oem.thepennyinc.com/v2//cards/{{CARD_ID}}/disable","description":"

In case you need to temporary suspend a card, issue a PUT request to /cards/<id>/disable and include the company_id in the body of the request.

\n

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.

\n

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.

\n

Request Attributes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeTypeDescription
company_idStringThe company_id that the cardholder and card belongs to.
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}},"urlObject":{"path":["","cards","{{CARD_ID}}","disable"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"1f002dfb-f075-413f-8b83-575ee05934a5","name":"200 response","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//disable"},"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}"},{"id":"7d3c5826-ee11-4a9f-bebb-43eda7bfe26d","name":"400 response","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//disable"},"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":"b39b9669-879a-4013-a439-2cb49d4c9fc1","name":"500 response","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards//disable"},"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}"}],"_postman_id":"c65b0166-54ae-436e-ae48-e20cec12208c"},{"name":"Retrieve a card","id":"04e62ccc-8449-438d-939b-2b441aaf482a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/cards/{{CARD_ID}}","description":"

Retrieve a single card details

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}},"urlObject":{"path":["cards","{{CARD_ID}}"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"0e4f309c-9e05-4751-a3c3-d5caf7c7d248","name":"Card Details","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"balance\": \"\",\n \"cardholder\": {\n \"balance\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\"\n },\n \"company\": {\n \"approved\": \"\",\n \"bank_verified\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"ready\": \"\",\n \"structure\": \"\"\n },\n \"cvv\": \"\",\n \"description\": \"\",\n \"expiration\": \"\",\n \"expiration_time\": \"\",\n \"id\": \"\",\n \"pan\": \"\",\n \"state\": \"\",\n \"state_reason\": \"\",\n \"type\": \"\"\n },\n \"success\": \"\"\n}"},{"id":"86f684ad-4678-4ff5-86df-2516dbf9bba0","name":"Server Error","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards/"},"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":"b7fbe581-4589-444a-b56b-bbb4c89c00df","name":"Card not found","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"message\": \"\"\n },\n \"success\": \"\"\n}"},{"id":"df7a8719-cd48-4824-be75-cbbb7fabf104","name":"Invalid Request","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards/"},"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}"}],"_postman_id":"04e62ccc-8449-438d-939b-2b441aaf482a"},{"name":"Delete a card","id":"9c52701a-a8ef-4086-820a-12724e8e8686","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/cards/:id","description":"

If for some reason you want to delete a card, you can issue a DELETE request to /cards/<id> and include company_id in the body.

\n

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.

\n

Request Attributes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeTypeDescription
company_idStringThe company_id that the cardholder and card belongs to.
\n
","urlObject":{"path":["cards",":id"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[{"id":"5cb6685b-0419-4fab-bd39-402c0fb38e85","description":{"content":"

The Card ID

\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"5e1dec63-04f0-4b5e-b727-ada225f45a32","name":"Card deleted successfully","originalRequest":{"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards/"},"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}"},{"id":"78435305-025b-4d22-a07f-da61331066eb","name":"Server Error","originalRequest":{"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards/"},"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":"a87ddec2-e4aa-4e2f-95a7-f3aa148630b9","name":"Bad Request","originalRequest":{"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cards/"},"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}"}],"_postman_id":"9c52701a-a8ef-4086-820a-12724e8e8686"}],"id":"5978135b-b47f-4829-99a2-95d261757bff","description":"

Cards are one of the main object in Penny Platform. You can create and order cards, assign, enable, remove a card by calling Penny Rest API endpoints.

\n","event":[{"listen":"prerequest","script":{"id":"5438b189-9419-4c95-8825-f6ad601b679b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8bd67854-f7eb-4e2c-9fb6-50feff4eb9d5","type":"text/javascript","exec":[""]}}],"_postman_id":"5978135b-b47f-4829-99a2-95d261757bff","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}}},{"name":"companies","item":[{"name":"Create a new business","id":"cfee25da-3b67-44a6-a193-939069a3da0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"city\": \"\",\n \"line_1\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"admin\": {\n \"confirm_password\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"password\": \"\"\n },\n \"company_state\": \"\",\n \"date_established\": \"\",\n \"dba_name\": \"\",\n \"has_principal\": \"\",\n \"incorporation\": {\n \"state_of_incorporation\": \"\"\n },\n \"is_subsdiary\": \"\",\n \"name\": \"\",\n \"number_of_employees\": \"\",\n \"officer\": {\n \"dob\": \"\",\n \"first_name\": \"\",\n \"home\": {\n \"cell\": \"\",\n \"city\": \"\",\n \"line_1\": \"\",\n \"phone\": \"\",\n \"since\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"is_shareholding\": \"\",\n \"last_name\": \"\",\n \"ssn\": \"\",\n \"title\": \"\"\n },\n \"ownership\": \"\",\n \"parent_company_name\": \"\",\n \"phone\": \"\",\n \"primary_business_nature\": {\n \"label\": \"\",\n \"value\": \"\"\n },\n \"principals\": [\n {\n \"dob\": \"\",\n \"first_name\": \"\",\n \"home\": {\n \"cell\": \"\",\n \"city\": \"\",\n \"line_1\": \"\",\n \"phone\": \"\",\n \"since\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"last_name\": \"\",\n \"ownership\": {\n \"percentage\": \"\",\n \"since\": \"\"\n },\n \"ssn\": \"\",\n \"title\": \"\"\n },\n {\n \"dob\": \"\",\n \"first_name\": \"\",\n \"home\": {\n \"cell\": \"\",\n \"city\": \"\",\n \"line_1\": \"\",\n \"phone\": \"\",\n \"since\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"last_name\": \"\",\n \"ownership\": {\n \"percentage\": \"\",\n \"since\": \"\"\n },\n \"ssn\": \"\",\n \"title\": \"\"\n }\n ],\n \"registration_number\": \"\",\n \"signature\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"image\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"title\": \"\"\n },\n \"structure\": \"\",\n \"time_in_business\": \"\",\n \"trading_address\": {\n \"city\": \"\",\n \"line_1\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"website\": \"\"\n}"},"url":"https://sandbox-oem.thepennyinc.com/v2/companies/signup","description":"

How to create new companies?

\n

Company is the main object and central resource on Penny API, every other resource (card, transaction, cardholder) is under a Company.

\n

To Create a company, four main steps must be taken:

\n
    \n
  1. Collect the Company Details (Business, Owner details, Share holders etc).
    2. \n
  2. Validate the company identity (basically performing a KYC (Know Your Customer) request, to check the Customer identity).
    3. \n
  3. Approve The Company on Penny.
    4. \n
\n
\n

Business Validation (KYC).

\n

Each business created on the Penny API must be validated, to do so we performa KYC on the background whenever you submit a request to create a company via API.

\n

The result of create request, depends on the KYC output. Basically we have three cases:

\n
    \n
  • Business Passed KYC: If the details provided are correct, KYC goes seamlessly, in this case the company is validated automatically on the creation.
    • \n
  • ** KYC Soft Failure**: This is the case where KYC not really fails but we just need more information, in this case the API will give you back some questions, and the Business must submit answers, the answers are then compared to our records, if they are correct, the company is then automatically validated.
    • \n
  • KYC Hard Failure: In the case our system is unable to check if the business details submitted are correct or not ( this could happen for multiple reasons ) we require that the Business uploads some docs, and we'll need to manually validate the business, in this case Penny Inc support will reach out to the business for more details.
    • \n
\n

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\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\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
AttributeRequiredTypeDescription
nameYESStringThe business name
dba_nameYESStringknown as `doing business as` name
parent_company_nameNOStringparent company name, if applicable
structureYESStringCompany legal structure. \"LLC\", \"CORPORATION\", \"SOLE_PROPRIETORSHIP\", \"PARTNERSHIP\", \"OTHER\"
registration_numberYESStringCompany Registration Number (EIN)
is_subsdiaryYESString, (\"true\" or \"false\")Indicates if the company is a subsdiary of another one.
date_establishedYESDate, format 2015-01-12T00:00:00.000ZDate when the business was created
time_in_businessYESDateDate since the business started doing business
has_principalYESString, (\"true\" or \"false\")Does the business have a principal owner
company_stateYESString, (\"N/A\",\"YES\",\"NO\")\"true\" when business is in good Standing with the Secretary of State? false otherwise.
ownershipYESStringOwnership type: PRIVATE\", \"PUBLIC\", \"SUBSDIARY\", \"OTHER\"
addressYESAddress ObjectThe business current address
phoneNOStringCurrent business phone number
adminYESAdmin ObjectThe user creating the business, will be the account holder and administrator of the business penny account.
incorporationYESIncorporation objectThe incorporation type
number_of_employeesYESNumbercurrent number of employees within the company
officerYESofficer ObjectThe business controlling officer
principalsYESArray of Principal ObjectList of principals, add every principal with 25% shareholding or more.
trading_addressYESAddress objectbusiness trading address
primary_business_natureYESStringValid Business nature Description
websiteNOStringBusiness website, if any
\n

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
AttributeTypeDescription
line_1StringBusiness address line 1
line_2StringBusiness address line 2
stateStringBusiness address state
cityStringbusiness address city
zip_codeStringvalid zip code
\n

Admin 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
AttributeTypeDescription
first_nameStringThe user first name
last_nameStringthe user last name
emailStringValid email address, will be used as login
passwordStringValid password (12 characters minimum, one capital letter at least and one special character).
confirm_passwordStringMust match `password` field.
\n

Officer 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\n
AttributeTypeDescription
first_nameStringOfficer first name
last_nameStringOfficer last name
homeOfficier Address ObjectThe officer address details.
is_shareholdingString(\"true\", \"false\"), indicates if the officer is a shareholder too.
titleStringJob title of the controlling officer.
ssnStringValid ssn number
dobDate, format 1980-06-03T00:00:00.000ZDate of birth
\n

Officer 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\n\n\n\n\n\n
AttributeTypeDescription
line_1StringBusiness address line 1
line_2StringBusiness address line 2
stateStringBusiness address state
cityStringbusiness address city
zip_codeStringvalid zip code
cellStringOfficer cell number
phoneStringOfficer phone number
sinceDateDate since the officer is based on the specified address.
\n

Principal Object

\n

principals field is an array of the following 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\n
AttributeTypeDescription
first_nameStringPrincipal first name
last_nameStringPrincipal last name
homePrincipal Address ObjectThe Principal address details.
titleStringJob title of the Principal .
ssnStringValid ssn number
dobDate, format 1980-06-03T00:00:00.000ZDate of birth
ownershipOwnership ObjectPrincipal Ownership
\n

Principal 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\n\n\n\n\n\n
AttributeTypeDescription
line_1StringPrincipal address line 1
line_2StringPrincipal address line 2
stateStringPrincipal address state
cityStringPrincipal address city
zip_codeStringvalid zip code
cellStringPrincipal cell number
phoneStringPrincipal phone number
sinceDateDate since the Principal is based on the specified address.
\n

Principal Ownerhsip Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeTypeDescription
percentageStringPrincipal percentage (must be between 25 and 100) (example 25)
sinceDateDate since the principal owns the 25% or more.
\n

Incorporation Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeTypeDescription
state_of_incorporationStringValid State (two letters)
\n

Primary Business Nature object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeTypeDescription
labelStringBusiness nature description
valueStringthe Identifier of the business nature.
\n
","urlObject":{"path":["companies","signup"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"96a84b1c-917c-469c-a3d0-3b5a932f06c4","name":"500 response","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"city\": \"\",\n \"line_1\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"admin\": {\n \"confirm_password\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"password\": \"\"\n },\n \"company_state\": \"\",\n \"date_established\": \"\",\n \"dba_name\": \"\",\n \"has_principal\": \"\",\n \"incorporation\": {\n \"state_of_incorporation\": \"\"\n },\n \"is_subsdiary\": \"\",\n \"name\": \"\",\n \"number_of_employees\": \"\",\n \"officer\": {\n \"dob\": \"\",\n \"first_name\": \"\",\n \"home\": {\n \"cell\": \"\",\n \"city\": \"\",\n \"line_1\": \"\",\n \"phone\": \"\",\n \"since\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"is_shareholding\": \"\",\n \"last_name\": \"\",\n \"ssn\": \"\",\n \"title\": \"\"\n },\n \"ownership\": \"\",\n \"parent_company_name\": \"\",\n \"phone\": \"\",\n \"primary_business_nature\": {\n \"label\": \"\",\n \"value\": \"\"\n },\n \"principals\": [\n {\n \"dob\": \"\",\n \"first_name\": \"\",\n \"home\": {\n \"cell\": \"\",\n \"city\": \"\",\n \"line_1\": \"\",\n \"phone\": \"\",\n \"since\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"last_name\": \"\",\n \"ownership\": {\n \"percentage\": \"\",\n \"since\": \"\"\n },\n \"ssn\": \"\",\n \"title\": \"\"\n },\n {\n \"dob\": \"\",\n \"first_name\": \"\",\n \"home\": {\n \"cell\": \"\",\n \"city\": \"\",\n \"line_1\": \"\",\n \"phone\": \"\",\n \"since\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"last_name\": \"\",\n \"ownership\": {\n \"percentage\": \"\",\n \"since\": \"\"\n },\n \"ssn\": \"\",\n \"title\": \"\"\n }\n ],\n \"registration_number\": \"\",\n \"signature\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"image\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"title\": \"\"\n },\n \"structure\": \"\",\n \"time_in_business\": \"\",\n \"trading_address\": {\n \"city\": \"\",\n \"line_1\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"website\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/companies/signup"},"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":"b831eaa4-903f-4105-af70-ecc0cb9a19a7","name":"200 response","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 \"admin\": {\n \"first_name\": \"Joe\",\n \"last_name\": \"Doe\",\n \"email\": \"piyece1632@jancloud.net\",\n \"password\": \"a8ykt7O23#Ch\",\n \"confirm_password\": \"a8ykt7O23#Ch\"\n },\n \"structure\": \"LLC\",\n \"registration_number\": \"99-9999999\",\n \"name\": \"Awesome Business\",\n \"dba_name\": \"Awesome Business DBA\",\n \"parent_company_name\": \"\",\n \"incorporation\": {\n \"state_of_incorporation\": \"SC\"\n },\n \"phone\": \"111-111-1111\",\n \"date_established\": \"2018-05-16T00:00:00.000Z\",\n \"website\": \"thebusiness.com\",\n \"address\": {\n \"line_1\": \"Business Main Street\",\n \"line_2\": \"\",\n \"zip_code\": \"29803\",\n \"city\": \"Biden\",\n \"state\": \"SC\"\n },\n \"trading_address\": {\n \"line_1\": \"111 The Street\",\n \"line_2\": \"\",\n \"zip_code\": \"29803\",\n \"city\": \"Biden\",\n \"state\": \"SC\"\n },\n \"company_state\": \"N/A\",\n \"number_of_employees\": \"1\",\n \"time_in_business\": \"2018-05-16T00:00:00.000Z\",\n \"primary_business_nature\": {\n \"value\": \"9ed3f673-7d6f-11e3-adb1-5404a6144203\",\n \"label\": \"Restaurant\"\n },\n \"ownership\": \"PRIVATE\",\n \"has_principal\": \"true\",\n \"is_subsdiary\": \"false\",\n \"officer\": {\n \"first_name\": \"Joe\",\n \"last_name\": \"Doe\",\n \"title\": \"Owner\",\n \"ssn\": \"999-99-9999\",\n \"dob\": \"1954-12-31T00:00:00.000Z\",\n \"is_shareholding\": \"true\",\n \"home\": {\n \"line_1\": \"111 Business District\",\n \"zip_code\": \"29803\",\n \"city\": \"Biden\",\n \"state\": \"SC\",\n \"since\": \"2013-01-01T00:00:00.000Z\",\n \"phone\": \"999-999-9999\",\n \"cell\": \"999-999-9999\"\n }\n },\n \"principals\": [\n {\n \"first_name\": \"Joe\",\n \"last_name\": \"Doe\",\n \"title\": \"Owner\",\n \"ssn\": \"999-99-9999\",\n \"dob\": \"1954-12-31T00:00:00.000Z\",\n \"home\": {\n \"line_1\": \"111 Business District\",\n \"zip_code\": \"29803\",\n \"city\": \"Biden\",\n \"state\": \"SC\",\n \"since\": \"2013-01-01T00:00:00.000Z\",\n \"phone\": \"999-999-9999\",\n \"cell\": \"999-999-9999\"\n },\n \"ownership\": {\n \"percentage\": \"100\",\n \"since\": \"2018-05-16T00:00:00.000Z\"\n }\n }\n ],\n \"signature\": {\n \"date\": \"2018-08-19T20:10:19.889Z\",\n \"image\": \"Signature Base 64 Image\",\n \"first_name\": \"Joe\",\n \"last_name\": \"Doe\",\n \"title\": \"Ownere\",\n \"email\": \"piyece1632@jancloud.net\",\n \"phone\": \"999-999-9999\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/companies/signup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"company_id\": \"5e1b49c31cefeb001d9ca295\",\n \"message\": \"BUSINESS_CREATED\"\n }\n}"},{"id":"d7bfa543-0820-4061-91f0-f2ac6c407d7f","name":"400 response","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"city\": \"\",\n \"line_1\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"admin\": {\n \"confirm_password\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"password\": \"\"\n },\n \"company_state\": \"\",\n \"date_established\": \"\",\n \"dba_name\": \"\",\n \"has_principal\": \"\",\n \"incorporation\": {\n \"state_of_incorporation\": \"\"\n },\n \"is_subsdiary\": \"\",\n \"name\": \"\",\n \"number_of_employees\": \"\",\n \"officer\": {\n \"dob\": \"\",\n \"first_name\": \"\",\n \"home\": {\n \"cell\": \"\",\n \"city\": \"\",\n \"line_1\": \"\",\n \"phone\": \"\",\n \"since\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"is_shareholding\": \"\",\n \"last_name\": \"\",\n \"ssn\": \"\",\n \"title\": \"\"\n },\n \"ownership\": \"\",\n \"parent_company_name\": \"\",\n \"phone\": \"\",\n \"primary_business_nature\": {\n \"label\": \"\",\n \"value\": \"\"\n },\n \"principals\": [\n {\n \"dob\": \"\",\n \"first_name\": \"\",\n \"home\": {\n \"cell\": \"\",\n \"city\": \"\",\n \"line_1\": \"\",\n \"phone\": \"\",\n \"since\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"last_name\": \"\",\n \"ownership\": {\n \"percentage\": \"\",\n \"since\": \"\"\n },\n \"ssn\": \"\",\n \"title\": \"\"\n },\n {\n \"dob\": \"\",\n \"first_name\": \"\",\n \"home\": {\n \"cell\": \"\",\n \"city\": \"\",\n \"line_1\": \"\",\n \"phone\": \"\",\n \"since\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"last_name\": \"\",\n \"ownership\": {\n \"percentage\": \"\",\n \"since\": \"\"\n },\n \"ssn\": \"\",\n \"title\": \"\"\n }\n ],\n \"registration_number\": \"\",\n \"signature\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"image\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"title\": \"\"\n },\n \"structure\": \"\",\n \"time_in_business\": \"\",\n \"trading_address\": {\n \"city\": \"\",\n \"line_1\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"website\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/companies/signup"},"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}"}],"_postman_id":"cfee25da-3b67-44a6-a193-939069a3da0c"},{"name":"List business cardholders","id":"c369af53-bfbd-4b70-bec7-6c90d0c9e587","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/company/{{COMPANY_ID}}/cardholders","description":"

This endpoints allows you to list all cardholders linked to a specific business.

\n

This endpoint supports pagination

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5a364ac3-0783-492b-a66b-8a9b903588f8","id":"5a364ac3-0783-492b-a66b-8a9b903588f8","name":"companies","type":"folder"}},"urlObject":{"path":["company","{{COMPANY_ID}}","cardholders"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[{"disabled":true,"description":{"content":"

Page number to fetch, by default the API will return 30 elements on each page

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

By default the page size is 30, but can be customized using pageSize parameter.

\n","type":"text/plain"},"key":"pageSize","value":""},{"disabled":true,"description":{"content":"

List only cardholders with the role admin.

\n","type":"text/plain"},"key":"is_admin","value":""},{"disabled":true,"description":{"content":"

Search cardholders by keyword (first and last name, address...)

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"32b5c9ca-6e8d-43d2-83f3-03452b159bbb","name":"200 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company//cardholders?page=&pageSize=&is_admin=&q=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","company","","cardholders"],"query":[{"key":"page","value":""},{"key":"pageSize","value":""},{"key":"is_admin","value":""},{"key":"q","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"cardholders\": [\n {\n \"balance\": \"\",\n \"birth_date\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\"\n },\n {\n \"balance\": \"\",\n \"birth_date\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\"\n }\n ],\n \"count\": \"\",\n \"end_index\": \"\",\n \"is_more\": \"\",\n \"start_index\": \"\"\n },\n \"success\": \"\"\n}"},{"id":"88c42bbf-db33-4ae9-9f28-2844fa31b8d6","name":"400 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company//cardholders?page=&pageSize=&is_admin=&q=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","company","","cardholders"],"query":[{"key":"page","value":""},{"key":"pageSize","value":""},{"key":"is_admin","value":""},{"key":"q","value":""}]}},"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}"}],"_postman_id":"c369af53-bfbd-4b70-bec7-6c90d0c9e587"},{"name":"List Business Transactions","id":"055b6d73-6db7-445a-8e0f-8f55711a8aa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/company/{{COMPANY_ID}}/transactions","description":"

To fetch a list of transactions made by specific business, you can issue a GET request to /company/<business_id>/transactions.

\n

This endpoint supports pagination.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5a364ac3-0783-492b-a66b-8a9b903588f8","id":"5a364ac3-0783-492b-a66b-8a9b903588f8","name":"companies","type":"folder"}},"urlObject":{"path":["company","{{COMPANY_ID}}","transactions"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[{"disabled":true,"description":{"content":"

Filter transactions by their status

\n","type":"text/plain"},"key":"state","value":""},{"disabled":true,"description":{"content":"

Provide a cardholder ID to filter transactions by cardholder

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

Pagination

\n","type":"text/plain"},"key":"pageSize","value":""},{"disabled":true,"description":{"content":"

Filter transactions by date range

\n","type":"text/plain"},"key":"to_date","value":""},{"disabled":true,"description":{"content":"

Pagination

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Filter transactions by date range

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

Provide a card ID to filter transactions by card

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

Search a transaction y keyword

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

Allowed values (to send list of types, separate them by comma ','): authorization.pending,authorization.posted, authorization.declined,authorization.credit,gpa.ach.pending,gpa.ach.failed,gpa.ach.processed,gpa.ach.cancelled,gpa.credit.paymentcard,transfer.peer

\n","type":"text/plain"},"key":"type","value":""}],"variable":[]}},"response":[{"id":"83f4904d-619a-4878-9f4e-e0bc2ca1919a","name":"400 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company//transactions?state=&employee_id=&pageSize=&to_date=&page=&from_date=&card_id=&q=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","company","","transactions"],"query":[{"key":"state","value":""},{"key":"employee_id","value":""},{"key":"pageSize","value":""},{"key":"to_date","value":""},{"key":"page","value":""},{"key":"from_date","value":""},{"key":"card_id","value":""},{"key":"q","value":""}]}},"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":"ddabb8a6-3530-4ca2-9090-d4d84848efae","name":"200 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company//transactions?state=&employee_id=&pageSize=&to_date=&page=&from_date=&card_id=&q=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","company","","transactions"],"query":[{"key":"state","value":""},{"key":"employee_id","value":""},{"key":"pageSize","value":""},{"key":"to_date","value":""},{"key":"page","value":""},{"key":"from_date","value":""},{"key":"card_id","value":""},{"key":"q","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"count\": \"\",\n \"end_index\": \"\",\n \"is_more\": \"\",\n \"start_index\": \"\",\n \"transactions\": [\n {\n \"amount\": \"\",\n \"card\": {\n \"balance\": \"\",\n \"company_id\": \"\",\n \"cvv\": \"\",\n \"description\": \"\",\n \"employee_id\": \"\",\n \"expiration\": \"\",\n \"expiration_time\": \"\",\n \"id\": \"\",\n \"pan\": \"\",\n \"state\": \"\",\n \"state_reason\": \"\",\n \"type\": \"\"\n },\n \"card_acceptor\": {},\n \"cardholder\": {\n \"address\": {},\n \"balance\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\"\n },\n \"company_id\": \"\",\n \"duration\": \"\",\n \"id\": \"\",\n \"is_debit\": \"\",\n \"mcc_name\": \"\",\n \"response\": {},\n \"state\": \"\",\n \"type\": \"\"\n },\n {\n \"amount\": \"\",\n \"card\": {\n \"balance\": \"\",\n \"company_id\": \"\",\n \"cvv\": \"\",\n \"description\": \"\",\n \"employee_id\": \"\",\n \"expiration\": \"\",\n \"expiration_time\": \"\",\n \"id\": \"\",\n \"pan\": \"\",\n \"state\": \"\",\n \"state_reason\": \"\",\n \"type\": \"\"\n },\n \"card_acceptor\": {},\n \"cardholder\": {\n \"address\": {},\n \"balance\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\"\n },\n \"company_id\": \"\",\n \"duration\": \"\",\n \"id\": \"\",\n \"is_debit\": \"\",\n \"mcc_name\": \"\",\n \"response\": {},\n \"state\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"success\": \"\"\n}"}],"_postman_id":"055b6d73-6db7-445a-8e0f-8f55711a8aa5"},{"name":"Retrieve business details","id":"142eafc1-8856-4751-b0d0-e050820d4266","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/company/{{COMPANY_ID}}","description":"

To retrieve a specific business, issue a GET request to the /company/{business_id} endpoint. This will give back the details for the business referenced by the business_id.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5a364ac3-0783-492b-a66b-8a9b903588f8","id":"5a364ac3-0783-492b-a66b-8a9b903588f8","name":"companies","type":"folder"}},"urlObject":{"path":["company","{{COMPANY_ID}}"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"4e9e2623-f2e4-4700-b8d2-16bacad73052","name":"500 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company/"},"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":"a0c70433-0604-44f4-a6a7-48731aa2c2d3","name":"200 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"active\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"approved\": \"\",\n \"balance\": \"\",\n \"bank_verified\": \"\",\n \"created_date\": \"\",\n \"date_established\": \"\",\n \"dba_name\": \"\",\n \"email\": \"\",\n \"funding_source\": {\n \"account_number\": \"\",\n \"account_type\": \"\",\n \"name_on_account\": \"\",\n \"routing_number\": \"\"\n },\n \"gpa\": {\n \"available_balance\": \"\",\n \"credit_balance\": \"\",\n \"currency_code\": \"\",\n \"ledger_balance\": \"\",\n \"pending_credits\": \"\"\n },\n \"id\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"ready\": \"\",\n \"registration_number\": \"\",\n \"structure\": \"\",\n \"taxpayer_id\": \"\",\n \"verified\": \"\",\n \"website\": \"\"\n },\n \"success\": \"\"\n}"},{"id":"ab3bba10-0d38-48f0-8219-36e2facb89ff","name":"400 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company/"},"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}"}],"_postman_id":"142eafc1-8856-4751-b0d0-e050820d4266"},{"name":"List Funding sources for a business","id":"5b893c3e-52e2-4169-803f-73e2449b0ac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://sandbox-oem.thepennyinc.com/v2/company/{{COMPANY_ID}}/fundingsources","description":"

List Funding Sources for a business

\n","urlObject":{"path":["company","{{COMPANY_ID}}","fundingsources"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"41cac7e6-fd43-4309-aac9-49b040c845cb","name":"400 response","originalRequest":{"method":"GET","header":[],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company//fundingsources"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"9ac86ebd-a965-4dbf-8345-1fcc646e43c3","name":"200 response","originalRequest":{"method":"GET","header":[],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company//fundingsources"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"c5fdd379-4dab-42c6-b1cb-1bee9cbdbfc7","name":"500 response","originalRequest":{"method":"GET","header":[],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company//fundingsources"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5b893c3e-52e2-4169-803f-73e2449b0ac4"},{"name":"Add Funds to business balance","id":"09cad03c-dde7-4325-878d-f49dee26d798","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"50\",\n \"funding_source\": \"5dda7f582917b53befedc04f\"\n}"},"url":"https://sandbox-oem.thepennyinc.com/v2/company/{{COMPANY_ID}}/fund","description":"

Add funds to a business main balance from a specified funding source.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5a364ac3-0783-492b-a66b-8a9b903588f8","id":"5a364ac3-0783-492b-a66b-8a9b903588f8","name":"companies","type":"folder"}},"urlObject":{"path":["company","{{COMPANY_ID}}","fund"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"72cb9ac2-58f0-4c72-84aa-cdbd800ba367","name":"200 response","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"\",\n \"funding_source\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company//fund"},"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}"},{"id":"992dd602-254a-4411-b970-bce75121332d","name":"400 response","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"\",\n \"funding_source\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company//fund"},"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}"}],"_postman_id":"09cad03c-dde7-4325-878d-f49dee26d798"},{"name":"Delete a business","id":"9b403689-c022-4de3-b3f5-9419b887d454","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/company/:id","description":"

In Order to delete a company, please reach out to Penny In Support.

\n

It is not possible to delete businesses using API calls, please send an email to support@thepennyinc.com

\n","urlObject":{"path":["company",":id"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[{"id":"f7c44698-ed67-4c20-a53a-f656d2288d08","description":{"content":"

The business ID

\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"8932679a-d92c-488c-b51b-34e3ec626f26","name":"400 response","originalRequest":{"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company/"},"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":"a426ea6c-0ef4-48ec-9922-914156b2a176","name":"200 response","originalRequest":{"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company/"},"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}"},{"id":"fad59c89-3772-43a3-a964-4c69d15034f1","name":"500 response","originalRequest":{"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/company/"},"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}"}],"_postman_id":"9b403689-c022-4de3-b3f5-9419b887d454"},{"name":"List All Businesses","id":"a5185655-9e9d-4382-8a73-055adbe512a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/companies","description":"

List all businesses within the API Key account.

\n

This endpoint supports pagination.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5a364ac3-0783-492b-a66b-8a9b903588f8","id":"5a364ac3-0783-492b-a66b-8a9b903588f8","name":"companies","type":"folder"}},"urlObject":{"path":["companies"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[{"disabled":true,"description":{"content":"

By default each page will 30 elemnts, to customize it, use the pageSize parameter.

\n","type":"text/plain"},"key":"pageSize","value":""},{"disabled":true,"description":{"content":"

Page number to fetch

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"afdf133a-038a-4cae-bd9e-b32b51df11b0","name":"200 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/companies?pageSize=&page=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","companies"],"query":[{"key":"pageSize","value":""},{"key":"page","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"companies\": [\n {\n \"active\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"approved\": \"\",\n \"balance\": \"\",\n \"bank_verified\": \"\",\n \"created_date\": \"\",\n \"date_established\": \"\",\n \"dba_name\": \"\",\n \"email\": \"\",\n \"funding_source\": {\n \"account_number\": \"\",\n \"account_type\": \"\",\n \"name_on_account\": \"\",\n \"routing_number\": \"\"\n },\n \"gpa\": {\n \"available_balance\": \"\",\n \"credit_balance\": \"\",\n \"currency_code\": \"\",\n \"ledger_balance\": \"\",\n \"pending_credits\": \"\"\n },\n \"id\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"ready\": \"\",\n \"registration_number\": \"\",\n \"structure\": \"\",\n \"taxpayer_id\": \"\",\n \"verified\": \"\",\n \"website\": \"\"\n },\n {\n \"active\": \"\",\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\"\n },\n \"approved\": \"\",\n \"balance\": \"\",\n \"bank_verified\": \"\",\n \"created_date\": \"\",\n \"date_established\": \"\",\n \"dba_name\": \"\",\n \"email\": \"\",\n \"funding_source\": {\n \"account_number\": \"\",\n \"account_type\": \"\",\n \"name_on_account\": \"\",\n \"routing_number\": \"\"\n },\n \"gpa\": {\n \"available_balance\": \"\",\n \"credit_balance\": \"\",\n \"currency_code\": \"\",\n \"ledger_balance\": \"\",\n \"pending_credits\": \"\"\n },\n \"id\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"ready\": \"\",\n \"registration_number\": \"\",\n \"structure\": \"\",\n \"taxpayer_id\": \"\",\n \"verified\": \"\",\n \"website\": \"\"\n }\n ],\n \"count\": \"\",\n \"end_index\": \"\",\n \"is_more\": \"\",\n \"start_index\": \"\"\n },\n \"success\": \"\"\n}"},{"id":"b20cecb2-5ba0-4859-9b19-4339cceac9a3","name":"400 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/companies?pageSize=&page=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","companies"],"query":[{"key":"pageSize","value":""},{"key":"page","value":""}]}},"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":"e97cfc5a-03a4-4c9f-8a5e-3698aca5a7f9","name":"500 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/companies?pageSize=&page=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","companies"],"query":[{"key":"pageSize","value":""},{"key":"page","value":""}]}},"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}"}],"_postman_id":"a5185655-9e9d-4382-8a73-055adbe512a2"},{"name":"Retrieve Business Primary Nature IDs","id":"a837962f-b8f8-4fd3-a193-029bdf311238","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":"{{API_KEY}}","type":"text"}],"url":"https://sandbox-oem.thepennyinc.com/v2/companies/classifications","description":"

Use this API to get a list of all available business primary nature values.

\n","urlObject":{"path":["companies","classifications"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"c7370a79-c05c-4080-a4dd-2da45d63d280","name":"Retrieve Business Primary Nature IDs","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":"{{API_KEY}}","type":"text"}],"url":"https://sandbox-oem.thepennyinc.com/v2/companies/classifications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2272"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 13 Jan 2020 21:11:08 GMT"},{"key":"x-amzn-RequestId","value":"7e99e257-531e-4229-b7e1-e8ed095f638f"},{"key":"x-amz-apigw-id","value":"GQd00FkFIAMFxoQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5e1cdceb-0dd2dac085eb73f164f65913;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 02fcbf68a81897cc093ee1510fb7e93e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"MAD50-C1"},{"key":"X-Amz-Cf-Id","value":"8iqhSDWWqP-5Yi8Y4vuf9W2P3q_sTekqqzXvNeNyRRPOJE8oIt5drg=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"classifications\": [\n {\n \"value\": \"9ed3f669-7d6f-11e3-b545-5404a6144203\",\n \"label\": \"Food retail and service\"\n },\n {\n \"value\": \"9ed41d89-7d6f-11e3-beff-5404a6144203\",\n \"label\": \"Manufacturing\"\n },\n {\n \"value\": \"9ed35a3b-7d6f-11e3-83c8-5404a6144203\",\n \"label\": \"Business to business\"\n },\n {\n \"value\": \"9ed4449e-7d6f-11e3-a32d-5404a6144203\",\n \"label\": \"Services - other\"\n },\n {\n \"value\": \"9ed3a866-7d6f-11e3-a0ce-5404a6144203\",\n \"label\": \"Entertainment and media\"\n },\n {\n \"value\": \"9ed41d75-7d6f-11e3-b151-5404a6144203\",\n \"label\": \"Home and garden\"\n },\n {\n \"value\": \"9ed35a29-7d6f-11e3-930b-5404a6144203\",\n \"label\": \"Baby\"\n },\n {\n \"value\": \"9ed492c6-7d6f-11e3-80f4-5404a6144203\",\n \"label\": \"Travel\"\n },\n {\n \"value\": \"9ed38152-7d6f-11e3-9042-5404a6144203\",\n \"label\": \"Clothing, accessories, and shoes\"\n },\n {\n \"value\": \"9ed3f686-7d6f-11e3-af6e-5404a6144203\",\n \"label\": \"Health and personal care\"\n },\n {\n \"value\": \"9ed35a2e-7d6f-11e3-a5cf-5404a6144203\",\n \"label\": \"Beauty and fragrances\"\n },\n {\n \"value\": \"9ed3a846-7d6f-11e3-8a79-5404a6144203\",\n \"label\": \"Computers, accessories, and services\"\n },\n {\n \"value\": \"9ed44496-7d6f-11e3-865d-5404a6144203\",\n \"label\": \"Retail\"\n },\n {\n \"value\": \"9ed492bc-7d6f-11e3-9a1b-5404a6144203\",\n \"label\": \"Toys and hobbies\"\n },\n {\n \"value\": \"9ed4448d-7d6f-11e3-aab2-5404a6144203\",\n \"label\": \"Pets and animals\"\n },\n {\n \"value\": \"9ed3a854-7d6f-11e3-a193-5404a6144203\",\n \"label\": \"Education\"\n },\n {\n \"value\": \"9ed248ae-7d6f-11e3-ba6e-5404a6144203\",\n \"label\": \"Arts, crafts, and collectibles\"\n },\n {\n \"value\": \"9ed3cf5f-7d6f-11e3-8af8-5404a6144203\",\n \"label\": \"Financial services and products\"\n },\n {\n \"value\": \"9ed3f67d-7d6f-11e3-bf40-5404a6144203\",\n \"label\": \"Government\"\n },\n {\n \"value\": \"9ed4b9bc-7d6f-11e3-9133-5404a6144203\",\n \"label\": \"Vehicle sales\"\n },\n {\n \"value\": \"9ed44486-7d6f-11e3-89f8-5404a6144203\",\n \"label\": \"Nonprofit\"\n },\n {\n \"value\": \"9ed4b9c6-7d6f-11e3-a156-5404a6144203\",\n \"label\": \"Vehicle service and accessories\"\n },\n {\n \"value\": \"9ed3a85b-7d6f-11e3-8995-5404a6144203\",\n \"label\": \"Electronics and telecom\"\n },\n {\n \"value\": \"9ed35a32-7d6f-11e3-9830-5404a6144203\",\n \"label\": \"Books and magazines\"\n },\n {\n \"value\": \"9ed44492-7d6f-11e3-98d1-5404a6144203\",\n \"label\": \"Religion and spirituality (for profit)\"\n },\n {\n \"value\": \"9ed492ac-7d6f-11e3-a2d2-5404a6144203\",\n \"label\": \"Sports and outdoors\"\n },\n {\n \"value\": \"9ed3f677-7d6f-11e3-96a2-5404a6144203\",\n \"label\": \"Gifts and flowers\"\n },\n {\n \"label\": \"VALID TEST CLASSIFICATION\",\n \"value\": \"9ed3f670-7d6f-11e3-b1ce-5404a6144203\"\n }\n ]\n }\n}"}],"_postman_id":"a837962f-b8f8-4fd3-a193-029bdf311238"}],"id":"5a364ac3-0783-492b-a66b-8a9b903588f8","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"86482359-7956-4a79-9e98-203d1211c618","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"57714b28-dbcb-4776-ae24-3e99eb2c75e3","type":"text/javascript","exec":[""]}}],"_postman_id":"5a364ac3-0783-492b-a66b-8a9b903588f8","description":""},{"name":"transfers","item":[{"name":"/transfers","id":"d933e60e-c915-46af-9045-500489900059","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 50,\n \"receiver_is_company\": false,\n \"sender_is_company\": true,\n \"receiver\": \"{{EMPLOYEE_ID}}\",\n \"company_id\": \"{{COMPANY_ID}}\"\n}"},"url":"https://sandbox-oem.thepennyinc.com/v2/transfers","description":"

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.

\n

Penny have two types of transfers:

\n
    \n
  1. 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).
    2. \n
  2. Cardholder - Cardholder: This allows you to move funds from Cardholder X to Cardholder Y assuming they are within same business.
    3. \n
\n

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

\n

The parameters to sent are:

\n
    \n
  • 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.
    • \n
  • 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.
    • \n
  • 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).
    • \n
  • 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).
    • \n
  • amount: The amount to be sent.
    • \n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}},"urlObject":{"path":["transfers"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"2801f86c-4bdb-4990-ad53-65a23309c02f","name":"200 response","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"\",\n \"receiver_is_company\": \"\",\n \"sender_is_company\": \"\",\n \"receiver\": \"\",\n \"sender\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/transfers"},"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}"},{"id":"7d0e7be3-7dd0-471f-a7af-8eecad6e32ff","name":"400 response","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"\",\n \"receiver_is_company\": \"\",\n \"sender_is_company\": \"\",\n \"receiver\": \"\",\n \"sender\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/transfers"},"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}"}],"_postman_id":"d933e60e-c915-46af-9045-500489900059"}],"id":"ad5d6587-068b-4982-a5a9-edf5f6fedf2f","_postman_id":"ad5d6587-068b-4982-a5a9-edf5f6fedf2f","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}}},{"name":"transactions","item":[{"name":"/transactions","id":"8b0913c0-bca4-49e0-bafa-56a89599f58b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/transactions?company_id=&state=&page=&pageSize=&card_id=&q=&to_date=&from_date=&type =","description":"

To list all transactions, issue a GET request to /transactions, this will return all transactions but you can filter them by card_id, company_id or just by keyword using the URL query string param q.

\n

The response will include all relevant transactions in an array attribute transactions.

\n

Transactions are complicated objects, if you need help understanding any property of the those objects, don't hesitate to contact us.

\n

Note: This endpoint supports pagination.

\n","urlObject":{"path":["transactions"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[{"key":"company_id","value":""},{"key":"state","value":""},{"key":"page","value":""},{"key":"pageSize","value":""},{"key":"card_id","value":""},{"key":"q","value":""},{"description":{"content":"

Filter transactions by date range

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

Filter transactions by date range

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

Allowed values (to send list of types, separate them by comma ','): authorization.pending,authorization.posted, authorization.declined,authorization.credit,gpa.ach.pending,gpa.ach.failed,gpa.ach.processed,gpa.ach.cancelled,gpa.credit.paymentcard,transfer.peer

\n","type":"text/plain"},"key":"type ","value":""}],"variable":[]}},"response":[{"id":"2d44b5fa-75b2-4bba-9554-53e970aa9c66","name":"200 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/transactions?company_id=&state=&page=&pageSize=&card_id=&q=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","transactions"],"query":[{"key":"company_id","value":""},{"key":"state","value":""},{"key":"page","value":""},{"key":"pageSize","value":""},{"key":"card_id","value":""},{"key":"q","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"count\": \"\",\n \"end_index\": \"\",\n \"is_more\": \"\",\n \"start_index\": \"\",\n \"transactions\": [\n {\n \"amount\": \"\",\n \"card\": {\n \"balance\": \"\",\n \"company_id\": \"\",\n \"cvv\": \"\",\n \"description\": \"\",\n \"employee_id\": \"\",\n \"expiration\": \"\",\n \"expiration_time\": \"\",\n \"id\": \"\",\n \"pan\": \"\",\n \"state\": \"\",\n \"state_reason\": \"\",\n \"type\": \"\"\n },\n \"card_acceptor\": {},\n \"cardholder\": {\n \"address\": {},\n \"balance\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\"\n },\n \"company\": {\n \"approved\": \"\",\n \"bank_verified\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"ready\": \"\",\n \"structure\": \"\"\n },\n \"duration\": \"\",\n \"id\": \"\",\n \"is_debit\": \"\",\n \"mcc_name\": \"\",\n \"response\": {},\n \"state\": \"\",\n \"type\": \"\"\n },\n {\n \"amount\": \"\",\n \"card\": {\n \"balance\": \"\",\n \"company_id\": \"\",\n \"cvv\": \"\",\n \"description\": \"\",\n \"employee_id\": \"\",\n \"expiration\": \"\",\n \"expiration_time\": \"\",\n \"id\": \"\",\n \"pan\": \"\",\n \"state\": \"\",\n \"state_reason\": \"\",\n \"type\": \"\"\n },\n \"card_acceptor\": {},\n \"cardholder\": {\n \"address\": {},\n \"balance\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\"\n },\n \"company\": {\n \"approved\": \"\",\n \"bank_verified\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"ready\": \"\",\n \"structure\": \"\"\n },\n \"duration\": \"\",\n \"id\": \"\",\n \"is_debit\": \"\",\n \"mcc_name\": \"\",\n \"response\": {},\n \"state\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"success\": \"\"\n}"},{"id":"c2c515ac-f9c6-45b4-9b94-29a15b6e577f","name":"400 response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":{"raw":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/transactions?company_id=&state=&page=&pageSize=&card_id=&q=","protocol":"https","host":["2d3fkf1bfa","execute-api","us-east-1","amazonaws","com"],"path":["{{basePath}}","transactions"],"query":[{"key":"company_id","value":""},{"key":"state","value":""},{"key":"page","value":""},{"key":"pageSize","value":""},{"key":"card_id","value":""},{"key":"q","value":""}]}},"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}"}],"_postman_id":"8b0913c0-bca4-49e0-bafa-56a89599f58b"}],"id":"d335de31-845f-4a4d-b5d4-e10b22edf827","description":"

Transactions Types

\n

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
Transaction TypeDescription
authorization.pendingPurchase Authorized, But still Pending
authorization.postedPurchase Transioned to Cleared state
authorization.declinedDeclined Authorization
authorization.creditRefund / Reversed / Cancelled Authorization
gpa.ach.pendingAn ach load created but pending
gpa.ach.failedACH Failed for some reason
gpa.ach.processedACH Successfully Processed, Funds reached Destination
gpa.ach.cancelledACH was cancelled
gpa.credit.paymentcardFund Load via Credit/Debit Card
transfer.peerTransfer Initiated (Card/Card or Business/Card)
\n

Transaction Statuses

\n

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
StatusDescription
PENDINGTransaction is initiated, but didn't reacha final state yet.
CLEAREDTransaction completed with success.
DECLINEDTransaction rejected
REVERSEDRepresent a credit, could be refund or a cancelled ACH
\n
","event":[{"listen":"prerequest","script":{"id":"2aa83ca6-720c-40f5-a47c-2f427574157e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cc92bd23-be35-4613-9f38-d3e73222bc34","type":"text/javascript","exec":[""]}}],"_postman_id":"d335de31-845f-4a4d-b5d4-e10b22edf827","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}}},{"name":"cardholders","item":[{"name":"Create new cardholder","id":"b66e16b9-60ea-4328-ad52-6e26494722a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \n \"company_id\": \"{{COMPANY_ID}}\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n}"},"url":"https://sandbox-oem.thepennyinc.com/v2/cardholders","description":"

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

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}},"urlObject":{"path":["cardholders"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"9339c66e-643b-4c6f-af41-eee4a7494f06","name":"Cardholder created successfully.","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birth_date\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"_id\": \"\",\n \"account_holder\": \"\",\n \"balance\": \"\",\n \"business\": \"\",\n \"created_date\": \"\",\n \"employee_number\": \"\",\n \"groups\": \"\",\n \"is_admin\": \"\",\n \"user\": \"\"\n },\n \"success\": \"\"\n}"},{"id":"b2c37b3b-40ae-4022-a9f6-17a5ed23658d","name":"Missing Fields or wrong request body","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birth_date\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders"},"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":"ce6a7a88-636a-4bca-952b-dee478c705af","name":"Something wrong happened on server side","originalRequest":{"method":"POST","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birth_date\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders"},"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}"}],"_postman_id":"b66e16b9-60ea-4328-ad52-6e26494722a2"},{"name":"Update cardholder","id":"7c55d82d-a27b-4c7e-9786-cb64cbd48fb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birth_date\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n}"},"url":"https://sandbox-oem.thepennyinc.com/v2/cardholders/:id","description":"

Update cardholder details

\n","urlObject":{"path":["cardholders",":id"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[{"id":"08b6ba23-bc9b-483c-bbc0-1bd51ea253a5","description":{"content":"

The Cardholder ID

\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"6bb40123-8e8d-44ce-8189-7e1d106e1648","name":"Cardholder updated successfulyy","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birth_date\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"_id\": \"\",\n \"account_holder\": \"\",\n \"balance\": \"\",\n \"business\": \"\",\n \"created_date\": \"\",\n \"employee_number\": \"\",\n \"groups\": \"\",\n \"is_admin\": \"\",\n \"user\": \"\"\n },\n \"success\": \"\"\n}"},{"id":"de09eddf-b88b-4625-929f-45d8576edf4e","name":"Error on server while updating the cardholder details","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birth_date\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"f7beceac-e2ab-4a64-a4d8-e22f940fe82f","name":"Update cardholder error, bad request body","originalRequest":{"method":"PUT","header":[{"key":"X-PENNY-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birth_date\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n}"},"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7c55d82d-a27b-4c7e-9786-cb64cbd48fb3"},{"name":"Retrieve a cardholder","id":"e8fa69c5-75b3-4332-809f-5f9723a687a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/cardholders/{{EMPLOYEE_ID}}","description":"

Retrieve a single cardholder by ID

\n","urlObject":{"path":["cardholders","{{EMPLOYEE_ID}}"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[]}},"response":[{"id":"18cec8e0-8114-4c4b-a654-0bbd7e31acb9","name":"Server error","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders/"},"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":"8ffdc094-8c29-4a07-906c-61f70bb91971","name":"Cardholder Response","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"balance\": \"\",\n \"company_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"id\": \"\",\n \"last_name\": \"\"\n}"},{"id":"c01fb6ee-ce9a-4fcc-9f0e-80e350ac8911","name":"Error retrieving the cardholder","originalRequest":{"method":"GET","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders/"},"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}"}],"_postman_id":"e8fa69c5-75b3-4332-809f-5f9723a687a1"},{"name":"Delete a cardholder","id":"aa3e007f-af6e-4456-bd44-da4168b6c808","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://sandbox-oem.thepennyinc.com/v2/cardholders/:id","description":"

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

\n","urlObject":{"path":["cardholders",":id"],"host":["https://sandbox-oem.thepennyinc.com/v2"],"query":[],"variable":[{"id":"6ca9d807-4c7c-488a-b4a9-16d583217a54","description":{"content":"

The Cardholder ID

\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"32eff804-aa85-49c3-8b16-d224bc79a660","name":"Generic backend error","originalRequest":{"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders/"},"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":"ab523895-b8f3-4372-9ada-46049a0c0d84","name":"Cardholder deleted ","originalRequest":{"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders/"},"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}"},{"id":"cb2ebde7-aaed-4c2c-a299-da6f08ccd2df","name":"Error while deleting the cardholder","originalRequest":{"method":"DELETE","header":[{"key":"X-PENNY-API-KEY","value":""}],"url":"https://2d3fkf1bfa.execute-api.us-east-1.amazonaws.com/{{basePath}}/cardholders/"},"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}"}],"_postman_id":"aa3e007f-af6e-4456-bd44-da4168b6c808"}],"id":"8a01a7f1-6e85-4971-9c03-84cffc6e19fb","_postman_id":"8a01a7f1-6e85-4971-9c03-84cffc6e19fb","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","id":"0ff92092-3186-4797-b677-f9d6f8cf8e7a","name":"[Penny][Dedicated] Dedicated API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-PENNY-API-KEY"},{"key":"value","value":"{{API_KEY}}"}]}},"event":[{"listen":"prerequest","script":{"id":"c599a24d-a138-44ea-a84b-8ed51d3010fc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d6511794-70ad-4add-abca-e3da7bb18045","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://sandbox-oem.thepennyinc.com/v2"}]}