Skip to main content
API docs by Redocly

MyBeezBox API (1.0.0)

Download OpenAPI specification:Download

E-mail: dev@mybeezbox.com

Welcome to MyBeezBox API documentation. You can use our API to access our different endpoints.

You can find more use cases here.

This API documentation is a work in progress.

Glossary:

Data types can be:

  • integer: a number that can be written without a fractional component. For example, 1.
  • float: a number that is not an integer, because it includes a fraction represented in decimal format. For example, 1.5.
  • boolean: a data type with two possible values. For example, true or false.

If you need information not available in the documentation, do not hesitate to contact us.

Authentication

Describe the authentication and authorization process. In particular, how to fetch your API token, and permissions.

Fetch your API token

Request Body schema: application/json
required

Credentials

username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "johndoe",
  • "password": "mypassword"
}

Response samples

Content type
application/json
{
  • "token": "f1fb35c26dee337de337f9d642ea21acd3f0f6d5",
  • "uuid": "123e4567-e89b-12d3-a456-426614174000",
  • "user": {
    }
}

Fetch your permissions

List of the current user's permissions

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ]
}

Media manager

Everything about the media manager and how to upload pictures

Create a media

Allows to create a new media, once at a time. So you can later use this media to be linked to your products as images.

Authorizations:
ApiKey
Request Body schema: multipart/form-data
required
name
required
string

Name of the media

file
required
string <binary>

The image to upload

Responses

Response samples

Content type
application/json
{}

Get all medias

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
[]

Get media by its ID

Returns a single media

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the media

Responses

Response samples

Content type
application/json
{}

Update media by its ID

Allows to update a media name. This could be useful if you want to append a suffix _old to an existing media, for example. This can only be done if the media is not used yet in any other product.

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the media

Request Body schema: application/json
required
name
required
string

Name of the media

Responses

Request samples

Content type
application/json
{
  • "name": "New media name"
}

Response samples

Content type
application/json
{}

Giftcards

Everything about giftcards

Get all giftcards

Get all giftcards

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find a giftcard by its id

Returns a single giftcard

Authorizations:
ApiKey
path Parameters
id
required
integer <int64>

Code of the giftcard to return

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "code": "NGCasdf123",
  • "status": "paid",
  • "created_on": "2022-06-16 12:00:0.000000+00:00",
  • "expires_on": "2023-06-16 12:00:0.000000+00:00",
  • "value": "100.000",
  • "remaining_value": "100.000",
  • "gifter_first_name": "John",
  • "gifter_last_name": "Doe"
}

Find a giftcard by its code

Returns a single giftcard

Authorizations:
ApiKey
path Parameters
code
required
string

Code of the giftcard to return

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "code": "NGCasdf123",
  • "status": "paid",
  • "created_on": "2022-06-16 12:00:0.000000+00:00",
  • "expires_on": "2023-06-16 12:00:0.000000+00:00",
  • "value": "100.000",
  • "remaining_value": "100.000",
  • "gifter_first_name": "John",
  • "gifter_last_name": "Doe"
}

Giftcard usages

Everything about giftcard usages

Vouchers - Vouchers

Everything about vouchers

Get all vouchers

The result is paginated

Authorizations:
ApiKey
query Parameters
code
string

Search voucher by code

voucher_prototype_name
string

Search voucher by prototype name

gifter
string

Search voucher by gifter

giftee
string

Search voucher by giftee

origin_url
string

Search voucher by origin url

page
string

Pagination

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "previous": null,
  • "has_previous": false,
  • "has_next": true,
  • "current_page": 1,
  • "next": "https://demo.bonkdo.com/api/vouchers/?page=2",
  • "page_range": [
    ],
  • "results": [
    ]
}

Get a voucher by code

Authorizations:
ApiKey
path Parameters
code
required
string

The code of the voucher you are looking for

Responses

Response samples

Content type
application/json
{
  • "url": "https://staging.bonkdo.com/api/vouchers/72533/",
  • "id": 72533,
  • "code": "ghakvgngkq",
  • "summary": null,
  • "origin": "Mon site web",
  • "voucher_prototype": 218,
  • "voucher_prototype_name": "Test univers 4",
  • "voucher_prototype_name_fr": "Test univers 4",
  • "voucher_prototype_name_es": null,
  • "voucher_prototype_name_en": null,
  • "voucher_prototype_name_it": null,
  • "voucher_prototype_name_de": null,
  • "voucher_prototype_name_nl": null,
  • "voucher_prototype_name_ca": null,
  • "voucher_prototype_name_pt": null,
  • "voucher_prototype_description_fr": "Prototype description",
  • "voucher_prototype_description_es": null,
  • "voucher_prototype_description_en": null,
  • "voucher_prototype_description_it": null,
  • "voucher_prototype_description_de": null,
  • "voucher_prototype_description_nl": null,
  • "voucher_prototype_description_ca": null,
  • "voucher_prototype_description_pt": null,
  • "voucher_prototype_rent_conditions_fr": "Rent conditions",
  • "voucher_prototype_rent_conditions_es": null,
  • "voucher_prototype_rent_conditions_en": null,
  • "voucher_prototype_rent_conditions_it": null,
  • "voucher_prototype_rent_conditions_de": null,
  • "voucher_prototype_rent_conditions_nl": null,
  • "voucher_prototype_rent_conditions_ca": null,
  • "voucher_prototype_rent_conditions_pt": null,
  • "voucher_prototype_type": 4,
  • "nb_nights": 2,
  • "nb_babies": 0,
  • "nb_children": 0,
  • "nb_adults": 2,
  • "options": [
    ],
  • "voucher_prototype_included_options": [
    ],
  • "reception_mode": 0,
  • "reception_mode_display": "Email à l'acheteur",
  • "selling_partner": "https://staging.bonkdo.com/api/partners/1/",
  • "gifter_civility": "M",
  • "gifter_first_name": "John",
  • "gifter_last_name": "Doe",
  • "gifter_fullname": "John Doe",
  • "gifter_address": "Avenue",
  • "gifter_email": "john@mybeezbox.com",
  • "gifter_zipcode": 75018,
  • "gifter_city": "Paris",
  • "gifter_country": "FR",
  • "gifter_wired_phone": "(+33)1 23 45 67 89",
  • "gifter_mobile_phone": null,
  • "self_gifted": true,
  • "giftee_first_name": "John Doe",
  • "giftee_last_name": "Doe",
  • "giftee_email": "john+o@mybeezbox.com",
  • "giftee_phone_number": "+33678735335",
  • "recipient_address": "string",
  • "message": null,
  • "total_price": "215.00",
  • "purchase_price": "215.00",
  • "rent_price": "230.00",
  • "bought_rent_price": "230.00",
  • "creation_date": "2023-01-24T10:03:09.565674+01:00",
  • "activation_date": "string",
  • "usage_date": "string",
  • "expiration_date": "2025-01-23T10:03:23.830839+01:00",
  • "expiration_date_display": "2025-01-23",
  • "gifter": 3918,
  • "giftee": 18277,
  • "state": "paid",
  • "rentals": [
    ],
  • "pdf_file": "https://staging.bonkdo.com/media/voucher_pdfs/3e4a937e-2dd9-4966-b7a9-9ec0ee3c01d4.pdf",
  • "printable_pdf_file": "string",
  • "coupon": "string",
  • "coupon_details": "string",
  • "coupon_for_email_details": {
    },
  • "api_version": 2,
  • "type": 4,
  • "to_giftee": "John Doe",
  • "from_gifter": "John Doe",
  • "expedition_status": "not_sent",
  • "expedition_date": "string",
  • "cover_letter_url": "string",
  • "language": "fr",
  • "is_group_payment": true,
  • "is_usable": true,
  • "is_extendable": true,
  • "invoice_url": "https://staging.bonkdo.com/fr/accounting/invoice/d29866a2-8441-42c5-a22d-4f515e1ac3f4/",
  • "is_refundable": true,
  • "payment_type": "payzen",
  • "imported_from": "string"
}

Update a voucher

Authorizations:
ApiKey
path Parameters
code
required
string

The voucher code you are looking for

Request Body schema: application/json
required
state
required
string
Enum: "draft" "paid" "error" "using" "used" "exprd"

Responses

Request samples

Content type
application/json
{
  • "state": "draft"
}

Vouchers - Prototypes

Everything about prototypes

Create a voucher prototype

Authorizations:
ApiKey
Request Body schema: application/json
required

Voucher prototype that will be created

name_en
required
string

Name of the prototype (English version)

name_fr
required
string

Name of the prototype (French version)

name_es
required
string

Name of the prototype (Spanish version)

name_it
required
string

Name of the prototype (Italian version)

name_de
required
string

Name of the prototype (German version)

name_nl
required
string

Name of the prototype (Dutch version)

name_ca
required
string

Name of the prototype (Catalan version)

name_pt
required
string

Name of the prototype (Portuguese version)

is_active
boolean
Default: false

Whether the prototype is active or not.

type
required
string
Enum: "stay" "standard" "fixed_stay"

Type of the prototype

is_highlight
boolean
Default: false

Whether the prototype is highlighted or not.

price_scope
integer <int64>
Default: 1

Number of persons the rate applies to. Use the value 0 for "whole rental".

max_capacity
integer <int64>
Default: 0

Maximum capacity of the prototype. Use the value 0 if the prototype has not a maximum capacity.

min_capacity
integer <int64>
Default: 1

Minimum capacity of the prototype.

stay_price
required
float

Selling price of the prototype

adults_price
float

Price for additional adult.

children_price
float

Price for additional child.

baby_price
float

Price for additional baby.

description_en
required
string

Description of the prototype (English version).

description_fr
required
string

Description of the prototype (French version).

description_es
required
string

Description of the prototype (Spanish version).

description_it
required
string

Description of the prototype (Italian version).

description_de
required
string

Description of the prototype (German version).

description_nl
required
string

Description of the prototype (Dutch version).

description_ca
required
string

Description of the prototype (Catalan version).

description_pt
required
string

Description of the prototype (Portuguese version).

long_description_en
required
string

Long description of the prototype (English version).

long_description_fr
required
string

Long description of the prototype (French version).

long_description_es
required
string

Long description of the prototype (Spanish version).

long_description_it
required
string

Long description of the prototype (Italian version).

long_description_de
required
string

Long description of the prototype (German version).

long_description_nl
required
string

Long description of the prototype (Dutch version).

long_description_ca
required
string

Long description of the prototype (Catalan version).

long_description_pt
required
string

Long description of the prototype (Portuguese version).

rent_conditions_en
string

Rent conditions (English version).

rent_conditions_fr
string

Rent conditions (French version).

rent_conditions_es
string

Rent conditions (Spanish version).

rent_conditions_it
string

Rent conditions (Italian version).

rent_conditions_de
string

Rent conditions (German version).

rent_conditions_nl
string

Rent conditions (Dutch version).

rent_conditions_ca
string

Rent conditions (Catalan version).

rent_conditions_pt
string

Rent conditions (Portuguese version).

how_to_book_html_en
string

String containing HTML.

how_to_book_html_fr
string

String containing HTML.

how_to_book_html_es
string

String containing HTML.

how_to_book_html_it
string

String containing HTML.

how_to_book_html_de
string

String containing HTML.

how_to_book_html_nl
string

String containing HTML.

how_to_book_html_ca
string

String containing HTML.

how_to_book_html_pt
string

String containing HTML.

pdf_description_en
string

This field should not exceed 300 characters.

pdf_description_fr
string

This field should not exceed 300 characters.

pdf_description_es
string

This field should not exceed 300 characters.

pdf_description_it
string

This field should not exceed 300 characters.

pdf_description_de
string

This field should not exceed 300 characters.

pdf_description_nl
string

This field should not exceed 300 characters.

pdf_description_ca
string

This field should not exceed 300 characters.

pdf_description_pt
string

This field should not exceed 300 characters.

partner_uuid
string <uuid>

The UUID of the partner

universe
required
integer <int64>

The ID of the universe.

environment
integer <int64>

The ID of the environment.

last_active_day
date <date>

The last day of diffusion in date format YYYY-mm-dd If set, the prototype's is_active value will become false when this date passes.

ranking
integer <int64>
Default: 1

Number that allows setting display priority on funnel.

images
Array of integers

List of Media IDs linked to the prototype

cover_image
integer <int64>
Default: 1

Media ID that should be used as cover image for the prototype. Set this to null if you want to remove the cover image, if it was set before.

Responses

Request samples

Content type
application/json
{
  • "name_en": "Prototype",
  • "name_fr": "Offre",
  • "name_es": "Prototipo",
  • "name_it": "Prototipo",
  • "name_de": "Prototyp",
  • "name_nl": "Prototype",
  • "name_ca": "Prototip",
  • "name_pt": "Protótipo",
  • "is_active": false,
  • "type": "stay",
  • "is_highlight": false,
  • "price_scope": 1,
  • "max_capacity": 0,
  • "min_capacity": 1,
  • "stay_price": 10.5,
  • "adults_price": null,
  • "children_price": null,
  • "baby_price": null,
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "Descrição",
  • "long_description_en": "Long description",
  • "long_description_fr": "Description longue",
  • "long_description_es": "Descripción larga",
  • "long_description_it": "Descrizione lunga",
  • "long_description_de": "Lange Beschreibung",
  • "long_description_nl": "Lange beschrijving",
  • "long_description_ca": "Descripció llarga",
  • "long_description_pt": "Descrição longa",
  • "rent_conditions_en": "Terms of use",
  • "rent_conditions_fr": "Conditions d'utilisation",
  • "rent_conditions_es": "Términos y condiciones de uso",
  • "rent_conditions_it": "Termini di utilizzo",
  • "rent_conditions_de": "Nutzungsbedingungen",
  • "rent_conditions_nl": "Gebruiksvoorwaarden",
  • "rent_conditions_ca": "Condicions d'ús",
  • "rent_conditions_pt": "Termos de utilização",
  • "how_to_book_html_en": "<p>Text (en)</p>",
  • "how_to_book_html_fr": "<p>Text (fr)</p>",
  • "how_to_book_html_es": "<p>Text (es)</p>",
  • "how_to_book_html_it": "<p>Text (it)</p>",
  • "how_to_book_html_de": "<p>Text (de)</p>",
  • "how_to_book_html_nl": "<p>Text (nl)</p>",
  • "how_to_book_html_ca": "<p>Text (ca)</p>",
  • "how_to_book_html_pt": "<p>Text (pt)</p>",
  • "pdf_description_en": "string",
  • "pdf_description_fr": "string",
  • "pdf_description_es": "string",
  • "pdf_description_it": "string",
  • "pdf_description_de": "string",
  • "pdf_description_nl": "string",
  • "pdf_description_ca": "string",
  • "pdf_description_pt": "string",
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "universe": 1,
  • "environment": 2,
  • "last_active_day": null,
  • "ranking": 1,
  • "images": [
    ],
  • "cover_image": 1
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name_en": "Prototype",
  • "name_fr": "Offre",
  • "name_es": "Prototipo",
  • "name_it": "Prototipo",
  • "name_de": "Prototyp",
  • "name_nl": "Prototype",
  • "name_ca": "Prototip",
  • "name_pt": "Protótipo",
  • "is_active": false,
  • "type": "stay",
  • "is_highlight": false,
  • "price_scope": 1,
  • "max_capacity": 0,
  • "min_capacity": 1,
  • "stay_price": 10.5,
  • "adults_price": null,
  • "children_price": null,
  • "baby_price": null,
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "Descrição",
  • "long_description_en": "Long description",
  • "long_description_fr": "Description longue",
  • "long_description_es": "Descripción larga",
  • "long_description_it": "Descrizione lunga",
  • "long_description_de": "Lange Beschreibung",
  • "long_description_nl": "Lange beschrijving",
  • "long_description_ca": "Descripció llarga",
  • "long_description_pt": "Descrição longa",
  • "rent_conditions_en": "Terms of use",
  • "rent_conditions_fr": "Conditions d'utilisation",
  • "rent_conditions_es": "Términos y condiciones de uso",
  • "rent_conditions_it": "Termini di utilizzo",
  • "rent_conditions_de": "Nutzungsbedingungen",
  • "rent_conditions_nl": "Gebruiksvoorwaarden",
  • "rent_conditions_ca": "Condicions d'ús",
  • "rent_conditions_pt": "Termos de utilização",
  • "how_to_book_html_en": "<p>Text (en)</p>",
  • "how_to_book_html_fr": "<p>Text (fr)</p>",
  • "how_to_book_html_es": "<p>Text (es)</p>",
  • "how_to_book_html_it": "<p>Text (it)</p>",
  • "how_to_book_html_de": "<p>Text (de)</p>",
  • "how_to_book_html_nl": "<p>Text (nl)</p>",
  • "how_to_book_html_ca": "<p>Text (ca)</p>",
  • "how_to_book_html_pt": "<p>Text (pt)</p>",
  • "pdf_description_en": "string",
  • "pdf_description_fr": "string",
  • "pdf_description_es": "string",
  • "pdf_description_it": "string",
  • "pdf_description_de": "string",
  • "pdf_description_nl": "string",
  • "pdf_description_ca": "string",
  • "pdf_description_pt": "string",
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "universe": 1,
  • "environment": 2,
  • "last_active_day": null,
  • "ranking": 1,
  • "nb_orders": 2,
  • "images": [
    ],
  • "cover_image": 1
}

Get all prototypes

Get all voucher prototypes

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get prototype by its ID

Returns a single voucher prototype

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the prototype

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name_en": "Prototype",
  • "name_fr": "Offre",
  • "name_es": "Prototipo",
  • "name_it": "Prototipo",
  • "name_de": "Prototyp",
  • "name_nl": "Prototype",
  • "name_ca": "Prototip",
  • "name_pt": "Protótipo",
  • "is_active": false,
  • "type": "stay",
  • "is_highlight": false,
  • "price_scope": 1,
  • "max_capacity": 0,
  • "min_capacity": 1,
  • "stay_price": 10.5,
  • "adults_price": null,
  • "children_price": null,
  • "baby_price": null,
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "Descrição",
  • "long_description_en": "Long description",
  • "long_description_fr": "Description longue",
  • "long_description_es": "Descripción larga",
  • "long_description_it": "Descrizione lunga",
  • "long_description_de": "Lange Beschreibung",
  • "long_description_nl": "Lange beschrijving",
  • "long_description_ca": "Descripció llarga",
  • "long_description_pt": "Descrição longa",
  • "rent_conditions_en": "Terms of use",
  • "rent_conditions_fr": "Conditions d'utilisation",
  • "rent_conditions_es": "Términos y condiciones de uso",
  • "rent_conditions_it": "Termini di utilizzo",
  • "rent_conditions_de": "Nutzungsbedingungen",
  • "rent_conditions_nl": "Gebruiksvoorwaarden",
  • "rent_conditions_ca": "Condicions d'ús",
  • "rent_conditions_pt": "Termos de utilização",
  • "how_to_book_html_en": "<p>Text (en)</p>",
  • "how_to_book_html_fr": "<p>Text (fr)</p>",
  • "how_to_book_html_es": "<p>Text (es)</p>",
  • "how_to_book_html_it": "<p>Text (it)</p>",
  • "how_to_book_html_de": "<p>Text (de)</p>",
  • "how_to_book_html_nl": "<p>Text (nl)</p>",
  • "how_to_book_html_ca": "<p>Text (ca)</p>",
  • "how_to_book_html_pt": "<p>Text (pt)</p>",
  • "pdf_description_en": "string",
  • "pdf_description_fr": "string",
  • "pdf_description_es": "string",
  • "pdf_description_it": "string",
  • "pdf_description_de": "string",
  • "pdf_description_nl": "string",
  • "pdf_description_ca": "string",
  • "pdf_description_pt": "string",
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "universe": 1,
  • "environment": 2,
  • "last_active_day": null,
  • "ranking": 1,
  • "nb_orders": 2,
  • "images": [
    ],
  • "cover_image": 1
}

Update prototype by its ID

Updates a single voucher prototype

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the prototype

Request Body schema: application/json
required

Voucher prototype that will be updated

name_en
required
string

Name of the prototype (English version)

name_fr
required
string

Name of the prototype (French version)

name_es
required
string

Name of the prototype (Spanish version)

name_it
required
string

Name of the prototype (Italian version)

name_de
required
string

Name of the prototype (German version)

name_nl
required
string

Name of the prototype (Dutch version)

name_ca
required
string

Name of the prototype (Catalan version)

name_pt
required
string

Name of the prototype (Portuguese version)

is_active
boolean
Default: false

Whether the prototype is active or not.

type
required
string
Enum: "stay" "standard" "fixed_stay"

Type of the prototype

is_highlight
boolean
Default: false

Whether the prototype is highlighted or not.

price_scope
integer <int64>
Default: 1

Number of persons the rate applies to. Use the value 0 for "whole rental".

max_capacity
integer <int64>
Default: 0

Maximum capacity of the prototype. Use the value 0 if the prototype has not a maximum capacity.

min_capacity
integer <int64>
Default: 1

Minimum capacity of the prototype.

stay_price
required
float

Selling price of the prototype

adults_price
float

Price for additional adult.

children_price
float

Price for additional child.

baby_price
float

Price for additional baby.

description_en
required
string

Description of the prototype (English version).

description_fr
required
string

Description of the prototype (French version).

description_es
required
string

Description of the prototype (Spanish version).

description_it
required
string

Description of the prototype (Italian version).

description_de
required
string

Description of the prototype (German version).

description_nl
required
string

Description of the prototype (Dutch version).

description_ca
required
string

Description of the prototype (Catalan version).

description_pt
required
string

Description of the prototype (Portuguese version).

long_description_en
required
string

Long description of the prototype (English version).

long_description_fr
required
string

Long description of the prototype (French version).

long_description_es
required
string

Long description of the prototype (Spanish version).

long_description_it
required
string

Long description of the prototype (Italian version).

long_description_de
required
string

Long description of the prototype (German version).

long_description_nl
required
string

Long description of the prototype (Dutch version).

long_description_ca
required
string

Long description of the prototype (Catalan version).

long_description_pt
required
string

Long description of the prototype (Portuguese version).

rent_conditions_en
string

Rent conditions (English version).

rent_conditions_fr
string

Rent conditions (French version).

rent_conditions_es
string

Rent conditions (Spanish version).

rent_conditions_it
string

Rent conditions (Italian version).

rent_conditions_de
string

Rent conditions (German version).

rent_conditions_nl
string

Rent conditions (Dutch version).

rent_conditions_ca
string

Rent conditions (Catalan version).

rent_conditions_pt
string

Rent conditions (Portuguese version).

how_to_book_html_en
string

String containing HTML.

how_to_book_html_fr
string

String containing HTML.

how_to_book_html_es
string

String containing HTML.

how_to_book_html_it
string

String containing HTML.

how_to_book_html_de
string

String containing HTML.

how_to_book_html_nl
string

String containing HTML.

how_to_book_html_ca
string

String containing HTML.

how_to_book_html_pt
string

String containing HTML.

pdf_description_en
string

This field should not exceed 300 characters.

pdf_description_fr
string

This field should not exceed 300 characters.

pdf_description_es
string

This field should not exceed 300 characters.

pdf_description_it
string

This field should not exceed 300 characters.

pdf_description_de
string

This field should not exceed 300 characters.

pdf_description_nl
string

This field should not exceed 300 characters.

pdf_description_ca
string

This field should not exceed 300 characters.

pdf_description_pt
string

This field should not exceed 300 characters.

partner_uuid
string <uuid>

The UUID of the partner

universe
required
integer <int64>

The ID of the universe.

environment
integer <int64>

The ID of the environment.

last_active_day
date <date>

The last day of diffusion in date format YYYY-mm-dd If set, the prototype's is_active value will become false when this date passes.

ranking
integer <int64>
Default: 1

Number that allows setting display priority on funnel.

images
Array of integers

List of Media IDs linked to the prototype

cover_image
integer <int64>
Default: 1

Media ID that should be used as cover image for the prototype. Set this to null if you want to remove the cover image, if it was set before.

Responses

Request samples

Content type
application/json
{
  • "name_en": "Prototype",
  • "name_fr": "Offre",
  • "name_es": "Prototipo",
  • "name_it": "Prototipo",
  • "name_de": "Prototyp",
  • "name_nl": "Prototype",
  • "name_ca": "Prototip",
  • "name_pt": "Protótipo",
  • "is_active": false,
  • "type": "stay",
  • "is_highlight": false,
  • "price_scope": 1,
  • "max_capacity": 0,
  • "min_capacity": 1,
  • "stay_price": 10.5,
  • "adults_price": null,
  • "children_price": null,
  • "baby_price": null,
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "Descrição",
  • "long_description_en": "Long description",
  • "long_description_fr": "Description longue",
  • "long_description_es": "Descripción larga",
  • "long_description_it": "Descrizione lunga",
  • "long_description_de": "Lange Beschreibung",
  • "long_description_nl": "Lange beschrijving",
  • "long_description_ca": "Descripció llarga",
  • "long_description_pt": "Descrição longa",
  • "rent_conditions_en": "Terms of use",
  • "rent_conditions_fr": "Conditions d'utilisation",
  • "rent_conditions_es": "Términos y condiciones de uso",
  • "rent_conditions_it": "Termini di utilizzo",
  • "rent_conditions_de": "Nutzungsbedingungen",
  • "rent_conditions_nl": "Gebruiksvoorwaarden",
  • "rent_conditions_ca": "Condicions d'ús",
  • "rent_conditions_pt": "Termos de utilização",
  • "how_to_book_html_en": "<p>Text (en)</p>",
  • "how_to_book_html_fr": "<p>Text (fr)</p>",
  • "how_to_book_html_es": "<p>Text (es)</p>",
  • "how_to_book_html_it": "<p>Text (it)</p>",
  • "how_to_book_html_de": "<p>Text (de)</p>",
  • "how_to_book_html_nl": "<p>Text (nl)</p>",
  • "how_to_book_html_ca": "<p>Text (ca)</p>",
  • "how_to_book_html_pt": "<p>Text (pt)</p>",
  • "pdf_description_en": "string",
  • "pdf_description_fr": "string",
  • "pdf_description_es": "string",
  • "pdf_description_it": "string",
  • "pdf_description_de": "string",
  • "pdf_description_nl": "string",
  • "pdf_description_ca": "string",
  • "pdf_description_pt": "string",
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "universe": 1,
  • "environment": 2,
  • "last_active_day": null,
  • "ranking": 1,
  • "images": [
    ],
  • "cover_image": 1
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name_en": "Prototype",
  • "name_fr": "Offre",
  • "name_es": "Prototipo",
  • "name_it": "Prototipo",
  • "name_de": "Prototyp",
  • "name_nl": "Prototype",
  • "name_ca": "Prototip",
  • "name_pt": "Protótipo",
  • "is_active": false,
  • "type": "stay",
  • "is_highlight": false,
  • "price_scope": 1,
  • "max_capacity": 0,
  • "min_capacity": 1,
  • "stay_price": 10.5,
  • "adults_price": null,
  • "children_price": null,
  • "baby_price": null,
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "Descrição",
  • "long_description_en": "Long description",
  • "long_description_fr": "Description longue",
  • "long_description_es": "Descripción larga",
  • "long_description_it": "Descrizione lunga",
  • "long_description_de": "Lange Beschreibung",
  • "long_description_nl": "Lange beschrijving",
  • "long_description_ca": "Descripció llarga",
  • "long_description_pt": "Descrição longa",
  • "rent_conditions_en": "Terms of use",
  • "rent_conditions_fr": "Conditions d'utilisation",
  • "rent_conditions_es": "Términos y condiciones de uso",
  • "rent_conditions_it": "Termini di utilizzo",
  • "rent_conditions_de": "Nutzungsbedingungen",
  • "rent_conditions_nl": "Gebruiksvoorwaarden",
  • "rent_conditions_ca": "Condicions d'ús",
  • "rent_conditions_pt": "Termos de utilização",
  • "how_to_book_html_en": "<p>Text (en)</p>",
  • "how_to_book_html_fr": "<p>Text (fr)</p>",
  • "how_to_book_html_es": "<p>Text (es)</p>",
  • "how_to_book_html_it": "<p>Text (it)</p>",
  • "how_to_book_html_de": "<p>Text (de)</p>",
  • "how_to_book_html_nl": "<p>Text (nl)</p>",
  • "how_to_book_html_ca": "<p>Text (ca)</p>",
  • "how_to_book_html_pt": "<p>Text (pt)</p>",
  • "pdf_description_en": "string",
  • "pdf_description_fr": "string",
  • "pdf_description_es": "string",
  • "pdf_description_it": "string",
  • "pdf_description_de": "string",
  • "pdf_description_nl": "string",
  • "pdf_description_ca": "string",
  • "pdf_description_pt": "string",
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "universe": 1,
  • "environment": 2,
  • "last_active_day": null,
  • "ranking": 1,
  • "nb_orders": 2,
  • "images": [
    ],
  • "cover_image": 1
}

Get all options related to a prototype

Get all options related to a voucher prototype

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the prototype

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Vouchers - Options

Everything about options

Create an option

Authorizations:
ApiKey
Request Body schema: application/json
required

Option that will be created

name_en
required
string

Name of the option (English version)

name_fr
required
string

Name of the option (French version)

name_es
required
string

Name of the option (Spanish version)

name_it
required
string

Name of the option (Italian version)

name_de
required
string

Name of the option (German version)

name_nl
required
string

Name of the option (Dutch version)

name_ca
required
string

Name of the option (Catalan version)

name_pt
required
string

Name of the option (Portuguese version)

description_en
required
string

Description of the option (English version).

description_fr
required
string

Description of the option (French version).

description_es
required
string

Description of the option (Spanish version).

description_it
required
string

Description of the option (Italian version).

description_de
required
string

Description of the option (German version).

description_nl
required
string

Description of the option (Dutch version).

description_ca
required
string

Description of the option (Catalan version).

description_pt
required
string

Description of the option (Portuguese version).

selling_price
required
float

Selling price of the option.

is_active
boolean
Default: true

Whether the option is active or not.

countable
boolean
Default: false

Whether the option can be selected more than once, or not.

is_global
boolean
Default: false

If enabled, the option can be purchased on all prototypes.

ranking
integer <int64>
Default: 1

Number that allows setting display priority on funnel

partner_uuid
string <uuid>

The UUID of the partner

voucher_prototypes_ids
Array of integers

List of voucher prototypes IDs that are linked to this option.

category_id
integer <int64>

The ID of the category.

Responses

Request samples

Content type
application/json
{
  • "name_en": "Option",
  • "name_fr": "Option",
  • "name_es": "Opción",
  • "name_it": "Opzione",
  • "name_de": "Option",
  • "name_nl": "Optie",
  • "name_ca": "Opció",
  • "name_pt": "Opção",
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "Descrição",
  • "selling_price": 10.5,
  • "is_active": true,
  • "countable": false,
  • "is_global": false,
  • "ranking": 10,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "voucher_prototypes_ids": [
    ],
  • "category_id": null
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name_en": "Option",
  • "name_fr": "Option",
  • "name_es": "Opción",
  • "name_it": "Opzione",
  • "name_de": "Option",
  • "name_nl": "Optie",
  • "name_ca": "Opció",
  • "name_pt": "Opção",
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "Descrição",
  • "selling_price": 10.5,
  • "is_active": true,
  • "countable": false,
  • "is_global": false,
  • "ranking": 10,
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "voucher_prototypes_ids": [
    ],
  • "category_id": null
}

Get all options

Get all voucher options

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get option by its ID

Returns a single voucher option

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the option

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name_en": "Option",
  • "name_fr": "Option",
  • "name_es": "Opción",
  • "name_it": "Opzione",
  • "name_de": "Option",
  • "name_nl": "Optie",
  • "name_ca": "Opció",
  • "name_pt": "Opção",
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "Descrição",
  • "selling_price": 10.5,
  • "is_active": true,
  • "countable": false,
  • "is_global": false,
  • "ranking": 10,
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "voucher_prototypes_ids": [
    ],
  • "category_id": null
}

Update option by its ID

Updates a single voucher option

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the option

Request Body schema: application/json
required

Voucher option that will be updated

count
required
integer <int64>

Number of times the option has been selected.

included
required
boolean
Default: true

Whether the option is included in the price of the prototype, or not.

required
object (VoucherOption)

A voucher option

Responses

Request samples

Content type
application/json
{
  • "count": 1,
  • "included": true,
  • "option": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "count": 1,
  • "included": true,
  • "option": {
    }
}

Create a category

Authorizations:
ApiKey
Request Body schema: application/json
required

Option that will be created

name_en
required
string

Name of the category (English version)

name_fr
required
string

Name of the category (French version)

name_es
required
string

Name of the category (Spanish version)

name_it
required
string

Name of the category (Italian version)

name_de
required
string

Name of the category (German version)

name_nl
required
string

Name of the category (Dutch version)

name_ca
required
string

Name of the category (Catalan version)

name_pt
required
string

Name of the category (Portuguese version)

description_en
required
string

Description of the category (English version).

description_fr
required
string

Description of the category (French version).

description_es
required
string

Description of the category (Spanish version).

description_it
required
string

Description of the category (Italian version).

description_de
required
string

Description of the category (German version).

description_nl
required
string

Description of the category (Dutch version).

description_ca
required
string

Description of the category (Catalan version).

description_pt
required
string

Description of the category (Portuguese version).

is_active
boolean
Default: true

Whether the option is active or not.

ranking
integer <int64>
Default: 1

Number that allows setting display priority on funnel

min_number_options
integer <int64>
Default: null

If set, the buyer has to choose at least this number of options to validate. If empty, it's not mandatory to choose an option.

max_number_options
integer <int64>
Default: null

If set, the buyer have to choose at most this number of options to validate. If empty, it's not mandatory to choose an option.

partner_uuid
required
string <uuid>

The UUID of the partner

Responses

Request samples

Content type
application/json
{
  • "name_en": "Category",
  • "name_fr": "Catégorie",
  • "name_es": "Categoría",
  • "name_it": "Categoria",
  • "name_de": "Kategorie",
  • "name_nl": "Categorie",
  • "name_ca": "Categoria",
  • "name_pt": "Categoria",
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "string",
  • "is_active": true,
  • "ranking": 10,
  • "min_number_options": 10,
  • "max_number_options": 10,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name_en": "Category",
  • "name_fr": "Catégorie",
  • "name_es": "Categoría",
  • "name_it": "Categoria",
  • "name_de": "Kategorie",
  • "name_nl": "Categorie",
  • "name_ca": "Categoria",
  • "name_pt": "Categoria",
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "string",
  • "is_active": true,
  • "ranking": 10,
  • "min_number_options": 10,
  • "max_number_options": 10,
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45"
}

Get all categories

Get all voucher option categories

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get category by its ID

Returns a single voucher option category

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the category

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name_en": "Category",
  • "name_fr": "Catégorie",
  • "name_es": "Categoría",
  • "name_it": "Categoria",
  • "name_de": "Kategorie",
  • "name_nl": "Categorie",
  • "name_ca": "Categoria",
  • "name_pt": "Categoria",
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "string",
  • "is_active": true,
  • "ranking": 10,
  • "min_number_options": 10,
  • "max_number_options": 10,
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45"
}

Update category by its ID

Updates a single voucher option category

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the option

Request Body schema: application/json
required

Voucher option category that will be updated

name_en
required
string

Name of the category (English version)

name_fr
required
string

Name of the category (French version)

name_es
required
string

Name of the category (Spanish version)

name_it
required
string

Name of the category (Italian version)

name_de
required
string

Name of the category (German version)

name_nl
required
string

Name of the category (Dutch version)

name_ca
required
string

Name of the category (Catalan version)

name_pt
required
string

Name of the category (Portuguese version)

description_en
required
string

Description of the category (English version).

description_fr
required
string

Description of the category (French version).

description_es
required
string

Description of the category (Spanish version).

description_it
required
string

Description of the category (Italian version).

description_de
required
string

Description of the category (German version).

description_nl
required
string

Description of the category (Dutch version).

description_ca
required
string

Description of the category (Catalan version).

description_pt
required
string

Description of the category (Portuguese version).

is_active
boolean
Default: true

Whether the option is active or not.

ranking
integer <int64>
Default: 1

Number that allows setting display priority on funnel

min_number_options
integer <int64>
Default: null

If set, the buyer has to choose at least this number of options to validate. If empty, it's not mandatory to choose an option.

max_number_options
integer <int64>
Default: null

If set, the buyer have to choose at most this number of options to validate. If empty, it's not mandatory to choose an option.

partner_uuid
required
string <uuid>

The UUID of the partner

Responses

Request samples

Content type
application/json
{
  • "name_en": "Category",
  • "name_fr": "Catégorie",
  • "name_es": "Categoría",
  • "name_it": "Categoria",
  • "name_de": "Kategorie",
  • "name_nl": "Categorie",
  • "name_ca": "Categoria",
  • "name_pt": "Categoria",
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "string",
  • "is_active": true,
  • "ranking": 10,
  • "min_number_options": 10,
  • "max_number_options": 10,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name_en": "Category",
  • "name_fr": "Catégorie",
  • "name_es": "Categoría",
  • "name_it": "Categoria",
  • "name_de": "Kategorie",
  • "name_nl": "Categorie",
  • "name_ca": "Categoria",
  • "name_pt": "Categoria",
  • "description_en": "Description",
  • "description_fr": "Description",
  • "description_es": "Descripción",
  • "description_it": "Descrizione",
  • "description_de": "Beschreibung",
  • "description_nl": "Beschrijving",
  • "description_ca": "Descripció",
  • "description_pt": "string",
  • "is_active": true,
  • "ranking": 10,
  • "min_number_options": 10,
  • "max_number_options": 10,
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45"
}

Network giftcards

Everything about network giftcards

Create a new network giftcard

Authorizations:
ApiKey
Request Body schema: application/json
required

Network giftcard that will be created

marketplace_uuid
required
string <uuid>

The UUID of the marketplace

status
required
string
Enum: "draft" "paid" "cncld" "using" "test"

Status of the network giftcard

value
required
number <float>
required
object (Customer)

A person that can buy or receive a gift

object (Customer)

A person that can buy or receive a gift

from_gifter
required
string

A message from the gifter, to the giftee

activation_date
required
string

Activation date of the network giftcard

expiration_date
required
string

Expiration date of the network giftcard

Responses

Request samples

Content type
application/json
{
  • "marketplace_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "status": "paid",
  • "value": 100,
  • "gifter": {
    },
  • "giftee": {
    },
  • "from_gifter": "Happy birthday!",
  • "activation_date": "2022-06-16 12:00:0.000000+00:00",
  • "expiration_date": "2023-06-16 12:00:0.000000+00:00"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "code": "NGCasdf123",
  • "status": "paid",
  • "value": 100,
  • "remaining_value": 100,
  • "creation_date": "2022-06-16 12:00:0.000000+00:00",
  • "activation_date": "2022-06-16 12:00:0.000000+00:00",
  • "expiration_date": "2023-06-16 12:00:0.000000+00:00",
  • "is_active": true,
  • "is_splittable": true,
  • "gifter": {
    },
  • "giftee": {
    },
  • "from_gifter": "Happy birthday!",
  • "marketplace_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45"
}

(DEPRECATED) Find network giftcard by its code

(DEPRECATED) Returns a single network giftcard

Authorizations:
ApiKey
path Parameters
code
required
string

Code of network giftcard to return

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "code": "NGCasdf123",
  • "status": "paid",
  • "value": 100,
  • "remaining_value": 100,
  • "creation_date": "2022-06-16 12:00:0.000000+00:00",
  • "activation_date": "2022-06-16 12:00:0.000000+00:00",
  • "expiration_date": "2023-06-16 12:00:0.000000+00:00",
  • "is_active": true,
  • "is_splittable": true,
  • "gifter": {
    },
  • "giftee": {
    },
  • "from_gifter": "Happy birthday!",
  • "marketplace_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45"
}

Find a network giftcard by its code

Returns a single network giftcard

Authorizations:
ApiKey
path Parameters
code
required
string

Code of the network giftcard to return

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "uuid": "123e4567-e89b-12d3-a456-426614174000",
  • "code": "NGCasdf123",
  • "status": "paid",
  • "creation_date": "2022-06-16 12:00:0.000000+00:00",
  • "expiration_date": "2023-06-16 12:00:0.000000+00:00",
  • "value": 100,
  • "remaining_value": 100,
  • "pdf_url": "http://storage-url.com/file.pdf",
  • "order_uuid": "0d18sb76-3863-4bca-924e-aj3261907960",
  • "order_creation_date": "2023-06-16 12:00:0.000000+00:00",
  • "description": "Our giftcards are available in all our establishments",
  • "short_description": "Our network gift cards allow the recipient to choose the service of their dreams in one of our many establishments.",
  • "theme": "Discovery",
  • "image_url": "https://storage-url.com/media_manager/c0fe0524-90d4-4584-9d9f-71020b735612/ngc_logo.jpg"
}

Find network giftcards by email

Returns a list of network giftcards

Authorizations:
ApiKey
path Parameters
email
required
string

The Network Giftcard gifter or giftee email.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Network giftcard usages

Everything about network giftcard usages

Get all usages related to a network giftcard

Returns all network giftcard's usages

Authorizations:
ApiKey
path Parameters
code
required
string

Code of network giftcard

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "network_giftcard": 1,
  • "partner": 2,
  • "value": 20,
  • "is_active": true,
  • "comment": "This usage was created via API",
  • "reservation_id": "123-ABC",
  • "partner_source_id": 222,
  • "freeze_payout_date": "2022-06-16T12:00"
}

Use a network giftcard by code

This endpoint gets given partner_source_id, and sets the usage's partner with the partner that has given source ID. For example:

  • Partner A: ID = 1, source ID = 111.
  • Partner B: ID = 2, source ID = 222.

If the request has partner_source_id = 222, the usage's partner will be Partner B. If the request has partner_source_id = 2, it will raise an error because there is not partner with given source ID. If you want to use partner_source_id = 2 to set the same partner (using its ID, instead of source ID), you should use the endpoint /networkgiftcards_by_code/{code}/use_with_mybb_id/.

Authorizations:
ApiKey
path Parameters
code
required
string

Code of network giftcard to use

Request Body schema: application/json
required

Data to use the network giftcard

creation_date
required
string

Date/time that will be used to set the creation date of the usage. Set 12:00 as hour, so we avoid timezone issues.

value
required
number <decimal>

Value of the usage.

comment
string

Additional comment, that is displayed as a note on our dashboard.

reservation_id
string
partner_source_id
required
integer <int64>
freeze_payout_date
string

Date/time that will be used to take into account this usage in the payout. So instead of using the "creation date", we use this field:

  • Creation date: 01/01/2022
  • Freeze payout date: 01/05/2022

The payout from May 2022 will include this usage, instead of the payout of January 2022.

send_usage_notification_email
boolean

Whether we should send notification emails (after creating the usage) to marketplace and beneficiary, or not. By default, this is false.

giftee_email
string <email>

Email that will overwrite the beneficiary's email of the giftcard, and will be used as recipient of the email (if desired). If notification email should be sent, by default we use current beneficiary's email. But if we don't have any beneficiary's email, we will use buyer's one.

Responses

Request samples

Content type
application/json
{
  • "creation_date": "2022-06-16T12:00",
  • "value": 20,
  • "comment": "Used from our own API",
  • "reservation_id": "123-ABC",
  • "partner_source_id": 222,
  • "freeze_payout_date": "2022-08-01T12:00",
  • "send_usage_notification_email": false,
  • "giftee_email": "beneficiary@mybeezbox.com"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "network_giftcard": 1,
  • "partner": 2,
  • "value": 20,
  • "is_active": true,
  • "comment": "This usage was created via API",
  • "reservation_id": "123-ABC",
  • "partner_source_id": 222,
  • "freeze_payout_date": "2022-06-16T12:00"
}

Use a network giftcard by code

This endpoint gets given partner_source_id, and sets the usage's partner with the partner that has given source ID. For example:

  • Partner A: ID = 1, source ID = 111.
  • Partner B: ID = 2, source ID = 222.

If the request has partner_source_id = 2, the usage's partner will be Partner B. If the request has partner_source_id = 222, it will raise an error because there is not partner with given ID. If you want to use partner_source_id = 222 to set the same partner (using its ID, instead of its source ID), you should use the endpoint /networkgiftcards_by_code/{code}/use/.

Authorizations:
ApiKey
path Parameters
code
required
string

Code of network giftcard to use

Request Body schema: application/json
required

Data to use the network giftcard

creation_date
required
string

Date/time that will be used to set the creation date of the usage. Set 12:00 as hour, so we avoid timezone issues.

value
required
number <decimal>

Value of the usage.

comment
string

Additional comment, that is displayed as a note on our dashboard.

reservation_id
string
partner_id
required
integer <int64>
freeze_payout_date
string

Date/time that will be used to take into account this usage in the payout. So instead of using the "creation date", we use this field:

  • Creation date: 01/01/2022
  • Freeze payout date: 01/05/2022

The payout from May 2022 will include this usage, instead of the payout of January 2022.

send_usage_notification_email
boolean

Whether we should send notification emails (after creating the usage) to marketplace and beneficiary, or not. By default, this is false.

giftee_email
string

Email that will overwrite the beneficiary's email of the giftcard, and will be used as recipient of the email (if desired). If notification email should be sent, by default we use current beneficiary's email. But if we don't have any beneficiary's email, we will use buyer's one.

Responses

Request samples

Content type
application/json
{
  • "creation_date": "2022-06-16T12:00",
  • "value": 20,
  • "comment": "Used from our own API",
  • "reservation_id": "123-ABC",
  • "partner_id": 2,
  • "freeze_payout_date": "2022-08-01T12:00",
  • "send_usage_notification_email": false,
  • "giftee_email": "beneficiary@mybeezbox.com"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "network_giftcard": 1,
  • "partner": 2,
  • "value": 20,
  • "is_active": true,
  • "comment": "This usage was created via API",
  • "reservation_id": "123-ABC",
  • "partner_source_id": 222,
  • "freeze_payout_date": "2022-06-16T12:00"
}

Get all usages related to a network giftcard

Returns all network giftcard's usages

Authorizations:
ApiKey
path Parameters
code
required
string

Code of network giftcard

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cancel an already existing network giftcard usage

If the network giftcard usage is already linked to a payout, this won't be executed

Authorizations:
ApiKey
path Parameters
id
required
integer <int64>

ID of network giftcard usage

Request Body schema: application/json
required

Data to cancel the network giftcard usage

comment
string

A possible comment that can be set when creating the usage

Responses

Request samples

Content type
application/json
{
  • "comment": "This usage was created via API"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "network_giftcard": 1,
  • "partner": 2,
  • "value": 20,
  • "is_active": true,
  • "comment": "This usage was created via API",
  • "reservation_id": "123-ABC",
  • "partner_source_id": 222,
  • "freeze_payout_date": "2022-06-16T12:00"
}

Network vouchers

Everything about network vouchers

Get all boxes

Get all network voucher boxes

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get box by its ID

Returns a single box

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the box

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name_en": "Three lovely days in Spain",
  • "name_fr": "Trois belles journées en Espagne",
  • "name_es": "Tres días maravillosos en España",
  • "name_it": "Tre bellissimi giorni in Spagna",
  • "name_de": "Drei schöne Tage in Spanien",
  • "name_nl": "Drie heerlijke dagen in Spanje",
  • "name_ca": "Tres dies preciosos a Espanya",
  • "name_pt": "Três dias agradáveis em Espanha",
  • "short_description_en": "Three lovely days in Spain, to understand their culture",
  • "short_description_fr": "Trois belles journées en Espagne, pour comprendre leur culture",
  • "short_description_es": "Tres días maravillosos en España, para comprender su cultura",
  • "short_description_it": "Tre bellissimi giorni in Spagna, per comprendere la loro cultura",
  • "short_description_de": "Drei schöne Tage in Spanien, um ihre Kultur zu verstehen",
  • "short_description_nl": "Drie heerlijke dagen in Spanje, om hun cultuur te begrijpen",
  • "short_description_ca": "Tres dies encantadors a Espanya, per entendre la seva cultura",
  • "short_description_pt": "Três dias agradáveis em Espanha, para compreender a sua cultura",
  • "long_description_en": "Three lovely days in Spain, to understand their culture (...)",
  • "long_description_fr": "Trois belles journées en Espagne, pour comprendre leur culture (...)",
  • "long_description_es": "Tres días maravillosos en España, para comprender su cultura (...)",
  • "long_description_it": "Tre bellissimi giorni in Spagna, per comprendere la loro cultura (...)",
  • "long_description_de": "Drei schöne Tage in Spanien, um ihre Kultur zu verstehen (...)",
  • "long_description_nl": "Drie heerlijke dagen in Spanje, om hun cultuur te begrijpen (...)",
  • "long_description_ca": "Tres dies encantadors a Espanya, per entendre la seva cultura (...)",
  • "long_description_pt": "Três dias agradáveis em Espanha, para compreender a sua cultura (...)",
  • "creation_date": "2022-06-16 12:00:0.000000+00:00",
  • "is_active": true,
  • "is_highlight": false,
  • "price": 100,
  • "weight": 50,
  • "price_scope": 4,
  • "max_usages": 2,
  • "max_days_after_first_usage": 2,
  • "nb_mpo_orders": 2,
  • "marketplace": 1,
  • "price_range": {
    },
  • "images": [],
  • "allowed_partners": [
    ],
  • "products": [
    ]
}

Get all offers related to a box

Get all offers related to a box

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the box

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find a network voucher by its code

Returns a single network voucher

Authorizations:
ApiKey
path Parameters
code
required
string

Code of the network voucher to return

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "uuid": "123e4567-e89b-12d3-a456-426614174000",
  • "code": "NVb77qadh",
  • "status": "paid",
  • "creation_date": "2022-06-16 12:00:0.000000+00:00",
  • "expiration_date": "2024-06-16 12:00:0.000000+00:00",
  • "max_usages": 2,
  • "usage_count": 1,
  • "pdf_url": "http://storage-url.com/file.pdf",
  • "box": 1,
  • "box_name": "Discovery Box",
  • "box_price": 100,
  • "is_box_active": true,
  • "description": "Enjoy a dinner for two by the sea. Includes: a 3 courses menu and a bottle of wine.",
  • "short_description": "Enjoy a dinner for two by the sea.",
  • "universes": [
    ],
  • "tags": [
    ],
  • "images": []
}

Find network vouchers by email

Returns a list of network vouchers

Authorizations:
ApiKey
path Parameters
email
required
string

The Network Voucher gifter or giftee email.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Network voucher usages

Everything about network voucher usages

Get all usages related to a network voucher

Returns all network voucher's usages

Authorizations:
ApiKey
path Parameters
code
required
string

Code of network voucher

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "creation_date": "2022-06-16 12:00:0.000000+00:00",
  • "network_voucher": 1,
  • "partner": 1,
  • "partner_agency_name": "Test partner name",
  • "partner_source_id": 111,
  • "is_active": true,
  • "comment": "This usage was created via API",
  • "management_fees": 5,
  • "commission_rate": 10
}

Partners

Everything about partners

Create a new partner

Authorizations:
ApiKey
Request Body schema: application/json
required

Partner that will be created

status
required
string
Enum: "a" "i" "t"

Status of the partner:

  • a: Active
  • i: Inactive
  • t: Test
name
string
commercial_name
required
string
short_name
required
string
company_type
string
Enum: "bus" "ind" "sol" "org"

Partner's company type:

  • bus: Business
  • sol: Soletrader
  • org: Organization
siret_number
string
legal_representative_first_name
string
legal_representative_last_name
string
legal_representative_birthday
string

Birth date of the legal representative

hq_address_line_1
string
hq_address_line_2
string
hq_postal_code
string
hq_city
string
hq_country
string
rcs
string
ape
string
vat_id
string
agency_email
required
string <email>
agency_phone
string
website
string <uri>
payout_frequency
string
Enum: "week" "month"

Pay-out frequency:

  • week: Once a week
  • month: Once a month
auto_validate_payout
boolean

Whether the pay-outs should be validated automatically, or not

freeze_payout
boolean

Whether the partner should be able to set 'freeze pay-out' feature. 'Freeze pay-out' allows to take into account a specific date set on transactions, so they are taken into account on that value instead of its creation date.

block_payout_validation
boolean

Whether the pay-outs should be blocked from validation, or not

iban
string

IBAN of partner's bank account

bic
string

BIC of partner's bank account

Responses

Request samples

Content type
application/json
{
  • "status": "a",
  • "name": "Partner #1",
  • "commercial_name": "Partner #1 commercial name",
  • "short_name": "partner1",
  • "company_type": "bus",
  • "siret_number": "123456789",
  • "legal_representative_first_name": "Representative's first name",
  • "legal_representative_last_name": "Representative's last name",
  • "legal_representative_birthday": "2022-05-01",
  • "hq_address_line_1": "Address line #1",
  • "hq_address_line_2": "Address line #2",
  • "hq_postal_code": "75000",
  • "hq_city": "Paris",
  • "hq_country": "FR",
  • "rcs": "",
  • "ape": "",
  • "vat_id": "",
  • "agency_email": "partner1@mybeezbox.com",
  • "agency_phone": "987654321",
  • "website": "https://www.mybeezbox.com",
  • "payout_frequency": "week",
  • "auto_validate_payout": true,
  • "freeze_payout": true,
  • "block_payout_validation": true,
  • "iban": "FR2212739000304675471929G68",
  • "bic": "BNPAESMS"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "status": "a",
  • "name": "Partner #1",
  • "commercial_name": "Partner #1 commercial name",
  • "short_name": "partner1",
  • "company_type": "bus",
  • "siret_number": "123456789",
  • "legal_representative_first_name": "Representative's first name",
  • "legal_representative_last_name": "Representative's last name",
  • "legal_representative_birthday": "2022-05-01T12:00:00+02:00",
  • "hq_address_line_1": "Address line #1",
  • "hq_address_line_2": "Address line #2",
  • "hq_postal_code": "75000",
  • "hq_city": "Paris",
  • "hq_country": "FR",
  • "rcs": "",
  • "ape": "",
  • "vat_id": "",
  • "agency_email": "partner1@mybeezbox.com",
  • "agency_phone": "987654321",
  • "website": "https://www.mybeezbox.com"
}

Create a new network partner

Authorizations:
ApiKey
Request Body schema: application/json
required

Partner that will be created

name
required
string
commercial_name
required
string
short_name
required
string
company_type
string
Enum: "bus" "ind" "sol" "org"

Partner's company type:

  • bus: Business
  • sol: Soletrader
  • org: Organization
siret_number
required
string
legal_representative_first_name
required
string
legal_representative_last_name
required
string
legal_representative_birthday
string

Birth date of the legal representative

hq_address_line_1
required
string
hq_address_line_2
string
hq_postal_code
required
string <= 10 characters
hq_city
required
string
hq_country
required
string
rcs
required
string
ape
required
string
vat_id
required
string
agency_email
required
string <email>
agency_phone
string
website
required
string <uri>
link_to_nv_settings
boolean

A flag to link network partner to the Marketplace's NetworkVouchers Settings

link_to_ngc_settings
boolean

A flag to link network partner to the Marketplace's NetworkGiftcards Settings

Array of objects (PartnerTag)

An array of Partner tags

Responses

Request samples

Content type
application/json
{
  • "name": "Partner #1",
  • "commercial_name": "Partner #1 commercial name",
  • "short_name": "partner1",
  • "company_type": "bus",
  • "siret_number": "123456789",
  • "legal_representative_first_name": "Representative's first name",
  • "legal_representative_last_name": "Representative's last name",
  • "legal_representative_birthday": "2022-05-01",
  • "hq_address_line_1": "Address line #1",
  • "hq_address_line_2": "Address line #2",
  • "hq_postal_code": "75000",
  • "hq_city": "Paris",
  • "hq_country": "FR",
  • "rcs": "",
  • "ape": "",
  • "vat_id": "",
  • "agency_email": "partner1@mybeezbox.com",
  • "agency_phone": "987654321",
  • "website": "https://www.mybeezbox.com",
  • "link_to_nv_settings": true,
  • "link_to_ngc_settings": true,
  • "partner_tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "status": "n",
  • "name": "Partner #1",
  • "commercial_name": "Partner #1 commercial name",
  • "short_name": "partner1",
  • "company_type": "bus",
  • "siret_number": "123456789",
  • "legal_representative_first_name": "Representative's first name",
  • "legal_representative_last_name": "Representative's last name",
  • "legal_representative_birthday": "2022-05-01T12:00:00+02:00",
  • "hq_address_line_1": "Address line #1",
  • "hq_address_line_2": "Address line #2",
  • "hq_postal_code": "75000",
  • "hq_city": "Paris",
  • "hq_country": "FR",
  • "rcs": "",
  • "ape": "",
  • "vat_id": "",
  • "agency_email": "partner1@mybeezbox.com",
  • "agency_phone": "987654321",
  • "website": "https://www.mybeezbox.com",
  • "source_id": "sourceID",
  • "link_to_nv_settings": true,
  • "link_to_ngc_settings": false,
  • "partner_tags": [
    ]
}

Update a network partner

Authorizations:
ApiKey
Request Body schema: application/json
required

Partner that will be updated

source_id
required
string

Source ID of the partner. Can be omitted if siret_number is provided.

siret_number
required
string

SIRET number of the partner. Can be omitted if source_id is provided.

status
string
Enum: "i" "n"

Status of the partner, either inactive or network partner.

link_to_nv_settings
boolean

Indicates whether the partner should be linked to NV settings.

link_to_ngc_settings
boolean

Indicates whether the partner should be linked to NGC settings.

Responses

Request samples

Content type
application/json
{
  • "source_id": "12345",
  • "siret_number": "12345678901234",
  • "status": "n",
  • "link_to_nv_settings": true,
  • "link_to_ngc_settings": false
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "status": "i",
  • "name": "string",
  • "linked_to_nv_settings": true,
  • "linked_to_ngc_settings": true
}

Check partner by company number

Check if a partner has been created on MyBeezBox, thanks to its company number.

Authorizations:
ApiKey
query Parameters
siret_number
string
Example: siret_number=123456789

The SIRET number of the partner, that will be used to search by

commercial_name
string
Example: commercial_name=Partner #1

The commercial name of the partner, that will be used to search by

Responses

Response samples

Content type
application/json
{
  • "id": 1
}

Push KYC document for a specific partner

Authorizations:
ApiKey
Request Body schema: multipart/form-data
required
file
required
string <binary>

The file to push

partner_uuid
required
string <uuid>

The UUID of the partner, related to this KYC document

comment
required
string

A custom comment, about the document

document_type
required
string
Enum: "IDENTITY_PROOF" "REGISTRATION_PROOF" "ARTICLES_OF_ASSOCIATION" "SHAREHOLDER_DECLARATION" "ADDRESS_PROOF"

Type of the document

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5c-422d-9a6b-2fc636e89b45",
  • "comment": "A comment about the document",
  • "document_type": "IDENTITY_PROOF"
}

Payment Hub - Payments

Everything about Payment Hub's payments

Create a new payment

Authorizations:
ApiKey
Request Body schema: application/json
required

Payment that will be created

required
object (Customer)

A person that can buy or receive a gift

partner_uuid
required
string <uuid>

The UUID of the partner related to the payment

amount
required
number <float>

The amount of the payment

discount
required
number <float>

The discount of the payment

product
required
string

Product type related to this payment. It will allow us to process specific fee rules for this payment in specific.

type
required
string
Value: "credit_card"

Type of the payment

origin
string

Origin of the purchase. For example: if it comes from a marketplace, this field allows to trigger specific fee rules.

payment_receipt_description
string

Text that will be used as description, when creating the payment receipt

freeze_payout_date
string

Date/time that will be used to take into account this payment in the payout request. So instead of using the "creation date", we use this field:

  • Creation date: 01/01/2022
  • Freeze payout date: 01/05/2022

The payout request from May 2022 will include this usage, instead of the payout of January 2022.

extra_source_wallet_uuid
string <uuid>

UUID of the wallet where we should take money from (when using a voucher/giftcard as a payment method). Field required if extra_source_amount is given.

extra_source_amount
number <float>

Amount that we should take from the wallet specified in the previous field (when using a voucher/giftcard as a payment method). Field required if extra_source_wallet_uuid is given.

Responses

Request samples

Content type
application/json
{
  • "customer": {
    },
  • "partner_uuid": "015862e4-46f4-4230-90e5-3d92607133af",
  • "amount": 100,
  • "discount": 0,
  • "product": "product_type",
  • "type": "credit_card",
  • "origin": "marketplace1",
  • "payment_receipt_description": "Payment created via API",
  • "freeze_payout_date": "2022-05-01",
  • "extra_source_wallet_uuid": "4a49db15-33ce-4e21-97b6-73776a0fbac4",
  • "extra_source_amount": 50
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "customer": {
    },
  • "partner_uuid": "015862e4-46f4-4230-90e5-3d92607133af",
  • "partner": 1,
  • "amount": 100,
  • "discount": 0,
  • "product": "product_type",
  • "type": "credit_card",
  • "origin": "marketplace1",
  • "payment_receipt_description": "Payment created via API",
  • "freeze_payout_date": "2022-05-01T12:00:00+02:00"
}

Update a payment

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

ID of payment

Request Body schema: application/json
required

Payment that will be updated

freeze_payout_date
required
string

Date/time that will be used to take into account this payment in the payout request. So instead of using the "creation date", we use this field:

  • Creation date: 01/01/2022
  • Freeze payout date: 01/05/2022

The payout request from May 2022 will include this usage, instead of the payout of January 2022.

Responses

Request samples

Content type
application/json
{
  • "freeze_payout_date": "2022-05-01"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "freeze_payout_date": "2022-05-01"
}

Get all payments

Get all payments

Authorizations:
ApiKey
query Parameters
created_on__gte
string
Example: created_on__gte=2023-01-01

The creation date that should be used as a filter (greater or equal than "creation date")

created_on__lte
string
Example: created_on__lte=2023-12-12

The creation date that should be used as a filter (less or equal than "creation date")

partner_uuid
string
Example: partner_uuid=baf5a0f2-4b5b-422d-9a1b-2fc636e89b45

The UUID of the partner that should be used as a filter

status
string
Example: status=ok

The payment status that should be used as a filter

payout_request_status
string
Example: payout_request_status=validated

The payout request status that should be used as a filter

status__in
string
Example: status__in=ok,ip

The payment statuses that should be used as a filter.

payout_request_status__in
string
Example: payout_request_status__in=validated,to be validated

The payout request statuses that should be used as a filter.

customer_first_name
string
Example: customer_first_name=John

The first name of the customer that should be used as a filter (case insensitive).

customer_last_name
string
Example: customer_last_name=Doe

The last name of the customer that should be used as a filter (case insensitive).

customer_email
string
Example: customer_email=JohnDoe@mybeezbox.com

The email of the customer that should be used as a filter (case insensitive).

partially_refunded
boolean
Example: partially_refunded=true

If true, the endpoint returns only payments with a partial refund.

fully_refunded
boolean
Example: fully_refunded=true

If true, the endpoint returns only payments with a full refund.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find payment by its ID

Returns a single payment

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

ID of payment

Responses

Response samples

Content type
application/json
{
  • "id": "7a82448d-e8a3-4049-8e88-2c8186c3076f",
  • "status": "ok",
  • "currency": "EUR",
  • "payment_receipt_pdf_file": "https://demo.bonkdo.com/media/paymentreceipt_pdfs/partner-20230315-8a3416b0-e14a-4f0a-a3cd-b3435f3a4fd1.pdf",
  • "customer": {
    },
  • "payout_request_id": 1,
  • "payout_request_status": "validated",
  • "payout_request_creation_date": "2022-06-16 12:00:0.000000+00:00",
  • "payout_request_validation_date": "2022-06-16 12:00:0.000000+00:00",
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "amount": 100,
  • "commission": 5,
  • "net_amount": 95,
  • "refunded_amount": 10,
  • "type": "credit_card",
  • "extra_source_amount": 100,
  • "extra_source_wallet": 1,
  • "extra_source_wallet_uuid": "a1b2c3d4-e5f6-4789-9012-34567890abcd",
  • "payin_result_code": "12345",
  • "payin_result_message": "The transaction was successful",
  • "payment_request_id": 1
}

Refund a payment by its ID

When performing a refund for certain payment, payment status won't change. If the refund was successful, a new "refund" transaction will be created, linked to this same payment. You can partially refund a payment, by providing a body with the value amount being the amount to refund.

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

ID of payment

Request Body schema: application/json
required
amount
required
number <float>

Amount should be greater than zero

object

The sum of extra_source_amount and additional_payin_amount should be equal to amount. This allows to perform partial refunds explicitly, instead of creating a proportional refund over all sources (if multiple sources of money are used, such as extra source wallets).

Responses

Request samples

Content type
application/json
{
  • "amount": 10,
  • "split": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "detail": "The refund was performed successfully"
}

Get all transactions linked to a payment

Returns all transations for a given payment

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

ID of payment

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Payment Hub - Payout requests

Everything about Payment Hub's payout requests

Get all payout requests

Get all payout requests

Authorizations:
ApiKey
query Parameters
creation_date__gte
string
Example: creation_date__gte=2023-01-01

The creation date that should be used as a filter (greater or equal than "creation date")

creation_date__lte
string
Example: creation_date__lte=2023-12-12

The creation date that should be used as a filter (less or equal than "creation date")

status
string
Example: status=validated

The status of the payout request that should be used as a filter

partner_uuid
string
Example: partner_uuid=baf5a0f2-4b5b-422d-9a1b-2fc636e89b45

The UUID of the partner that should be used as a filter

has_validated_kyc
boolean
Example: has_validated_kyc=true

Filter on objects with validated (not validated) KYC

has_blocked_payout_validation
boolean
Example: has_blocked_payout_validation=false

Filter on objects with blocked payout validation

Responses

Response samples

Content type
application/json
[]

Find payout request by its ID

Returns a single payout request

Authorizations:
ApiKey
path Parameters
id
required
integer

ID of payout request

Responses

Response samples

Content type
application/json
{}

Get all payments related to a payout request

Get all payments related to a payout request

Authorizations:
ApiKey
path Parameters
id
required
integer

ID of payout request

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Validate a payout request

Authorizations:
ApiKey
path Parameters
id
required
integer

ID of payout request

Responses

Response samples

Content type
application/json
[]

Cancel a payout request

Authorizations:
ApiKey
path Parameters
id
required
integer

ID of payout request

Responses

Response samples

Content type
application/json
[]

Get PDF file from a payout request

Gets the PDF file from a payout request. PDF files are not generated automatically so they are generated on demand, only once. As soon as it's generated after calling this endpoint, it will be included in the list/detail endpoints too.

Authorizations:
ApiKey
path Parameters
id
required
integer

ID of payout request

Responses

Get XLS file from a payout request

Gets the XLS file from a payout request. XLS files are not generated automatically so they are generated on demand, only once. As soon as it's generated after calling this endpoint, it will be included in the list/detail endpoints too.

Authorizations:
ApiKey
path Parameters
id
required
integer

ID of payout request

Responses

Payment Hub - Invoices

Everything about Payment Hub's invoices

Get all invoices

Get all invoices

Authorizations:
ApiKey
query Parameters
invoicing_date__gte
string
Example: invoicing_date__gte=2023-01-01

The invoicing date that should be used as a filter (greater or equal than "invoicing date")

invoicing_date__lte
string
Example: invoicing_date__lte=2023-12-12

The invoicing date that should be used as a filter (less or equal than "invoicing date")

partner_customer
integer
Example: partner_customer=1

The ID of the partner that should be used as a filter

partner_uuid
string
Example: partner_uuid=baf5a0f2-4b5b-422d-9a1b-2fc636e89b45

The UUID of the partner that should be used as a filter

Responses

Response samples

Content type
application/json
[]

Find invoice by its ID

Returns a single invoice

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

ID of invoice

Responses

Response samples

Content type
application/json
{}

Get all payments related to a invoice

Get all payments related to a invoice

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

ID of invoice

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Payment Hub - KYC

Everything about Payment Hub's KYC levels

Check partner KYC level

Check if KYC has been validated for a partner thanks to its ID on MyBeezBox.

Authorizations:
ApiKey
path Parameters
uuid
required
string

UUID of the partner

Responses

Response samples

Content type
application/json
{
  • "status": "error",
  • "detail": "KYC has not been validated for this partner",
  • "partner": 1,
  • "partner_uuid": "baf5a0f2-4b5c-422d-9a6b-2fc636e89b45",
  • "errors": [
    ]
}

Payment Hub - Wallets

Everything about Payment Hub's wallets

Check wallet's balance by UUID

Authorizations:
ApiKey
path Parameters
partner_uuid
required
string <uuid>

Partner UUID for the linked wallet

Responses

Response samples

Content type
application/json
{
  • "amount": 100
}

Get wallet's transfers by UUID

Authorizations:
ApiKey
path Parameters
uuid
required
string <uuid>

UUID of the wallet

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Multi-product orders

Everything about multi-product orders and funnel

Create a new multi-product cart

Authorizations:
ApiKey
Request Body schema: application/json
required

Cart that will be created

partner_uuid
required
string <uuid>

The UUID of the partner/marketplace related to the cart

required
object

Responses

Request samples

Content type
application/json
{
  • "partner_uuid": "015862e4-46f4-4230-90e5-3d92607133af",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "partner_uuid": "015862e4-46f4-4230-90e5-3d92607133af",
  • "data": {
    }
}

Payment requests

Everything about payment requests

Create a new payment request

Request Body schema: application/json
required

Payment that will be created

partner_uuid
required
string <uuid>

The UUID of the partner

amount
required
number <float>
required
object (Customer)

A person that can buy or receive a gift

language
required
string

Language of the payment request (used on payment page)

reference
string

Reference of the payment request

description
text

Description of the payment request

origin
string

Origin of the purchase. For example: if it comes from a marketplace, this field allows to trigger specific fee rules.

product
string

Product type related to this payment request. It will allow us to process specific fee rules for this payment request in specific.

Responses

Request samples

Content type
application/json
{
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "amount": 100,
  • "customer": {
    },
  • "language": "en",
  • "reference": "Reference #1",
  • "description": "Bigger description of this payment request",
  • "origin": "marketplace1",
  • "product": "product_type"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "code": "PRasdf1234",
  • "status": "paid",
  • "amount": 100,
  • "created_on": "2022-06-16 12:00:0.000000+00:00",
  • "modified_on": "2022-06-16 12:00:0.000000+00:00",
  • "reference": "Reference #1",
  • "description": "Bigger description of this payment request",
  • "customer": {
    },
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "origin": "marketplace1",
  • "product": "product_type"
}

Get all payment requests

Authorizations:
ApiKey
query Parameters
search
string
Example: search=reference1234

The value that should be used to search in the payment requests (by reference, description, etc.)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get payment request by its ID

Returns a single payment request

Authorizations:
ApiKey
path Parameters
id
required
int <int64>

ID of the payment request

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "code": "PRasdf1234",
  • "status": "paid",
  • "amount": 100,
  • "created_on": "2022-06-16 12:00:0.000000+00:00",
  • "modified_on": "2022-06-16 12:00:0.000000+00:00",
  • "reference": "Reference #1",
  • "description": "Bigger description of this payment request",
  • "customer": {
    },
  • "partner_uuid": "baf5a0f2-4b5b-422d-9a1b-2fc636e89b45",
  • "origin": "marketplace1",
  • "product": "product_type"
}

Get all payments related to a payment request

Get all payments related to a payment request

Authorizations:
ApiKey
path Parameters
id
required
integer <int64>

ID of payment request

Responses

Response samples

Content type
application/json
[
  • {
    }
]