API Endpoints

PreviousCharges

Last updated 1 year ago

Was this helpful?

post

/payments/customer-enrollment

Authorizations

Body

firstNamestringrequired

Example: Peter

lastNamestringrequired

Example: Jones

phoneall ofrequired

addressall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/payments/customer-enrollment' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

201

400

401

422

{
  "statusCode": 201
}

Successful operation.

get

/payments/customers

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/payments/customers' \
  --header 'Authorization: Bearer JWT'

200

401

422

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

Successful operation.

get

/payments/charges

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/payments/charges' \
  --header 'Authorization: Bearer JWT'

200

401

422

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

Successful operation

post

/payments/charges

Authorizations

Body

amountstringrequired

Example: 10

fromAccountIdstring

Example: ba_1MCkDNJbiW7FRdJYJDT684sV

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/payments/charges' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": "10",
    "fromAccountId": "ba_1MCkDNJbiW7FRdJYJDT684sV"
  }'

201

400

401

402

404

422

{
  "statusCode": 201
}

Successful operation.

post

/payments/authorizations

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/payments/authorizations' \
  --header 'Authorization: Bearer JWT'

201

401

422

{
  "statusCode": 201
}

Successful operation.

delete

/payments/authorizations

Authorizations

Body

cancelReasonstringrequired

Example: Personal reasons

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/payments/authorizations' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "cancelReason": "Personal reasons"
  }'

200

400

401

422

{
  "statusCode": 200
}

Successful operation

post

/payments/stripe-wh

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/payments/stripe-wh'

400

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

The request was not made by Stripe

Show child attributes

Show child attributes