Create a credits transaction

curl --request POST \
  --url https://api.spacebring.com/transactions/credits/v1 \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transaction": {
    "amount": 123,
    "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "chargeExpiringCredits",
    "companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>"
  }
}
'

{
  "transaction": {
    "amount": 123,
    "company": {
      "billingAddress": "<string>",
      "businessAddress": {
        "city": "<string>",
        "countryCode": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "postalCode": "<string>",
        "state": "<string>"
      },
      "createDate": "2023-11-07T05:31:56Z",
      "credits": {
        "expiring": 123,
        "permanent": 123
      },
      "dayPasses": {
        "expiring": 123
      },
      "deleteDate": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "legalName": "<string>",
      "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {},
      "notes": "<string>",
      "subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "taxId": "<string>",
      "title": "<string>"
    },
    "companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "membershipRefCreator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "canceled",
    "type": "chargeExpiringCredits",
    "userCreator": {
      "about": "<string>",
      "email": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "phoneNumber": "<string>",
      "photoUrl": "<string>",
      "surname": "<string>"
    },
    "userOwner": {
      "about": "<string>",
      "email": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "phoneNumber": "<string>",
      "photoUrl": "<string>",
      "surname": "<string>"
    },
    "userRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userRefCreator": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

POST

transactions

credits

Create a credits transaction

curl --request POST \
  --url https://api.spacebring.com/transactions/credits/v1 \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transaction": {
    "amount": 123,
    "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "chargeExpiringCredits",
    "companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>"
  }
}
'

{
  "transaction": {
    "amount": 123,
    "company": {
      "billingAddress": "<string>",
      "businessAddress": {
        "city": "<string>",
        "countryCode": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "postalCode": "<string>",
        "state": "<string>"
      },
      "createDate": "2023-11-07T05:31:56Z",
      "credits": {
        "expiring": 123,
        "permanent": 123
      },
      "dayPasses": {
        "expiring": 123
      },
      "deleteDate": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "legalName": "<string>",
      "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {},
      "notes": "<string>",
      "subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "taxId": "<string>",
      "title": "<string>"
    },
    "companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "membershipRefCreator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "canceled",
    "type": "chargeExpiringCredits",
    "userCreator": {
      "about": "<string>",
      "email": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "phoneNumber": "<string>",
      "photoUrl": "<string>",
      "surname": "<string>"
    },
    "userOwner": {
      "about": "<string>",
      "email": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "phoneNumber": "<string>",
      "photoUrl": "<string>",
      "surname": "<string>"
    },
    "userRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userRefCreator": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization

string

header

required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id

string<uuid>

The id of the network. Required when using bearer token authentication

Body

application/json

transaction

object

Option 1
Option 2

Show child attributes

transaction.amount

number

required

transaction.locationRef

string<uuid>

required

The location id where to create a company.

transaction.membershipRef

string<uuid>

required

The membership id to charge or transfer credits from.

transaction.type

enum<string>

required

Available options:

chargeExpiringCredits,

chargePermanentCredits,

transferExpiringCredits,

transferPermanentCredits

transaction.companyRef

string<uuid>

The company id to charge or transfer credits to.

transaction.description

string

The description of the transaction.

Response

Created

transaction

object

Show child attributes

transaction.amount

number

transaction.company

object

Show child attributes

transaction.company.billingAddress

string

transaction.company.businessAddress

object

Show child attributes

transaction.company.businessAddress.city

string

transaction.company.businessAddress.countryCode

string

transaction.company.businessAddress.line1

string

transaction.company.businessAddress.line2

string

transaction.company.businessAddress.postalCode

string

transaction.company.businessAddress.state

string

transaction.company.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.company.credits

object

Show child attributes

transaction.company.credits.expiring

number

transaction.company.credits.permanent

number

transaction.company.dayPasses

object

Show child attributes

transaction.company.dayPasses.expiring

number

transaction.company.deleteDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.company.id

string

transaction.company.legalName

string

transaction.company.locationRef

string<uuid>

transaction.company.metadata

object

Use to attach key-value data to the object. Available only for admins.

transaction.company.notes

string

transaction.company.subscriptionRef

string<uuid>

transaction.company.taxId

string

transaction.company.title

string

transaction.companyRef

string<uuid>

transaction.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.description

string

transaction.id

string<uuid>

transaction.locationRef

string<uuid>

transaction.membershipRef

string<uuid>

transaction.membershipRefCreator

string<uuid>

transaction.status

enum<string>

Available options:

canceled,

failed,

succeeded

transaction.type

enum<string>

Available options:

chargeExpiringCredits,

chargePermanentCredits,

transferExpiringCredits,

transferPermanentCredits

transaction.userCreator

object

Show child attributes

transaction.userCreator.about

string

transaction.userCreator.email

string

transaction.userCreator.id

string<uuid>

transaction.userCreator.name

string

transaction.userCreator.phoneNumber

string

transaction.userCreator.photoUrl

string

transaction.userCreator.surname

string

transaction.userOwner

object

Show child attributes

transaction.userOwner.about

string

transaction.userOwner.email

string

transaction.userOwner.id

string<uuid>

transaction.userOwner.name

string

transaction.userOwner.phoneNumber

string

transaction.userOwner.photoUrl

string

transaction.userOwner.surname

string

transaction.userRef

string<uuid>

transaction.userRefCreator

string<uuid>

Retrieve credits transactions Retrieve day passes transactions

⌘I

Getting started

Endpoints

Create a credits transaction

OAuth

Authorizations

Headers

Body

Response