OSV Giving - Camino API

Introduction

This API Integrates OSV Hub Giving with Camino church management system. This API retrieves transaction data from the OSV Hub Giving module and pushes the data into the Camino application.

Authentication

The Camino application must have authorization to use the OSV API. Authentication is accomplished through a bearer token, which expires one year from generation. The bearer token is unique to each organization and is generated by OSV Hub. Users must have OSV Hub login credentials to generate a token.

For instructions on generating a personal access token, please see Generate Camino Personal Access Token.

Request Method and Endpoint

Method: POST

Endpoint: https://api.osvhub.com/api/v1/camino/data

Authorization

Auth Type: OAuth 2.0
Authorization Header Format: Bearer {token}

Headers

Content-Type: application/json
X-Organization Header: A 12-digit unique identifier for each organization
- Example Header:

POST Body

JSON format

{
"startDate": "YYYY-MM-DD",
"endDate": "YYYY-MM-DD"
}

Example POST Body:

Successful Response

Successful Response Code: 200 OK

A successful response returns a count of records and a JSON data array with the following values (corresponding OSV Hub System information noted):

Array Value	OSV Hub System Information
firstName	First Name
lastName	Last Name
idNumber	Envelope Number
amount	Amount
contributionDate	Transaction Date Given
fundNumber	Fund Number
activity	Fund Name
paymentType	Payment Type
transactionId	Transaction ID
processingFee	Processing Fee

Example Response:

Response Codes

Possible Response Codes:

200 OK
400 Bad Request
- Possible errors:
  - Invalid parameter format
  - startDate after endDate
  - missing X-Organization header
403 Forbidden
404 Not Found
- Provided organization number is not in our system