Getting Started

https the featherpay apis will only accept https traffic rest / json api featherpay apis are restful json apis environments there are 2 api environments each environment has separate databases and their own keys https //api featherpay io (for production) https //gfp api acdev io (for staging/sandbox) you can also login to our ui interface for creating and seeing the status of invoices, the same way a merchant may do https //admin featherpay io/ (production) https //gfp admin acdev io/ (staging/sandbox) the staging/sandbox environment is more volatile, but also more up to date where the above production environment is updated every 2 weeks, this environment is updated as soon as development / code review is completed you can also use our swagger tool (mentioned below) to gain valuable testing insights into our apis keys there are 3 store wide, 52 alphanumeric character api keys per environment per store (location) a public key , which is sharable with front end applications for embedding patient facing payments iframe a merchant public key , whic is shareable with front end applications for embedding merchant facing payments iframe a private key , which is used for our api calls this should be only stored and used on your server all apis can be called from your backend using your private key some apis can be called from the front end using a combination of your public key and an order specific order key the order key is used to securely carry out operations from your front end, and should not be stored, logged, put in a url, or exposed to anyone besides the customer ids all ids in our system are 26 alphanumeric character ulids (see https //github com/ulid/spec ) your store id will be provided x store id all rest api calls should be made with a http header key of x store id and the value being the 26 alphanumeric character ulid that is given to you with the keys amounts amounts are all in us dollars and cents, multiplied by 100, resulting in an integer so $500 00 would be represented as 50000 errors there may be varying statuses based on the error of the request, but all error messages will return a field message with the error message comments in the following api documentation, a few curl commands have comments by a field to better explain the use of that parameter / field as this is not valid json, please make sure to remove these comments before running the curl command staging environment (optional) there is a 3rd staging environment, which is more volatile, but also more up to date where the above 2 environmens are updated every 2 weeks, this environment is updated as soon as development / code review is completed you can also use our swagger tool (mentioned below) to gain valuable testing insights into our apis the staging api endpoint is https //gfp api acdev io data from this environment can be viewed via the admin panel at https //gfp admin acdev io/ swagger (optional) in our staging environment we have an api tool (that you can login using the credentials you use to access the staging admin panel) which will act like a postman specific to our api applications for testing api calls, urls, headers, and body values the following url and access is available only in our staging environment, and is not available in sandbox or production almost all of these apis are internal and do not need to be used externally ​​ https //gfp test api acdev io/ credentials will be provided