Skip to main content
POST
/
v5
/
banks
/
integration
Save an integration
curl --request POST \
  --url https://sandbox.hurdlr.com/rest/v5/banks/integration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: */*' \
  --data '
{
  "apiName": "FRESHBOOKS",
  "apiUserId": "<string>",
  "redirectUri": "<string>",
  "state": "<string>"
}
'
{
  "url": "<string>",
  "result": "SUCCESS",
  "errors": {
    "fieldErrors": {},
    "globalErrors": [
      {
        "type": "DUPLICATE",
        "errorMessage": "<string>"
      }
    ]
  },
  "id": "<string>",
  "webhook": {
    "userId": "<string>",
    "accountantUserId": "<string>",
    "type": "ENTITY_UPDATE"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

*/*
​
apiName
enum<string>
required

Name of the OAuth Provider

Available options:
FRESHBOOKS,
GUSTO,
SHOPIFY,
STRIPE,
SQUARE,
UBER
​
apiUserId
string

ID of the user in the OAuth Provider's API

​
redirectUri
string

The final redirect URI for the user within the partner's app

​
state
string

Any additional state to pass to final redirect URI

Response

200 - application/json

Successful operation

​
url
string
required

URL to redirect to for the user to authenticate with the OAuth Provider

​
result
enum<string>

The result of the action performed

Available options:
SUCCESS,
FAILURE
​
errors
object

Error object containing details errors incurred, if any

​
id
string

Id of the entity being acted upon

​
webhook
object