Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Info |
|---|
All API endpoints require an authentication header to be included with the request. See API Authentication |
Fetch Customers Collection
Returns a collection of transactions that have been processed
End-point | Method | Description |
|---|---|---|
https://secure.gotobilling.com/api/customers | GET | Returns a collection of transactions that have been processedcustomers |
Collection Filters
Parameters that can be included in the query string of the request when using the GET /api/customers endpoint.
Parameter | Type | Description |
|---|---|---|
id | int or Array Filter | OmniFund assigned Customer ID |
customerRef | string | Merchant provided customer reference ID |
firstName | string | Customer first name |
lastName | string | Customer last name |
company | string | Company name |
string | Customer email address |
Request
| Code Block |
|---|
GET /api/customers?id[]=23143879&id[]=21879654 |
Response
| Code Block |
|---|
{
"@context": "/api/contexts/customers",
"@id": "/api/customers",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/customers/23143879",
"@type": "customers",
"id": 23143879,
"customerRef": "sw-1234",
"company": "Cloud City",
"firstName": "Lando",
"lastName": "Calrissian",
"email": "test@email.com",
"displayAs": "company",
"address1": "123 main st",
"address2": "",
"city": "Somewhere",
"state": "Co",
"zip": "55555",
"phone": "(800) 555-4578",
},
{
"@id": "/api/customers/21879654",
"@type": "customers",
"id": 21879654,
"customerRef": "sw-1235",
"company": "",
"firstName": "Han",
"lastName": "Solo",
"email": "test@email.com",
"displayAs": "contact",
"address1": "123 main st",
"address2": "",
"city": "Somewhere",
"state": "Co",
"zip": "55555",
"phone": "(800) 555-4578"
}
],
"hydra:totalItems": 2
} |
Fetch Customer Resource
Return a single customer resource based on the ID provided
End-point | Method | Description |
|---|---|---|
https://secure.gotobilling.com/api/customers/{id} | GET | Return a single customer resource based on the ID provide |
Request
| Code Block |
|---|
GET https://secure.gotobilling.com/api/customers/2613558 |
Response
| Code Block |
|---|
Content-Type application/ld+json; charset=utf-8
{
"@context": "/api/contexts/customers",
"@id": "/api/customers/2613558",
"@type": "customers",
"id": 2613558,
"customerRef": "123456",
"company": "123 Company",
"firstName": "",
"lastName": "",
"email": "test@email.com",
"displayAs": "contact",
"address1": "123 main st",
"address2": "",
"city": "Somewhere",
"state": "Co",
"zip": "55555",
"phone": "(800) 555-4578"
} |
Create Customer Resource
End-point | Method | Description |
|---|---|---|
https://secure.gotobilling.com/api/customers | POST | Create a new customer resource |
Parameters
Parameter | Type | Description |
|---|---|---|
customerRef | string | Required. Merchant provided customer reference ID. |
firstName | string | Customer first name |
lastName | string | Customer last name |
company | string | Company name |
string | Customer email address. Either | |
displayAs | string | Valid options: |
address1 | string | Address line 1 |
address2 | string | Address line 2 |
city | string | City |
state | string (2) | Two-characater State abbreviation |
zip | string | Zip code |
phone | string | Phone number |
Request
| Code Block |
|---|
POST https://secure.gotobilling.com/api/customers
Content-Type application/json
{
"customerRef": "test-1234",
"type": "individual",
"firstName": "Test",
"lastName": "Account",
"company": "Acme Widgets",
"email": "test@email.com"
}
|
Response
| Code Block |
|---|
Content-Type application/ld+json; charset=utf-8
{
"@context": "/api/contexts/customers",
"@id": "/api/customers/2970583",
"@type": "customers",
"id": 2970583,
"customerRef": "test-1234",
"company": "Acme Widgets",
"firstName": "Test",
"lastName": "Account",
"email": "test@email.com",
"displayAs": "contact",
"address1": "",
"address2": "",
"city": "",
"state": "",
"zip": "",
"phone": ""
} |
| Table of Contents |
|---|