https://docs.snapbill.com/ 2026-04-27T06:27:02+0000 https://docs.snapbill.com/ https://docs.snapbill.com/lib/tpl/snapdocs/images/favicon.ico text/html 2014-10-17T09:26:13+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/account?rev=1413537973&do=diff Accounts Retrieve the current account and return it's details. Parameter listing Name Availability Descriptiondepth get The depth parameter signals the amount of data for the given account. depth=0 is the highest level which provides full detail. text/html 2014-10-18T07:12:32+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/action?rev=1413616352&do=diff Actions /v1/action/id/get Retrieve an action by id and return it's details. $ curl -u user:pass -d "" \ > https://api.snapbill.com/v1/action/1034/get.json Action Parameter Listing Name Availability Descriptiondepth get The depth parameter signals the amount of data for the action that was provided. depth=0 is the highest level that provides full detail. text/html 2014-10-18T07:11:53+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/batch?rev=1413616313&do=diff Batches /v1/batch/id/get Fetch a batch and return the details $ curl -u user:pass -d "" \ > https://api.snapbill.com/v1/batch/1500/get.json Available states Name Descriptionready The batch has been prepared. From here it can either be moved into submit, or will be automatically changed to build if any clients are added. text/html 2015-03-26T12:59:20+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/check_digit_verification?rev=1427374760&do=diff Check Digit Verification (CDV) Chat to us about making use of Check Digit Verification (CDV) for South African bank accounts and all popular credit cards via our API. SnapBill provides a simple to use Rest-based, JSON, API for validating all popular South African bank account and credit card numbers. text/html 2014-10-18T07:13:46+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/client?rev=1413616426&do=diff Clients /v1/client/id/get Retrieve a client by id and return it's details. $ curl -u user:pass -d "" \ > https://api.snapbill.com/v1/client/158975/get.json /v1/client/add Creates a new client and returns it's details. $ curl -u user:pass -d "firstname=jane&email=jane@example.com" \ > https://api.snapbill.com/v1/client/add.json text/html 2014-10-17T19:42:50+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/contact?rev=1413574970&do=diff Contacts /v1/contact/id/get Retrieve a contact. Parameter listing Name Availability Descriptionid get The id of the contact. This is guaranteed to be unique per client.xid get The xid of the contact. This is guaranteed to be globally unique. (see Concepts - xid) text/html 2014-10-17T19:43:17+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/country?rev=1413574997&do=diff Countries /v1/country/code/get Get the specified country. 'code' must be the iso2 code. Parameter listing Name Availability Descriptiondepth get The depth parameter signals the amount of data for the country that was provided. depth=0 is the highest level that provides full detail. text/html 2014-10-18T07:24:08+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/currency?rev=1413617048&do=diff Currencies /v1/currency/code/get Get the specified currency details. Parameter listing Name Availability Descriptioncode get The unique ISO 4217 code three letter code for the currency, which is always specified in upper case.format get A printf style format string for rendering amounts in this currencies standard format. text/html 2014-10-17T19:44:16+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/email?rev=1413575056&do=diff Emails /v1/email/id/get Retrieve an Email by id and return it's details. 'id' => $this->id, 'xid' => $this->xid, 'state' => $this->state, 'date' => $this->date, 'client' => $this->client_id ? $this->client->get_data($level+1) : NULL, 'user' => $this->from_user_id ? $this->from_user->get_data($level+1) : NULL, 'from' => $this->from, 'to' => $this->to, 'subject' => $this->subject text/html 2016-05-26T14:34:23+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/invoice?rev=1464273263&do=diff Invoices /v1/client/id/add_invoice Add an invoice for a client. The example adds an invoice with two items. $ curl -u user:pass -d "date=2013-01-07" \ > -d "description[0]=rolls&unit_cost[0]=1.12&quantity[0]=13" \ > -d "description[1]=chips&unit_cost[1]=20&quantity[1]=1" \ > https://api.snapbill.com/v1/client/158958/add_invoice.json text/html 2014-10-18T07:49:04+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/package?rev=1413618544&do=diff Packages /v1/package/id/get Retrieve a package by id and return it's details. Parameter listing Name Availability Descriptiondepth get The depth parameter signals the amount of data for the package that was provided. depth=0 is the highest level that provides full detail. text/html 2014-10-18T07:54:57+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/payment?rev=1413618897&do=diff Payments /v1/payment/id/get Retrieve a payment by id and return it's details. Parameter listing Name Availability Descriptiondepth get The depth parameter signals the amount of data for the payment that was provided. depth=0 is the highest level that provides full detail. text/html 2014-10-18T08:00:14+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/payment_details?rev=1413619214&do=diff Payment Details /v1/payment_details/id/get Retrieve payment_details by id and return the details. /v1/payment_details/id/update Update payment details by id. $ curl -u user:pass -d "expiry=2025-06" \ > https://api.snapbill.com/v1/payment_details/143476/update.json text/html 2014-10-18T11:54:13+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/payment_method?rev=1413633253&do=diff Payment Methods /v1/payment_method/code/get Fetches a detailed listing of the given payment method. $ curl -u user:pass -d "" \ > https://api.snapbill.com/v1/payment_method/other/get.json Parameter listing Name Availability Description text/html 2014-10-18T12:07:13+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/recurring_invoice?rev=1413634033&do=diff Recurring Invoices /v1/client/id/add_recurring_invoice Add an invoice for a client. The example adds an invoice with two items. $ curl -u user:pass -d "first=2013-06-01&mode=DAYMONTH&number=1" \ > -d "description[]=rolls&unit_cost[]=5&quantity[]=12" \ > -d "description[]=cakes&unit_cost[]=120&quantity[]=1" \ > https://api.snapbill.com/v1/client/158958/add_recurring_invoice.json text/html 2014-10-18T12:11:53+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/service?rev=1413634313&do=diff Services /v1/client/id/add_service Adds a service to a client. $ curl -u user:pass -d "service_type_id=596&package=Delicious%20Pancakes&term=1" \ > https://api.snapbill.com/v1/client/158958/add_service.json Add Service Parameters Name text/html 2014-10-18T12:18:38+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/service_type?rev=1413634718&do=diff Service Types /v1/service_type/id/get Retrieve a service_type by id and return it's details. Parameter listing Name Availability Descriptiondepth get The depth parameter signals the amount of data for the payment method that was provided. depth=0 is the highest level that provides full detail. text/html 2014-10-18T12:23:46+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/signup?rev=1413635026&do=diff Signups The signup object gives you a level of control over signups that are completed, as well as ones in progress. Creating signups The ability to create signups that at a certain step of the process is a very powerful tool of the api. We do allow you to jump straight to certain points which is fully described by our text/html 2014-10-17T19:45:05+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/sms?rev=1413575105&do=diff SMSes /v1/sms/id/get Retrieve an SMS by id and return it's details. SMS Parameter Listing Name Availability Descriptionto get The phone number the SMS was sent to.state get The current state of the SMS.user get The user associated with the sending of the SMS. text/html 2014-10-18T12:29:22+0000 Anonymous (anonymous@undisclosed.example.com) https://docs.snapbill.com/developers/api/user?rev=1413635362&do=diff Users User objects allow clients to login to the client area <https://<your username>.snapbill.com>. /v1/client/id/add_user This api call will create a user. Since we have not specified the username and password they will be automatically generated. Note The password is returned here, but will not be available in future requests.