Splitti Universal (1.0.0)

Download OpenAPI specification:Download

This is the Splitti Universal API version

V1 defines the specification of a set of core APIs for Splitti Universal and includes all current endpoints, request and response objects, description of their properties and possible error responses.

It is intended that programs written to the V1 specification will continue to run correctly, unchanged, over the lifetime of the specification. At some indefinite point a V2 specification may arise, but until that time, programs that work today should continue to work even as future "point" releases of V1 arise (V1.1, V1.2 etc)

The APIs may grow, acquiring new paths/endpoints and features, add new optional request parameters and add response parameters but not in a way that breaks existing code.

There is a rare exception but In the case of changes required by new government regulations or changes otherwise outside the purview of Splitti our systems will detect active users of the previous API and facilitate migration to an updated API during a grace period. Any breaking changes will be communicated explicitly with all users and with follow-ups as required on a case by case basis.

  • Currency are always represented with 3-letter code as defined in ISO 4217
  • Countries are always represented with 2-letter code as defined in ISO 3166-1 alpha-2
  • Datetime is always represented as defined in RFC3339 / ISO8601
  • All root objects are canonically addressable by an SRN.
  • Most root objects have url-safe random 128bit UUIDs that are base64url encoded (as defined in RFC 4648)

Authentication

splitti_auth

Security Scheme Type OAuth2
implicit OAuth Flow
Authorization URL: http://petstore.swagger.io/oauth/dialog
Scopes:
  • universal.account -

    manage your account.

  • universal.account.read -

    read details about your account.

  • universal.files -

    create and manage files and documents.

  • universal.files.read -

    read details about files.

  • universal.payment.disputes -

    manage disputes.

  • universal.payment.disputes.read -

    read details about disputes.

  • universal.payment.intents -

    create and manage payment intents.

  • universal.payment.intents.read -

    read details about payment intents.

  • universal.payment.methods -

    create and manage payment methods.

  • universal.payment.methods.read -

    read details about payment methods.

  • universal.payment.refunds -

    refund payments.

  • universal.payment.refunds.read -

    read details about refunds.

  • universal.payouts -

    create and manage payouts.

  • universal.payouts.read -

    read details about payouts.

  • universal.platform.accounts -

    create and manage your platform accounts.

  • universal.platform.accounts.read -

    read details about your platform accounts.

  • universal.terminal.reader -

    create and manage terminal readers.

  • universal.terminal.reader.read -

    read details about terminal readers.

  • universal.terminal.location -

    create and manage terminal locations.

  • universal.terminal.location.read -

    read details about terminal locations.

  • universal.webhooks -

    create and manage webhooks

  • universal.webhooks.read -

    read details about webhooks.

Account

Everything needed to manage your account.

getCountrySpecs

Authorizations:
splitti_auth (universal.accountuniversal.account.read)

Responses

200

Returns a list of country specs.

400

The request was unacceptable, possibly due to missing a required parameter or due to badly formed json.

402

The parameters were valid but the request failed.

403

The user doesn't have permissions to perform the request.

429

Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500

Something went wrong on our end.

502

Something went wrong on our end.

503

Something went wrong on our end.

504

Something went wrong on our end.

get /country-specs
https://universalapi.splitti.is/v1/country-specs

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "data":
    [
    ],
  • "hasMore": false,
}

getCountrySpecsByCode

Authorizations:
splitti_auth (universal.platform.readuniversal.account.read)
path Parameters
countryCode
required
string 2 characters
Example: IS

Two-letter country code (ISO 3166-1 alpha-2).

Responses

200

Returns a list of country specs.

400

The request was unacceptable, possibly due to missing a required parameter or due to badly formed json.

402

The parameters were valid but the request failed.

403

The user doesn't have permissions to perform the request.

429

Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500

Something went wrong on our end.

502

Something went wrong on our end.

503

Something went wrong on our end.

504

Something went wrong on our end.

get /country-specs/{countryCode}
https://universalapi.splitti.is/v1/country-specs/{countryCode}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "defaultCurrency": "EUR",
  • "supportedBankAccountCurrencies":
    [
    ],
  • "supportedPaymentCurrencies":
    [
    ]
}

Retrieve your account information and settings.

Authorizations:
splitti_auth (universal.accountuniversal.account.read)

Responses

200

Returns an Account if successful and everything worked as expected.

400

The request was unacceptable, possibly due to missing a required parameter or due to badly formed json.

402

The parameters were valid but the request failed.

403

The user doesn't have permissions to perform the request.

429

Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500

Something went wrong on our end.

502

Something went wrong on our end.

503

Something went wrong on our end.

504

Something went wrong on our end.

get /account
https://universalapi.splitti.is/v1/account

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "WYTAdDJ75vk",
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z",
  • "country": "IS",
  • "businessProfile":
    {
    },
  • "businessType": "individual",
  • "capabilities":
    {
    },
  • "chargesEnabled": false,
  • "company":
    {
    },
  • "defaultCurrency": "EUR",
  • "detailsSubmitted": false,
  • "email": "user@example.com",
  • "requestedCapabilities":
    [
    ],
  • "individual":
    {
    },
  • "payoutsEnabled": false,
  • "requirements":
    {
    },
  • "settings":
    {
    }
}

Update your account information and settings.

Authorizations:
splitti_auth (universal.account)

Responses

200

Returns an Account if successful and everything worked as expected.

400

The request was unacceptable, possibly due to missing a required parameter or due to badly formed json.

402

The parameters were valid but the request failed.

403

The user doesn't have permissions to perform the request.

429

Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500

Something went wrong on our end.

502

Something went wrong on our end.

503

Something went wrong on our end.

504

Something went wrong on our end.

post /account
https://universalapi.splitti.is/v1/account

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "WYTAdDJ75vk",
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z",
  • "country": "IS",
  • "businessProfile":
    {
    },
  • "businessType": "individual",
  • "capabilities":
    {
    },
  • "chargesEnabled": false,
  • "company":
    {
    },
  • "defaultCurrency": "EUR",
  • "detailsSubmitted": false,
  • "email": "user@example.com",
  • "requestedCapabilities":
    [
    ],
  • "individual":
    {
    },
  • "payoutsEnabled": false,
  • "requirements":
    {
    },
  • "settings":
    {