Ebanux-Back
API docs by Redocly

Ebanux-Back - API (2.0.0)

Download OpenAPI specification:Download

E-mail: support@ebanux.com URL: https://ebanux.slack.com/messages/support License: Apache 2.0 Terms of Service

Introduction

Ebanux allows you to sell products, services, subscriptions or one-time payments. With payment links, customers simply click or scan a QR code to access a quick payment.

The Ebanux-Back APIv2 is a simple connector API for doing business and data integrations.

This API is for individual retailers, SaaS services, or any business that needs to handle multiple integrations.

  • It is built over REST services on HTTPS.

  • It has predictable resource URLs.

  • It returns HTTP response codes to indicate errors.

  • It accepts and returns JSON in the HTTP body.

  • You can use your favorite HTTP/REST library for your programming language to use Ebanux-Back APIv2.

Products

TODO: ...

List all products

Returns the list of your products.

Authorizations:
AWS-Cognito
query Parameters
limit
integer
Example: limit=10

The maximum number of items that can be returned. The supported values are between 5 and 25.

page
integer
Example: page=1

Number of the page to skip at the beginning of the list.

content
string

It allows to filter products that contain this value in their name or description.

name
string

It allows to filter items by name attribute.

email
string

It allows to filter items by email attribute.

deleted
boolean

It allows to filter items by deleted attribute.

created_before
string <date-time-iso8601>

It allows to filter items where the created field is before a certain date.

created_after
string <date-time-iso8601>

It allows to filter items where the created field is after a certain date.

updated_before
string <date-time-iso8601>

It allows to filter items where the updated field is before a certain date.

updated_after
string <date-time-iso8601>

It allows to filter items where the updated field is after a certain date.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Create a product

Add a new item.

Authorizations:
AWS-Cognito
Request Body schema: application/json

The product that will be create

name
required
string
active
boolean
description
string
images
Array of strings
object (Package-Dimensions)

...

shippable
boolean
statement_descriptor
string
tax_code
string
unit_label
string
url
string
object (Price-Data)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": true,
  • "description": "string",
  • "images": [
    ],
  • "package_dimensions": {
    },
  • "shippable": true,
  • "statement_descriptor": "string",
  • "tax_code": "string",
  • "unit_label": "string",
  • "url": "string",
  • "default_price_data": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Retrieve a product

Find and return the product with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Update a product

Find and update the product with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Request Body schema: application/json

The product that will be update

name
string
active
boolean
description
string
images
Array of strings
object (Package-Dimensions)

...

shippable
boolean
statement_descriptor
string
tax_code
string
unit_label
string
url
string
default_price
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": true,
  • "description": "string",
  • "images": [
    ],
  • "package_dimensions": {
    },
  • "shippable": true,
  • "statement_descriptor": "string",
  • "tax_code": "string",
  • "unit_label": "string",
  • "url": "string",
  • "default_price": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Remove a product

Find and remove the product with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Coupons

TODO: ...

List all coupons

Returns the list of your coupons.

Authorizations:
AWS-Cognito
query Parameters
limit
integer
Example: limit=10

The maximum number of items that can be returned. The supported values are between 5 and 25.

page
integer
Example: page=1

Number of the page to skip at the beginning of the list.

content
string

It allows to filter coupons that contain this value in their name.

name
string

It allows to filter items by name attribute.

currency
string

It allows to filter items by currency attribute.

duration
string
Enum: "once" "repeating" "forever"

It allows to filter items by duration attribute.

valid
boolean

It allows to filter items by valid attribute.

deleted
boolean

It allows to filter items by deleted attribute.

created_before
string <date-time-iso8601>

It allows to filter items where the created field is before a certain date.

created_after
string <date-time-iso8601>

It allows to filter items where the created field is after a certain date.

updated_before
string <date-time-iso8601>

It allows to filter items where the updated field is before a certain date.

updated_after
string <date-time-iso8601>

It allows to filter items where the updated field is after a certain date.

redeemed_before
string <date-time-iso8601>

It allows to filter items where the redeemed field is before a certain date.

redeemed_after
string <date-time-iso8601>

It allows to filter items where the redeemed field is after a certain date.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Create a coupon

Add a new item.

Authorizations:
AWS-Cognito
Request Body schema: application/json

The coupon that will be create

name
string
Array of objects (Currency-Option)
id
string

Item identifier

currency
required
string (currency) = 3 characters

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

required
integer or string
applies_to
Array of strings
duration
string
Default: "once"
Enum: "forever" "once" "repeating"
duration_in_months
number >= 0
max_redemptions
integer >= 1
redeem_by
integer (Timestamps)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currency_options": [
    ],
  • "id": "string",
  • "currency": "str",
  • "discount": 1,
  • "applies_to": [
    ],
  • "duration": "forever",
  • "duration_in_months": 0,
  • "max_redemptions": 1,
  • "redeem_by": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Retrieve a coupon

Find and return the coupon with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Update a coupon

Find and update the coupon with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Request Body schema: application/json

The coupon that will be update

name
string
Array of objects (Currency-Option)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currency_options": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Remove a coupon

Find and remove the coupon with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Promotion-Codes

TODO: ...

List all promotion-codes

Returns the list of your promotion-codes.

Authorizations:
AWS-Cognito
query Parameters
limit
integer
Example: limit=10

The maximum number of items that can be returned. The supported values are between 5 and 25.

page
integer
Example: page=1

Number of the page to skip at the beginning of the list.

content
string

It allows to filter promotion-codes that contain this value in their code or coupon.id.

code
string

It allows to filter items by code attribute.

coupon
string

It allows to filter items by coupon.id attribute.

customer
string

It allows to filter items by customer attribute.

active
boolean

It allows to filter items by active attribute.

created_before
string <date-time-iso8601>

It allows to filter items where the created field is before a certain date.

created_after
string <date-time-iso8601>

It allows to filter items where the created field is after a certain date.

updated_before
string <date-time-iso8601>

It allows to filter items where the updated field is before a certain date.

updated_after
string <date-time-iso8601>

It allows to filter items where the updated field is after a certain date.

expired_before
string <date-time-iso8601>

It allows to filter items where the expires_at field is before a certain date.

expired_after
string <date-time-iso8601>

It allows to filter items where the expires_at field is after a certain date.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Create a promotion-code

Add a new item.

Authorizations:
AWS-Cognito
Request Body schema: application/json

The promotion-code that will be create

active
boolean
Default: true
object (Restriction)
coupon
required
string
code
string
customer
string
expires_at
integer (Timestamps)

...

max_redemptions
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "restrictions": {
    },
  • "coupon": "string",
  • "code": "string",
  • "customer": "string",
  • "expires_at": 0,
  • "max_redemptions": 1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Retrieve a promotion-code

Find and return the promotion-code with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Update a promotion-code

Find and update the promotion-code with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Request Body schema: application/json

The promotion-code that will be update

active
boolean
Default: true
object (Restriction)

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "restrictions": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Prices

TODO: ...

List all prices

Returns the list of your prices.

Authorizations:
AWS-Cognito
query Parameters
limit
integer
Example: limit=10

The maximum number of items that can be returned. The supported values are between 5 and 25.

page
integer
Example: page=1

Number of the page to skip at the beginning of the list.

content
string

It allows to filter prices that contain this value in their name, nickname or lookup_key.

name
string

It allows to filter items by name attribute.

nickname
string

It allows to filter items by nickname.

product
string

It allows to filter items by product id.

currency
string

It allows to filter items by currency attribute.

type
string
Enum: "one_time" "recurring"

It allows to filter items by type.

billing_scheme
string
Enum: "per_unit" "tiered"

It allows to filter items by billing_scheme.

tax_behavior
string
Enum: "inclusive" "exclusive" "unspecified"

It allows to filter items by tax_behavior.

tiers_mode
string
Enum: "volume" "graduated"

It allows to filter items by tiers_mode, but only when the billing_scheme=tiered filter is also set.

active
boolean

It allows to filter items by active attribute.

created_before
string <date-time-iso8601>

It allows to filter items where the created field is before a certain date.

created_after
string <date-time-iso8601>

It allows to filter items where the created field is after a certain date.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Create a price

Add a new item.

Authorizations:
AWS-Cognito
Request Body schema: application/json

The price that will be create

nickname
string
active
boolean
object (price_currency_options_request)
lookup_key
string <= 200 characters
transfer_lookup_key
boolean
tax_behavior
string
Default: "unspecified"
Enum: "inclusive" "exclusive" "unspecified"
currency
required
string (currency) = 3 characters

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

required
string or Product-Data (object)
billing_scheme
string
Default: "per_unit"
Enum: "per_unit" "tiered"
integer or string

A positive value in cents (or 0 for a free price) representing how much to charge.

object (recurring)
tiers_mode
string
Enum: "volume" "graduated"
Array of Tier with flat-amount (object) or Tier with unit-amount (object) (Tier)
object (transform_quantity)
object (Custom-Unit-Amount)

Responses

Request samples

Content type
application/json
{
  • "nickname": "string",
  • "active": true,
  • "currency_options": {
    },
  • "lookup_key": "string",
  • "transfer_lookup_key": true,
  • "tax_behavior": "inclusive",
  • "currency": "str",
  • "product": "string",
  • "billing_scheme": "per_unit",
  • "unit_amount": 0,
  • "recurring": {
    },
  • "tiers_mode": "volume",
  • "tiers": [
    ],
  • "transform_quantity": {
    },
  • "custom_unit_amount": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Retrieve a price

Find and return the price with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Update a price

Find and update the price with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Request Body schema: application/json

The price that will be update

nickname
string
active
boolean
object (price_currency_options_request)
lookup_key
string <= 200 characters
transfer_lookup_key
boolean
tax_behavior
string
Default: "unspecified"
Enum: "inclusive" "exclusive" "unspecified"

Responses

Request samples

Content type
application/json
{
  • "nickname": "string",
  • "active": true,
  • "currency_options": {
    },
  • "lookup_key": "string",
  • "transfer_lookup_key": true,
  • "tax_behavior": "inclusive"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Customers

TODO: ...

List all customers

Returns the list of your customers.

Authorizations:
AWS-Cognito
query Parameters
limit
integer
Example: limit=10

The maximum number of items that can be returned. The supported values are between 5 and 25.

page
integer
Example: page=1

Number of the page to skip at the beginning of the list.

content
string

It allows to filter products that contain this value in their name, email or description.

name
string

It allows to filter items by name attribute.

email
string

It allows to filter items by email attribute.

deleted
boolean

It allows to filter items by deleted attribute.

created_before
string <date-time-iso8601>

It allows to filter items where the created field is before a certain date.

created_after
string <date-time-iso8601>

It allows to filter items where the created field is after a certain date.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Create a customer

Add a new item.

Authorizations:
AWS-Cognito
Request Body schema: application/json

The customer that will be create

name
string
email
string
phone
string
description
string
object (Address)

...

object (Shipping)

...

payment_method
string

...

tax_exempt
string
Enum: "none" "exempt" "reverse"
balance
number
invoice_prefix
string [ 3 .. 12 ] characters
next_invoice_sequence
number
coupon
string
promotion_code
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "description": "string",
  • "address": {
    },
  • "shipping": {
    },
  • "payment_method": "string",
  • "tax_exempt": "none",
  • "balance": 0,
  • "invoice_prefix": "string",
  • "next_invoice_sequence": 0,
  • "coupon": "string",
  • "promotion_code": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Retrieve a customer

Find and return the customer with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Update a customer

Find and update the customer with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Request Body schema: application/json

The customer that will be update

name
string
email
string
phone
string
description
string
object (Address)

...

object (Shipping)

...

payment_method
string
tax_exempt
string
Enum: "none" "exempt" "reverse"
balance
number
invoice_prefix
string [ 3 .. 12 ] characters
next_invoice_sequence
number
coupon
string
promotion_code
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "description": "string",
  • "address": {
    },
  • "shipping": {
    },
  • "payment_method": "string",
  • "tax_exempt": "none",
  • "balance": 0,
  • "invoice_prefix": "string",
  • "next_invoice_sequence": 0,
  • "coupon": "string",
  • "promotion_code": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Remove a customer

Find and remove the customer with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Subscriptions

TODO: ...

List all subscriptions

Returns the list of your subscriptions.

Authorizations:
AWS-Cognito
query Parameters
limit
integer
Example: limit=10

The maximum number of items that can be returned. The supported values are between 5 and 25.

page
integer
Example: page=1

Number of the page to skip at the beginning of the list.

content
string

It allows to filter subscriptions that contain this value in their status or description.

currency
string

It allows to filter items by currency attribute.

customer
string

It allows to filter items by customer id.

status
string

It allows to filter items by status.

created_before
string <date-time-iso8601>

It allows to filter items where the created field is before a certain date.

created_after
string <date-time-iso8601>

It allows to filter items where the created field is after a certain date.

canceled_before
string <date-time-iso8601>

It allows to filter items where the canceled field is before a certain date.

canceled_after
string <date-time-iso8601>

It allows to filter items where the canceled field is after a certain date.

cancel_before
string <date-time-iso8601>

It allows to filter items where the cancel field is before a certain date.

cancel_after
string <date-time-iso8601>

It allows to filter items where the cancel field is after a certain date.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Create a subscription

Add a new item.

Authorizations:
AWS-Cognito
Request Body schema: application/json

The subscription that will be create

cancel_at_period_end
boolean
default_payment_method
string
description
string
payment_behavior
string
Enum: "allow_incomplete" "error_if_incomplete" "pending_if_incomplete" "default_incomplete"
cancel_at
string <date-time-iso8601>
collection_method
string
Enum: "charge_automatically" "send_invoice"
coupon
string
days_until_due
integer
promotion_code
string
trial_end
string <date-time-iso8601>
trial_from_plan
boolean
customer
required
string

The identifier of the customer to subscribe.

currency
string (Currency) = 3 characters

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

required
Array of objects (Subscription-Item)

A list of up to 20 subscription items, each with an attached price.

Responses

Request samples

Content type
application/json
{
  • "cancel_at_period_end": true,
  • "default_payment_method": "string",
  • "description": "string",
  • "payment_behavior": "allow_incomplete",
  • "cancel_at": "string",
  • "collection_method": "charge_automatically",
  • "coupon": "string",
  • "days_until_due": 0,
  • "promotion_code": "string",
  • "trial_end": "string",
  • "trial_from_plan": true,
  • "customer": "string",
  • "currency": "str",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Retrieve an subscription

Find and return the subscription with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Update a subscription

Find and update the subscription with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Request Body schema: application/json

The subscription that will be update

cancel_at_period_end
boolean
default_payment_method
string
description
string
payment_behavior
string
Enum: "allow_incomplete" "error_if_incomplete" "pending_if_incomplete" "default_incomplete"
cancel_at
string <date-time-iso8601>
collection_method
string
Enum: "charge_automatically" "send_invoice"
coupon
string
days_until_due
integer
promotion_code
string
trial_end
string <date-time-iso8601>
trial_from_plan
boolean
id
string

Item identifier

clear_usage
boolean
deleted
boolean
Array of objects (Subscription-Item)

Responses

Request samples

Content type
application/json
{
  • "cancel_at_period_end": true,
  • "default_payment_method": "string",
  • "description": "string",
  • "payment_behavior": "allow_incomplete",
  • "cancel_at": "string",
  • "collection_method": "charge_automatically",
  • "coupon": "string",
  • "days_until_due": 0,
  • "promotion_code": "string",
  • "trial_end": "string",
  • "trial_from_plan": true,
  • "id": "string",
  • "clear_usage": true,
  • "deleted": true,
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Cancel a subscription

Find and cancel the subscription with the given id.

Authorizations:
AWS-Cognito
path Parameters
id
required
string
Example: 5d04051125d9852c71016793

Item identifier

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Users

TODO: ...