Skip to main content

Create a new account

POST 
/accounts

Create a new account

Request​

Header Parameters

    sub-account stringrequired

    Sub-account identifier required for all requests

Body

required

    siret stringrequired

    The SIRET number of the account (only valid SIRET numbers are accepted).

    notification_email stringrequired

    Notification email for the account, will get notified for each successful payment.

    subscription_type string

    Possible values: [ribpay_classic, ribpay_plus]

    Default value: ribpay_classic

    Type of subscription for the terminal that will be created.

Responses​

Account successfully created.

Schema

    account

    object

    required

    account_id uuidrequired

    Unique identifier for the account.

    account_last_modified stringrequired

    Timestamp for the account creation.

    account_national_id stringrequired

    Siret number of the account.

    account_name stringrequired

    Name of the account. Defined by the SIRET number.

    account_type stringrequired

    Possible values: [personneMorale, personnePhysique]

    Type of the account.

    account_is_active booleanrequired

    Status of the account. For more infos see /validate

    account_deletion_date stringrequired

    Timestamp for the account deletion.

    account_created_at stringrequired

    Timestamp for the account creation.

    account_currency stringrequired

    Currency of the account. Only EUR supported for now.

    account_notification_email stringrequired

    Notification email for the account, will get notified for each successful payment.

    account_creation_url stringrequired

    URL for account activation. For more infos see /validate

    account_blob_storage_url stringrequired

    URl for blob storage. For more infos see /validate/pm

    partner_id uuidrequired

    Partner id of the account.

    creator_id uuidrequired

    ID of the creator of the account

    billing_address

    object

    required

    billing_address_id stringrequired

    Unique identifier for the billing address.

    billing_address stringrequired

    Full billing address.

    billing_address_numero_voie stringrequired

    Street number.

    billing_address_indice_repetition stringrequired

    Street number suffix.

    billing_address_type_voie stringrequired

    Type of street.

    billing_address_libelle_voie stringrequired

    Street name.

    billing_address_complement_localisation stringrequired

    Complement address.

    billing_address_code_postal stringrequired

    Postal code.

    billing_address_libelle_commune stringrequired

    City name.

    billing_address_distribution_speciale stringrequired

    Special delivery.

    billing_address_pays stringrequired

    Country name.

    billing_address_code_pays stringrequired

    Country code.

    billing_address_last_modified stringrequired

    Last update date.

    account_id stringrequired

    Unique identifier for the account.

    creator_id stringrequired

    Unique identifier for the creator.

    terminal

    object

    terminal_id uuidrequired

    Unique identifier for the terminal.

    terminal_label stringrequired

    Label/name of the terminal.

    terminal_favorite_contract_type stringrequired

    Type of contract to be shown first.

    terminal_subscription_type stringrequired

    Type of subscription for the terminal.

    terminal_last_modified stringrequired

    Date the terminal was modified.

    account_id uuidrequired

    Unique identifier for the account.

    terminal_subscription_id uuidrequired

    Unique identifier for the subscription.

    creator_id uuidrequired

    Unique identifier for the creator.

    user

    object

    user_id uuidrequired

    Unique identifier for the user created. Is the only user of the account with "admin" role.

    user_role stringrequired

    Possible values: [admin, user]

    Role of the user

    creator_id uuidrequired

    Identifier of the user who created this user profile

Loading...