Skip to content

Spense Partner APIs (v1)

Download OpenAPI description
partner.json
partner.yaml
Languages
Servers
Production API
https://api.spensepay.com/partner/

Authentication

Operations

Get OAuth2 access token

Request

Bodyapplication/x-www-form-urlencoded
grant_typestring(Grant Type)^(client_credentials|refresh_token)$
Default "client_credentials"
scopestring(Scope)
Default ""
client_idClient Id (string) or Client Id (null)(Client Id)
Any of:
string(Client Id)
client_secretClient Secret (string) or Client Secret (null)(Client Secret)
Any of:
string(Client Secret)
curl -i -X POST \
  https://api.spensepay.com/partner/auth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d grant_type=client_credentials \
  -d scope= \
  -d client_id=your_client_id \
  -d client_secret=your_client_secret

Responses

Successful Response

Bodyapplication/json
access_tokenstring(Access Token)required

The access token (UUID)

token_typestring(Token Type)

The type of the token, typically 'bearer'.

Default "bearer"
expires_ininteger(Expires In)required

The number of seconds until the token expires.

Response
application/json
{
  "access_token": "123e4567-e89b-12d3-a456-426614174000",
  "token_type": "bearer",
  "expires_in": 3600
}

Verify that the bearer token is valid.

Request

Security
OAuth2ClientCredentials
curl -i -X GET \
  https://api.spensepay.com/partner/auth/ping \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
object(Response Ping)
Response
application/json
{}

Get the list of organizations you have access to.

Request

Get the list of organizations the user has access to.

Security
OAuth2ClientCredentials
curl -i -X GET \
  https://api.spensepay.com/partner/auth/organizations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/jsonArray [
idstring(Id)^[a-fA-F0-9]{24}$required
namestring(Name)required
vat_numberVat Number (string) or Vat Number (null)(Vat Number)
Any of:
string(Vat Number)
countryCountry (string) or Country (null)(Country)
Any of:
string(Country)
payment_profilesArray of objects(Payment Profiles)
Default []
]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "vat_number": "string",
    "country": "string",
    "payment_profiles": []
  }
]

Settlements

Operations

Payment Methods

Operations

Webhooks

Copyright © Spense AS