API Endpoints | Linker Studio

post

Authorizations

Body

firstNamestringRequiredExample: Peter

lastNamestringRequiredExample: Jones

phoneall ofRequired

addressall ofRequired

Responses

201

Successful operation.

application/json

ResponseanyExample: {"statusCode":201}

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

422

User has already a Stripe customer

application/json

post

POST /payments/customer-enrollment HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "firstName": "Peter",
  "lastName": "Jones",
  "phone": {
    "number": "9786431878",
    "countryCode": "1"
  },
  "address": {
    "street1": "Main 123",
    "street2": "Secondary St",
    "city": "Los Angeles",
    "state": "CA",
    "countryCode": "US",
    "postalCode": "12345"
  }
}

{
  "statusCode": 201
}

get

Authorizations

Responses

200

Successful operation.

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

422

User doesn't have Stripe integration

application/json

get

GET /payments/customers HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "statusCode": 200,
  "data": {
    "name": "Peter Jones",
    "phone": {
      "number": "9786431878",
      "countryCode": "1"
    },
    "address": {
      "street1": "Main 123",
      "street2": "Secondary St",
      "city": "Los Angeles",
      "state": "CA",
      "countryCode": "US",
      "postalCode": "12345"
    },
    "userExternalId": "c495345a-bf0c-4af3-bc66-a59d570f4459"
  }
}

get

Authorizations

Responses

200

Successful operation

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

422

User doesn't have Stripe integration

application/json

get

GET /payments/charges HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "statusCode": 200,
  "data": {
    "charges": [
      {
        "chargeId": "py_1MGu3AJbiW7FRdJYvghbU3jh",
        "amount": "10",
        "status": "succeeded"
      }
    ]
  }
}

post

Authorizations

Body

amountstringRequiredExample: 10

fromAccountIdstringOptionalExample: ba_1MCkDNJbiW7FRdJYJDT684sV

Responses

201

Successful operation.

application/json

ResponseanyExample: {"statusCode":201}

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

402

Missing card / bank

application/json

404

fromAccountId is not from this users or doesn't exist

application/json

422

Missing Stripe integration or there is no accepted authorization

application/json

post

POST /payments/charges HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "amount": "10",
  "fromAccountId": "ba_1MCkDNJbiW7FRdJYJDT684sV"
}

{
  "statusCode": 201
}

post

Authorizations

Responses

201

Successful operation.

application/json

ResponseanyExample: {"statusCode":201}

401

Failed because the authentication token was not sent or it has already expired.

application/json

422

Missing Stripe integration or authorization already accepted

application/json

post

POST /payments/authorizations HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "statusCode": 201
}

delete

Authorizations

Body

cancelReasonstringRequiredExample: Personal reasons

Responses

200

Successful operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

422

Missing Stripe integration or there is no accepted authorization

application/json

delete

DELETE /payments/authorizations HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "cancelReason": "Personal reasons"
}

{
  "statusCode": 200
}

post

Responses

400

The request was not made by Stripe

application/json

ResponseanyExample: {"statusCode":400,"message":"Bad Request"}

post

POST /payments/stripe-wh HTTP/1.1
Host: 
Accept: */*

400

The request was not made by Stripe

{
  "statusCode": 400,
  "message": "Bad Request"
}