Documentation Powered by ReDoc

Splitti Universal (1.0.0)

Download OpenAPI specification:Download

E-mail: hello@splitti.is Terms of Service

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)
Find out more about Splitti Universal

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,
  • "url": "http://example.com"
}

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":
    {
    }
}

Disputes

A dispute occurs when a customer questions your charge with their card issuer. When this happens, you're given the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.

List payment disputes

Authorizations:
splitti_auth (universal.payment.disputeuniversal.payment.dispute.read)
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of payment disputes 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 /disputes
https://universalapi.splitti.is/v1/disputes

Response samples

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

Files

Everything required to manage your files and documents.

Create a file.

To upload a file to Splitti Universal, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

Authorizations:
splitti_auth (universal.files)
Request Body schema: multipart/form-data
file
required
string <binary>
purpose
required
string (FilePurpose)
Enum: "additionalVerification" "businessIcon" "businessLogo" "customerSignature" "disputeEvidence" "financeReportRun" "identityDocument" "pciDocument" "taxDocumentUserUpload"

The purpose of the file.

Responses

200

Returns a File object if 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 /files
https://universalapi.splitti.is/v1/files

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",
  • "filename": "string",
  • "purpose": "additionalVerification",
  • "size": 0,
  • "title": "string",
  • "type": "string",
  • "url": "http://example.com"
}

List all files.

Authorizations:
splitti_auth (universal.filesuniversal.files.read)
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of files if 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 /files
https://universalapi.splitti.is/v1/files

Response samples

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

Retrieve a file.

Authorizations:
splitti_auth (universal.filesuniversal.files.read)
path Parameters
fileId
required
string

Responses

200

Returns a File 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.

404

The requested File doesn't exist.

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 /files/{fileId}
https://universalapi.splitti.is/v1/files/{fileId}

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",
  • "filename": "string",
  • "purpose": "additionalVerification",
  • "size": 0,
  • "title": "string",
  • "type": "string",
  • "url": "http://example.com"
}

PaymentIntents

Everything required to create payments.

Prepare a payment.

Authorizations:
splitti_auth (universal.payment.intent)
Request Body schema: application/json

Parameters for an PaymentIntent object.

amount
required
string <decimal> (Amount) [ 1 .. 9 ] characters
currency
required
string (Currency) 3 characters

Three-letter ISO currency code, in lowercase. Must be a supported currency.

confirm
boolean
Default: false
customer
string
description
string
paymentMethodTypes
Array of strings (PaymentMethodType)
Default: ["card"]
Items Enum: "card" "alipay" "wechat"
receiptEmail
string <email>
statementDescriptor
string <= 22 characters
statementDescriptorSuffix
string <= 22 characters
captureMethod
string (CaptureMethod)
Default: "automatic"
Enum: "automatic" "manual"
confirmationMethod
string (ConfirmationMethod)
Default: "automatic"
Enum: "automatic" "manual"

Responses

200

Payment intent created 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 /payment-intents
https://universalapi.splitti.is/v1/payment-intents

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount": "43.21",
  • "currency": "EUR",
  • "confirm": false,
  • "customer": "string",
  • "description": "string",
  • "paymentMethodTypes":
    [
    ],
  • "receiptEmail": "user@example.com",
  • "statementDescriptor": "string",
  • "statementDescriptorSuffix": "string",
  • "captureMethod": "automatic",
  • "confirmationMethod": "automatic"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "amount": "43.21",
  • "amountCapturable": "43.21",
  • "amountReceived": "43.21",
  • "currency": "EUR",
  • "charges":
    {
    },
  • "clientSecret": "string",
  • "customer": "string",
  • "description": "string",
  • "lastPaymentError":
    {
    },
  • "nextAction":
    {
    },
  • "paymentMethod": "string",
  • "paymentMethodTypes":
    [
    ],
  • "availablePaymentMethods":
    [
    ],
  • "receiptEmail": "user@example.com",
  • "statementDescriptor": "string",
  • "statementDescriptorSuffix": "string",
  • "status": "requiresPaymentMethod",
  • "canceledAt": "2020-03-25T06:20:45Z",
  • "cancelationReason": "duplicate",
  • "captureMethod": "automatic",
  • "confirmationMethod": "automatic",
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z",
  • "receiptNumber": "string",
  • "receiptUrl": "http://example.com",
  • "refunded": false,
  • "refunds":
    {
    }
}

List payment intents

Authorizations:
splitti_auth (universal.payment.intentuniversal.payment.intent.read)
query Parameters
customer
string

Only return PaymentIntents for the customer specified by this ID.

endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of payment intents 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 /payment-intents
https://universalapi.splitti.is/v1/payment-intents

Response samples

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

Update an intended payment.

Authorizations:
splitti_auth (universal.payment.intent)
path Parameters
intentId
required
string 11 characters
Example: WYTAdDJ75vk
Request Body schema: application/json

Updated parameters for an PaymentIntent object.

amount
string <decimal> (Amount) [ 1 .. 9 ] characters
currency
string (Currency) 3 characters

Three-letter ISO currency code, in lowercase. Must be a supported currency.

confirm
boolean
Default: false
customer
string
description
string
paymentMethodTypes
Array of strings (PaymentMethodType)
Default: ["card"]
Items Enum: "card" "alipay" "wechat"
receiptEmail
string <email>
statementDescriptor
string <= 22 characters
statementDescriptorSuffix
string <= 22 characters
captureMethod
string (CaptureMethod)
Default: "automatic"
Enum: "automatic" "manual"
confirmationMethod
string (ConfirmationMethod)
Default: "automatic"
Enum: "automatic" "manual"

Responses

200

Payment intent successfully updated 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.

404

The requested PaymentIntent doesn't exist.

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.

put /payment-intents/{intentId}
https://universalapi.splitti.is/v1/payment-intents/{intentId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount": "43.21",
  • "currency": "EUR",
  • "confirm": false,
  • "customer": "string",
  • "description": "string",
  • "paymentMethodTypes":
    [
    ],
  • "receiptEmail": "user@example.com",
  • "statementDescriptor": "string",
  • "statementDescriptorSuffix": "string",
  • "captureMethod": "automatic",
  • "confirmationMethod": "automatic"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "amount": "43.21",
  • "amountCapturable": "43.21",
  • "amountReceived": "43.21",
  • "currency": "EUR",
  • "charges":
    {
    },
  • "clientSecret": "string",
  • "customer": "string",
  • "description": "string",
  • "lastPaymentError":
    {
    },
  • "nextAction":
    {
    },
  • "paymentMethod": "string",
  • "paymentMethodTypes":
    [
    ],
  • "availablePaymentMethods":
    [
    ],
  • "receiptEmail": "user@example.com",
  • "statementDescriptor": "string",
  • "statementDescriptorSuffix": "string",
  • "status": "requiresPaymentMethod",
  • "canceledAt": "2020-03-25T06:20:45Z",
  • "cancelationReason": "duplicate",
  • "captureMethod": "automatic",
  • "confirmationMethod": "automatic",
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z",
  • "receiptNumber": "string",
  • "receiptUrl": "http://example.com",
  • "refunded": false,
  • "refunds":
    {
    }
}

getPaymentIntentById

Retrieve a payment intent.

Authorizations:
splitti_auth (universal.payment.intent)
path Parameters
intentId
required
string 11 characters
Example: WYTAdDJ75vk
query Parameters
clientSecret
string

Responses

200

Returns a PaymentIntent object with status=succeeded if the PaymentIntent was capturable 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.

404

The requested PaymentIntent doesn't exist.

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 /payment-intents/{intentId}
https://universalapi.splitti.is/v1/payment-intents/{intentId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "amount": "43.21",
  • "amountCapturable": "43.21",
  • "amountReceived": "43.21",
  • "currency": "EUR",
  • "charges":
    {
    },
  • "clientSecret": "string",
  • "customer": "string",
  • "description": "string",
  • "lastPaymentError":
    {
    },
  • "nextAction":
    {
    },
  • "paymentMethod": "string",
  • "paymentMethodTypes":
    [
    ],
  • "availablePaymentMethods":
    [
    ],
  • "receiptEmail": "user@example.com",
  • "statementDescriptor": "string",
  • "statementDescriptorSuffix": "string",
  • "status": "requiresPaymentMethod",
  • "canceledAt": "2020-03-25T06:20:45Z",
  • "cancelationReason": "duplicate",
  • "captureMethod": "automatic",
  • "confirmationMethod": "automatic",
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z",
  • "receiptNumber": "string",
  • "receiptUrl": "http://example.com",
  • "refunded": false,
  • "refunds":
    {
    }
}

Cancel a PaymentIntent.

Authorizations:
splitti_auth (universal.payment.intent)
path Parameters
intentId
required
string 11 characters
Example: WYTAdDJ75vk
Request Body schema: application/json
reason
string (PaymentIntentCancellationReason)
Enum: "duplicate" "fraudulent" "requestedByCustomer" "abandoned" "failedInvoice" "voidInvoice" "automatic"

Responses

200

Returns a PaymentIntent object with status=cancelled if the cancellation succeeded 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.

404

The requested PaymentIntent doesn't exist.

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 /payment-intents/{intentId}/cancel
https://universalapi.splitti.is/v1/payment-intents/{intentId}/cancel

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "reason": "duplicate"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "amount": "43.21",
  • "amountCapturable": "43.21",
  • "amountReceived": "43.21",
  • "currency": "EUR",
  • "charges":
    {
    },
  • "clientSecret": "string",
  • "customer": "string",
  • "description": "string",
  • "lastPaymentError":
    {
    },
  • "nextAction":
    {
    },
  • "paymentMethod": "string",
  • "paymentMethodTypes":
    [
    ],
  • "availablePaymentMethods":
    [
    ],
  • "receiptEmail": "user@example.com",
  • "statementDescriptor": "string",
  • "statementDescriptorSuffix": "string",
  • "status": "requiresPaymentMethod",
  • "canceledAt": "2020-03-25T06:20:45Z",
  • "cancelationReason": "duplicate",
  • "captureMethod": "automatic",
  • "confirmationMethod": "automatic",
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z",
  • "receiptNumber": "string",
  • "receiptUrl": "http://example.com",
  • "refunded": false,
  • "refunds":
    {
    }
}

capturePaymentIntentById

Capture the funds of an existing uncaptured PaymentIntent when its status is requiresCapture.

Uncaptured PaymentIntents will generally be canceled seven days after they are created.

Authorizations:
splitti_auth (universal.payment.intent)
path Parameters
intentId
required
string 11 characters
Example: WYTAdDJ75vk
Request Body schema: application/json
amountToCapture
string <decimal> (Amount) [ 1 .. 9 ] characters

Responses

200

Returns a PaymentIntent object with status=succeeded if the PaymentIntent was capturable 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.

404

The requested PaymentIntent doesn't exist.

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 /payment-intents/{intentId}/capture
https://universalapi.splitti.is/v1/payment-intents/{intentId}/capture

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amountToCapture": "43.21"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "amount": "43.21",
  • "amountCapturable": "43.21",
  • "amountReceived": "43.21",
  • "currency": "EUR",
  • "charges":
    {
    },
  • "clientSecret": "string",
  • "customer": "string",
  • "description": "string",
  • "lastPaymentError":
    {
    },
  • "nextAction":
    {
    },
  • "paymentMethod": "string",
  • "paymentMethodTypes":
    [
    ],
  • "availablePaymentMethods":
    [
    ],
  • "receiptEmail": "user@example.com",
  • "statementDescriptor": "string",
  • "statementDescriptorSuffix": "string",
  • "status": "requiresPaymentMethod",
  • "canceledAt": "2020-03-25T06:20:45Z",
  • "cancelationReason": "duplicate",
  • "captureMethod": "automatic",
  • "confirmationMethod": "automatic",
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z",
  • "receiptNumber": "string",
  • "receiptUrl": "http://example.com",
  • "refunded": false,
  • "refunds":
    {
    }
}

Confirm an intended payment and promote to Payment.

Authorizations:
splitti_auth (universal.payment.intent)
path Parameters
intentId
required
string 11 characters
Example: WYTAdDJ75vk

Responses

200

Payment was successfully confirmed 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.

404

The requested PaymentIntent doesn't exist.

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 /payment-intents/{intentId}/confirm
https://universalapi.splitti.is/v1/payment-intents/{intentId}/confirm

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "amount": "43.21",
  • "amountCapturable": "43.21",
  • "amountReceived": "43.21",
  • "currency": "EUR",
  • "charges":
    {
    },
  • "clientSecret": "string",
  • "customer": "string",
  • "description": "string",
  • "lastPaymentError":
    {
    },
  • "nextAction":
    {
    },
  • "paymentMethod": "string",
  • "paymentMethodTypes":
    [
    ],
  • "availablePaymentMethods":
    [
    ],
  • "receiptEmail": "user@example.com",
  • "statementDescriptor": "string",
  • "statementDescriptorSuffix": "string",
  • "status": "requiresPaymentMethod",
  • "canceledAt": "2020-03-25T06:20:45Z",
  • "cancelationReason": "duplicate",
  • "captureMethod": "automatic",
  • "confirmationMethod": "automatic",
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z",
  • "receiptNumber": "string",
  • "receiptUrl": "http://example.com",
  • "refunded": false,
  • "refunds":
    {
    }
}

PaymentMethods

Create a PaymentMethod

Authorizations:
splitti_auth (universal.payment.method)
Request Body schema: application/json
type
required
string (PaymentMethodType)
Enum: "card" "alipay" "wechat"
card
object (NewCardPaymentMethodParams)
alipay
object (NewAlipayPaymentMethodParams)
wechatpay
object (NewWechatPayPaymentMethodParams)

Responses

200

Returns a new payment method 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 /payment-methods/
https://universalapi.splitti.is/v1/payment-methods/

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "type": "card",
  • "card":
    {
    },
  • "alipay":
    {
    },
  • "wechatpay":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "WYTAdDJ75vk",
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "type": "card",
  • "card":
    {
    },
  • "alipay":
    {
    },
  • "wechatpay":
    {
    },
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z"
}

List payment methods

Authorizations:
splitti_auth (universal.payment.methoduniversal.payment.method.read)
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string (ID) 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of payment methods 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 /payment-methods/
https://universalapi.splitti.is/v1/payment-methods/

Response samples

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

Retrieve a payment method

Authorizations:
splitti_auth (universal.payment.methoduniversal.payment.method.read)
path Parameters
paymentMethodId
required
string

Responses

200

Returns thepayment method 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.

404

The requested PaymentMethod doesn't exist.

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 /payment-methods/{paymentMethodId}
https://universalapi.splitti.is/v1/payment-methods/{paymentMethodId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "WYTAdDJ75vk",
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "type": "card",
  • "card":
    {
    },
  • "alipay":
    {
    },
  • "wechatpay":
    {
    },
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z"
}

Update a payment method

Authorizations:
splitti_auth (universal.payment.methoduniversal.payment.method.read)
path Parameters
paymentMethodId
required
string
Request Body schema: application/json
card
object (CardPaymentMethodParams)
alipay
object (AlipayPaymentMethodParams)
wechatpay
object (WechatPayPaymentMethodParams)

Responses

200

Returns the updated payment method 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.

404

The requested PaymentMethod doesn't exist.

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 /payment-methods/{paymentMethodId}
https://universalapi.splitti.is/v1/payment-methods/{paymentMethodId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "card":
    {
    },
  • "alipay":
    {
    },
  • "wechatpay":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "WYTAdDJ75vk",
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "type": "card",
  • "card":
    {
    },
  • "alipay":
    {
    },
  • "wechatpay":
    {
    },
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z"
}

Payments

Everything about your payments.

Platform

Everything required to manage your platform .

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,
  • "url": "http://example.com"
}

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":
    [
    ]
}

List accounts connected to your platform.

Authorizations:
splitti_auth (universal.platform.accountsuniversal.platform.accounts.read)
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of Accounts 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 /platform/accounts
https://universalapi.splitti.is/v1/platform/accounts

Response samples

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

Create or add an account connected to your platform.

Authorizations:
splitti_auth (universal.platform.accounts)

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 /platform/accounts
https://universalapi.splitti.is/v1/platform/accounts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "country": "IS",
  • "businessProfile":
    {
    },
  • "businessType": "individual",
  • "company":
    {
    },
  • "defaultCurrency": "EUR",
  • "email": "user@example.com",
  • "requestedCapabilities":
    [
    ],
  • "individual":
    {
    },
  • "requirements":
    {
    },
  • "settings":
    {
    }
}

Retreive an account connected to your platform.

Authorizations:
splitti_auth (universal.platform.accountsuniversal.platform.accounts.read)
path Parameters
accountId
required
string

Responses

200

Returns an Accounts 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.

404

The requested Account doesn't exist.

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 /platform/accounts/{accountId}
https://universalapi.splitti.is/v1/platform/accounts/{accountId}

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 an account connected to your platform.

Authorizations:
splitti_auth (universal.platform.accounts)
path Parameters
accountId
required
string

Responses

200

Returns an Accounts 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 /platform/accounts/{accountId}
https://universalapi.splitti.is/v1/platform/accounts/{accountId}

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":
    {
    }
}

Retrieve the bank accounts of an Account.

Authorizations:
splitti_auth (universal.terminal.reader)
path Parameters
accountId
required
string
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of Accounts bank accounts if successfully created 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 /platform/accounts/{accountId}/external-accounts
https://universalapi.splitti.is/v1/platform/accounts/{accountId}/external-accounts

Response samples

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

Retrieve the persons associated with an Account.

path Parameters
accountId
required
string
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of persons associated with an account. 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.

404

The requested PaymentIntent doesn't exist.

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 /platform/accounts/{accountId}/persons
https://universalapi.splitti.is/v1/platform/accounts/{accountId}/persons

Response samples

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

Retrieve the persons associated with an Account.

path Parameters
accountId
required
string
personId
required
string

Responses

200

Returns a list of persons associated with an account. 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.

404

The requested PaymentIntent doesn't exist.

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 /platform/accounts/{accountId}/persons/{personId}
https://universalapi.splitti.is/v1/platform/accounts/{accountId}/persons/{personId}

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",
  • "account": "string",
  • "address":
    {
    },
  • "dateOfBirth": "2020-03-25",
  • "email": "user@example.com",
  • "firstName": "string",
  • "maidenName": "string",
  • "lastName": "string",
  • "gender": "male",
  • "idNumberProvided": false,
  • "idNumber": "string",
  • "requirements":
    {
    },
  • "relationship":
    {
    },
  • "verification":
    {
    }
}

Terminal

Everything required to Manage your fleet of in-person payment terminals.

Create a terminal reader.

Creates a new TerminalReader object.

Authorizations:
splitti_auth (universal.terminal.reader)
Request Body schema: application/json

Parameters for a new TerminalReader object.

name
string

A name for the terminal reader.

location
string

The location to assign the reader to. If no location is specified, the reader will be assigned to the account’s default location.

publicKey
required
string

A public key used to verify digital signatures and identify the TerminalReader.

Responses

200

Returns a TerminalReader if successfully created 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 /terminal/readers
https://universalapi.splitti.is/v1/terminal/readers

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "location": "string",
  • "publicKey": "string"
}

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",
  • "name": "string",
  • "status": "offline",
  • "publicKey": "string",
  • "location": "string"
}

List terminal readers.

Authorizations:
splitti_auth (universal.terminal.readeruniversal.terminal.reader.read)
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Terminal Readers successfully returned 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 /terminal/readers
https://universalapi.splitti.is/v1/terminal/readers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Retrieve a terminal reader.

Authorizations:
splitti_auth (universal.terminal.readeruniversal.terminal.reader.read)
path Parameters
readerId
required
string

Responses

200

Terminal Reader successfully returned 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.

404

The requested Terminal Reader doesn't exist.

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 /terminal/readers/{readerId}
https://universalapi.splitti.is/v1/terminal/readers/{readerId}

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",
  • "name": "string",
  • "status": "offline",
  • "publicKey": "string",
  • "location": "string"
}

Update terminal reader

Authorizations:
splitti_auth (universal.terminal.reader)
path Parameters
readerId
required
string
Request Body schema: application/json

Updates a TerminalReader by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

name
string

A name for the terminal reader.

location
string

The location to assign the reader to. If no location is specified, the reader will be assigned to the account’s default location.

publicKey
string

A public key used to verify digital signatures and identify the TerminalReader.

Responses

200

Returns an updated TerminalReader 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.

404

The requested Terminal Reader doesn't exist.

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 /terminal/readers/{readerId}
https://universalapi.splitti.is/v1/terminal/readers/{readerId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "location": "string",
  • "publicKey": "string"
}

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",
  • "name": "string",
  • "status": "offline",
  • "publicKey": "string",
  • "location": "string"
}

Delete a terminal reader.

Authorizations:
splitti_auth (universal.terminal.reader)
path Parameters
readerId
required
string

Responses

200

Terminal Reader successfully deleted 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.

404

The requested TerminalReader doesn't exist.

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.

delete /terminal/readers/{readerId}
https://universalapi.splitti.is/v1/terminal/readers/{readerId}

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",
  • "name": "string",
  • "status": "offline",
  • "publicKey": "string",
  • "location": "string"
}

Create a terminal location

Creates a new TerminalLocation object.

Authorizations:
splitti_auth (universal.terminal.location)
Request Body schema: application/json

Parameters for a new TerminalLocation object.

name
string
address
object (Address)

Responses

200

Returns a TerminalLocation if successfully created 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 /terminal/locations
https://universalapi.splitti.is/v1/terminal/locations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "address":
    {
    }
}

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",
  • "name": "string",
  • "address":
    {
    }
}

List terminal locations

Returns a list of TerminalLocation objects.

Authorizations:
splitti_auth (universal.terminal.locationuniversal.terminal.location.read)
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk
startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of TerminalLocation if 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 /terminal/locations
https://universalapi.splitti.is/v1/terminal/locations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Retrieve a Terminal Location

Authorizations:
splitti_auth (universal.terminal.locationuniversal.terminal.location.read)
path Parameters
locationId
required
string

Responses

200

Terminal Location successfully returned 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.

404

The requested TerminalLocation doesn't exist.

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 /terminal/locations/{locationId}
https://universalapi.splitti.is/v1/terminal/locations/{locationId}

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",
  • "name": "string",
  • "address":
    {
    }
}

Update a Terminal Location

Updates a TerminalLocation by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Authorizations:
splitti_auth (universal.terminal.location)
path Parameters
locationId
required
string
Request Body schema: application/json

Parameters to update for the TerminalLocation. Any parameters not provided will be left unchanged.

name
string
address
object (Address)

Responses

200

Returns an updated terminal location successfully returned 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.

404

The requested TerminalLocation doesn't exist.

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 /terminal/locations/{locationId}
https://universalapi.splitti.is/v1/terminal/locations/{locationId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "address":
    {
    }
}

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",
  • "name": "string",
  • "address":
    {
    }
}

Delete a Terminal Location

Authorizations:
splitti_auth (universal.terminal.location)
path Parameters
locationId
required
string

Responses

200

Returns the deleted terminal location 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.

404

The requested TerminalLocation doesn't exist.

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.

delete /terminal/locations/{locationId}
https://universalapi.splitti.is/v1/terminal/locations/{locationId}

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",
  • "name": "string",
  • "address":
    {
    }
}

Webhooks

Everything required to subscribe to events from Splitti Universal.

Create a webhook endpoint

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created

Authorizations:
splitti_auth (universal.webhooks)
Request Body schema: application/json
url
required
string <uri>
enabledEvents
required
Array of strings (EventCode)
Items Enum: "universal.account.updated" "universal.account.application.authorized" "universal.account.application.deauthorized" "universal.account.external_account.created" "universal.account.external_account.deleted" "universal.account.external_account.updated" "universal.application_fee.created" "universal.application_fee.refunded" "universal.application_fee.refund.updated" "universal.balance.available" "universal.capability.updated" "universal.charge.captured" "universal.charge.expired" "universal.charge.failed" "universal.charge.pending" "universal.charge.refunded" "universal.charge.succeeded" "universal.charge.updated" "universal.charge.dispute.closed" "universal.charge.dispute.created" "universal.charge.dispute.funds_reinstated" "universal.charge.dispute.funds_withdrawn" "universal.charge.dispute.updated" "universal.charge.refund.updated" "universal.checkout.session.completed" "universal.customer.created" "universal.customer.deleted" "universal.customer.updated" "universal.customer.source.created" "universal.customer.source.deleted" "universal.customer.source.expiring" "universal.customer.source.updated" "universal.customer.tax_id.created" "universal.customer.tax_id.deleted" "universal.customer.tax_id.updated" "universal.file.created" "universal.payment_intent.amount_capturable_updated" "universal.payment_intent.canceled" "universal.payment_intent.created" "universal.payment_intent.payment_failed" "universal.payment_intent.succeeded" "universal.payment_method.attached" "universal.payment_method.card_automatically_updated" "universal.payment_method.detached" "universal.payment_method.updated" "universal.payout.canceled" "universal.payout.created" "universal.payout.failed" "universal.payout.paid" "universal.payout.updated" "universal.person.created" "universal.person.deleted" "universal.person.updated" "universal.setup_intent.canceled" "universal.setup_intent.created" "universal.setup_intent.setup_failed" "universal.setup_intent.succeeded" "all"

Responses

200

Returns a Webhook if successfully created 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 /webhooks
https://universalapi.splitti.is/v1/webhooks

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

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",
  • "enabledEvents":
    [
    ],
  • "status": "enabled",
  • "url": "http://example.com"
}

List all webhooks

Authorizations:
splitti_auth (universal.webhooksuniversal.webhooks.read)
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of Webhooks associated with the account.

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 /webhooks
https://universalapi.splitti.is/v1/webhooks

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Update a webhook

Authorizations:
splitti_auth (universal.webhooks)
path Parameters
webhookId
required
string
Request Body schema: application/json
url
string <uri>
enabledEvents
Array of strings (EventCode)
Items Enum: "universal.account.updated" "universal.account.application.authorized" "universal.account.application.deauthorized" "universal.account.external_account.created" "universal.account.external_account.deleted" "universal.account.external_account.updated" "universal.application_fee.created" "universal.application_fee.refunded" "universal.application_fee.refund.updated" "universal.balance.available" "universal.capability.updated" "universal.charge.captured" "universal.charge.expired" "universal.charge.failed" "universal.charge.pending" "universal.charge.refunded" "universal.charge.succeeded" "universal.charge.updated" "universal.charge.dispute.closed" "universal.charge.dispute.created" "universal.charge.dispute.funds_reinstated" "universal.charge.dispute.funds_withdrawn" "universal.charge.dispute.updated" "universal.charge.refund.updated" "universal.checkout.session.completed" "universal.customer.created" "universal.customer.deleted" "universal.customer.updated" "universal.customer.source.created" "universal.customer.source.deleted" "universal.customer.source.expiring" "universal.customer.source.updated" "universal.customer.tax_id.created" "universal.customer.tax_id.deleted" "universal.customer.tax_id.updated" "universal.file.created" "universal.payment_intent.amount_capturable_updated" "universal.payment_intent.canceled" "universal.payment_intent.created" "universal.payment_intent.payment_failed" "universal.payment_intent.succeeded" "universal.payment_method.attached" "universal.payment_method.card_automatically_updated" "universal.payment_method.detached" "universal.payment_method.updated" "universal.payout.canceled" "universal.payout.created" "universal.payout.failed" "universal.payout.paid" "universal.payout.updated" "universal.person.created" "universal.person.deleted" "universal.person.updated" "universal.setup_intent.canceled" "universal.setup_intent.created" "universal.setup_intent.setup_failed" "universal.setup_intent.succeeded" "all"

Responses

200

Returns a Webhook if successfully created 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 /webhooks/{webhookId}
https://universalapi.splitti.is/v1/webhooks/{webhookId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

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",
  • "enabledEvents":
    [
    ],
  • "status": "enabled",
  • "url": "http://example.com"
}

Retreive a webhook

Authorizations:
splitti_auth (universal.webhooksuniversal.webhooks.read)
path Parameters
webhookId
required
string

Responses

200

Returns a Webhook if exists.

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 /webhooks/{webhookId}
https://universalapi.splitti.is/v1/webhooks/{webhookId}

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",
  • "enabledEvents":
    [
    ],
  • "status": "enabled",
  • "url": "http://example.com"
}

Delete a webhook

Authorizations:
splitti_auth (universal.webhooks)
path Parameters
webhookId
required
string

Responses

200

Returns the deleted Webhook if successful.

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.

delete /webhooks/{webhookId}
https://universalapi.splitti.is/v1/webhooks/{webhookId}

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",
  • "enabledEvents":
    [
    ],
  • "status": "enabled",
  • "url": "http://example.com"
}

Charges

Retrieve a list of charges.

Authorizations:
splitti_auth (universal.payment.chargesuniversal.payment.charges.read)
query Parameters
paymentIntent
string

Payment Intent ID

endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of charges 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 /charges
https://universalapi.splitti.is/v1/charges

Response samples

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

Retrieve a charge.

Authorizations:
splitti_auth (universal.payment.chargesuniversal.payment.charges.read)
path Parameters
chargeId
required
string

Responses

200

Returns a list of charges 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 /charges/{chargeId}
https://universalapi.splitti.is/v1/charges/{chargeId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "amount": "43.21",
  • "currency": "EUR",
  • "customer": "string",
  • "invoice": "string",
  • "description": "string",
  • "amountRefunded": "43.21",
  • "application": "string",
  • "applicationFee": "string",
  • "applicationFeeAmount": "43.21",
  • "captured": false,
  • "paymentIntent": "string",
  • "disputed": false,
  • "refunds":
    {
    },
  • "created": "2020-03-25T06:20:45Z",
  • "updated": "2020-03-25T06:20:45Z",
  • "outcome":
    {
    }
}

Refunds

List refunds

Authorizations:
splitti_auth (universal.payment.refundsuniversal.payment.refunds.read)
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of refunds 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 /refunds
https://universalapi.splitti.is/v1/refunds

Response samples

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

Retrieve a refund

Authorizations:
splitti_auth (universal.payment.refundsuniversal.payment.refunds.read)
path Parameters
refundId
required
string

Responses

200

Returns a refund object 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.

404

The requested Refund doesn't exist.

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 /refunds/{refundId}
https://universalapi.splitti.is/v1/refunds/{refundId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "created": "2020-03-25T06:20:46Z",
  • "updated": "2020-03-25T06:20:46Z"
}

Update a refund

Authorizations:
splitti_auth (universal.payment.refundsuniversal.payment.refunds.read)
path Parameters
refundId
required
string

Responses

200

Returns the updated refund object 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.

404

The requested Refund doesn't exist.

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 /refunds/{refundId}
https://universalapi.splitti.is/v1/refunds/{refundId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "created": "2020-03-25T06:20:46Z",
  • "updated": "2020-03-25T06:20:46Z"
}

Payouts

Create a payout.

To send funds to your own bank account, you create a new payout object.

Authorizations:
splitti_auth (universal.payouts)
Request Body schema: application/json

Parameters for an Payout object.

test
string

Responses

200

Returns a payout object if there were no initial errors with the payout creation (invalid routing number, insufficient funds, etc). The status of the payout object will be initially marked as pending.

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 /payouts
https://universalapi.splitti.is/v1/payouts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "test": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "created": "2020-03-25T06:20:46Z",
  • "updated": "2020-03-25T06:20:46Z"
}

Get a list of payouts.

Authorizations:
splitti_auth (universal.payoutsuniversal.payouts.read)
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of payouts 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 /payouts
https://universalapi.splitti.is/v1/payouts

Response samples

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

Update a payout.

Authorizations:
splitti_auth (universal.payouts)
path Parameters
payoutId
required
string
Request Body schema: application/json

Parameters for an PaymentIntent object.

test
string

Responses

200

Returns the updated payout 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 /payouts/{payoutId}
https://universalapi.splitti.is/v1/payouts/{payoutId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "test": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "created": "2020-03-25T06:20:46Z",
  • "updated": "2020-03-25T06:20:46Z"
}

Retrieve a payout.

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Splitti will return the corresponding payout information.

Authorizations:
splitti_auth (universal.payoutsuniversal.payouts.read)
path Parameters
payoutId
required
string

Responses

200

Returns a payout object if a valid identifier was provided, and returns an error otherwise.

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 /payouts/{payoutId}
https://universalapi.splitti.is/v1/payouts/{payoutId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "srn": "srn::123456789:universal:payment-intent:aasdfasdf",
  • "id": "WYTAdDJ75vk",
  • "created": "2020-03-25T06:20:46Z",
  • "updated": "2020-03-25T06:20:46Z"
}

ExternalAccounts

Retrieve the bank accounts of an Account.

Authorizations:
splitti_auth (universal.terminal.reader)
path Parameters
accountId
required
string
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of Accounts bank accounts if successfully created 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 /platform/accounts/{accountId}/external-accounts
https://universalapi.splitti.is/v1/platform/accounts/{accountId}/external-accounts

Response samples

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

Person

Retrieve the persons associated with an Account.

path Parameters
accountId
required
string
query Parameters
endingBefore
string 11 characters
Example: endingBefore=WYTAdDJ75vk

A cursor for use in pagination. endingBefore is an object ID.

startingBefore
string 11 characters
Example: startingBefore=WYTAdDJ75vk

A cursor for use in pagination. startingBefore is an object ID.

limit
integer [ 1 .. 100 ]
Default: 10

Responses

200

Returns a list of persons associated with an account. 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.

404

The requested PaymentIntent doesn't exist.

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 /platform/accounts/{accountId}/persons
https://universalapi.splitti.is/v1/platform/accounts/{accountId}/persons

Response samples

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

Retrieve the persons associated with an Account.

path Parameters
accountId
required
string
personId
required
string

Responses

200

Returns a list of persons associated with an account. 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.

404

The requested PaymentIntent doesn't exist.

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 /platform/accounts/{accountId}/persons/{personId}
https://universalapi.splitti.is/v1/platform/accounts/{accountId}/persons/{personId}

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:46Z",
  • "updated": "2020-03-25T06:20:46Z",
  • "account": "string",
  • "address":
    {
    },
  • "dateOfBirth": "2020-03-25",
  • "email": "user@example.com",
  • "firstName": "string",
  • "maidenName": "string",
  • "lastName": "string",
  • "gender": "male",
  • "idNumberProvided": false,
  • "idNumber": "string",
  • "requirements":
    {
    },
  • "relationship":
    {
    },
  • "verification":
    {
    }
}