NAV Navbar
Test Environment

General information

Getting Started

Base URLs

API

Connect

Errors

The manager.one API throw an exception when a request fails.

The exception contains a HTTP response code that indicates the type of error.

Forbidden http exception

{
  "name": "Forbidden",
  "message": "string",
  "code": 0,
  "status": 403,
  "type": "yii\web\ForbiddenHttpException"
}
Name Type
name Forbidden
message string
code integer
status 403
type yii\web\ForbiddenHttpException

Unauthorized http exception

{
  "name": "Unauthorized",
  "message": "string",
  "code": 0,
  "status": 401,
  "type": "yii\web\UnauthorizedHttpException"
}
Name Type
name Unauthorized
message string
code integer
status 401
type yii\web\UnauthorizedHttpException

Not Found http exception

{
  "name": "Not Found",
  "message": "string",
  "code": 0,
  "status": 404,
  "type": "yii\web\NotFoundHttpException"
}
Name Type
name Not Found
message string
code integer
status 404
type yii\web\NotFoundHttpException

Server Error http exception

{
  "name": "Internal Server Error",
  "message": "string",
  "code": 0,
  "status": 500,
  "type": "yii\\web\ServerErrorHttpException"
}
Name Type
name Internal Server Error
message string
code integer
status 500
type yii\web\ServerErrorHttpException

Bad Request http exception

{
  "name": "Bad Request",
  "message": "string",
  "code": 0,
  "status": 400,
  "type": "yii\web\BadRequestHttpException"
}
Name Type
name string
message string
code integer
status 400
type yii\web\BadRequestHttpException

Fields Validation errors

[
  {
    "field": "string",
    "message": "string"
  },
  {..}
]

This error is returned when there are errors on model attributes in the request.

The code HTTP returned is 422 Data Validation Failed

Name Type Description
field string Name of the attribute
message string Message of the error

Nested model Fields Validation errors

[
  {
    "field": "string",
    "errors": [
      {
          "field": "string",
          "message": "string"
      },
      {..}
    ]
  }
]

This error is returned when there are errors on a model nested in another one (ex: address of a user).

The code HTTP returned is 422 Data Validation Failed

Name Type Description
field string Name of the nested model
errors Array of fields validation errors Errors on the nested model

Model array Fields Validation errors

[
  [ 
    {
      "field": "string",
      "index": 0,
      "errors": [
        {
            "field": "string",
            "message": "string"
        },
        {..}
      ]
    },
    {..}
  ]
]

This error is returned when there are errors on models in an array.

The code HTTP returned is 422 Data Validation Failed

Name Type Description
field string Name of the nested model
index integer Index of the model in the array, start at 0
errors Array of fields validation errors Errors on the nested model

Pagination

All "list" endpoints use the same pagination system.

For instance, you can use this system with list of operations, list of transfers, of list of beneficiaries.

All the information about pagination are returned in the header of the response

Request

GET https://connect.recette.manager.one/XXXX?page=1

Example header response

  X-Pagination-Total-Count: 8
  X-Pagination-Page-Count: 1
  X-Pagination-Current-Page: 1
  X-Pagination-Per-Page: 50

URL Parameters

Parameter In Type Required Description
page query integer false Page number

Change log

v1.1.0 - 07/10/2019

v1.0.2 - 06/09/2019

v1.0.1 - 25/02/2019

Authentification

The manager.one API uses OAuth 2.0 to connect a manager.one account to your service.

More info about OAuth 2.0 :

https://www.oauth.com

Get a code

The first step of the OAuth 2.0 process is to get a code to connect an account to your service.

Redirect the user to the authorization form

Code samples

GET https://connect.recette.manager.one?response_type=string&client_id=string&redirect_uri=string&slate=string

GET https://connect.recette.manager.one

URL Parameters

Parameter In Type Required Description
response_type query string true type of response expected: "code"
client_id query string true client_id of your service
redirect_uri query string true url callback of your service
state query string false string value used to maintain state between the request and the callback


On the authorization form, the user has to loggin with his manager.one account.

alt text

Then, he chooses the account to connect with your service.

alt text

And he authorizes your service.

alt text

Once he approves the connection, he will be redirected to your redirect_uri url.

Example response

OK

> www.your-redirect_uri.com?code=string&state=the_state_sent_in_the_initial_request

Errors

> www.your-redirect_uri.com?error=response_type;state;redirect_uri

Access denied

> www.your-redirect_uri.com?error=access_denied

Response

Redirect the user to your redirect_uir with the code and the state.

Errors

Error Response
Invalid client_id or redirect_uri Displays a message 'Service not found' to the user
Others parameters are invalid The server will redirect the user to the redirect_uri with invalid fields in query parameters
The user denied the access The server will redirect the user to the redirect_uri with error=access_denied in query parameters

Get a token for the API

Once you get the code, you can exchange it for an access token. You can also get a new token from a refresh token with this endpoint.

The refresh token is useful when the token is expired, you can get a new one by using this endpoint with the refresh token as a code.

Code samples

curl -X POST https://api-stg.manager.one/oauth/token \

Body parameter

{
  "client_id": "string",
  "client_secret": "string",
  "grant_code": "string",
  "code": "string"
}

Request

POST /oauth/token

Parameters

Parameter In Type Required Description
client_id query string true The client_id of the service
client_secret query string true The client_secret of the service
grant_type query string true The type of grant code requested
code query string true, when the grant_type is "code" The code retrieved
refresh_token query string true, when the grant_type is "refresh_token" The refresh token

Enumerated Values

Parameter Value
grant_type authorization_code
grant_type refresh_token

Example response:

200

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "refresh_token": "1uJROUJWGoaQGuSbD4Cd_J6tditdDFccy7eOY2w5"
}

Response

Status Code 200

Name Type Description Validity
access_token string Access token 1 hour
refresh_token string Token used to ask a new access token when it expired 7 days

Errors

Status Meaning Description Schema
401 Unauthorized Unauthorized UnauthorizedHttpException
403 Forbidden Invalid clientwill be redirectedid ForbiddenHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error, could not get the code ServerErrorHttpException

Account

Get account

Code samples

curl -X GET https://api-stg.manager.one/accounts \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Get the account logged.

Request

GET /accounts

Example response

200

[
  {
       "id" : 
       "label": "string",
       "balance": "float",
       "currency": "string",
       "company_name": "string",
       "validation_details": {
          "beneficiary": "simple",
          "transfer": "none"
       },
       "owner": {
         "gender_label": "string",
         "first_name": "string",
         "last_name": "string"
       },
       "rib": {
         "iban": "string",
         "bic": "string",
         "bank": "string",
         "branch": "string",
         "number": "string",
         "checksum": "string",
         "establishment": "Wormser Frères Haussmann",
         "pdf_url": "string",
       }
     }
]

Response

Status Code 200 OK

Array of accounts

Name Type Description
label string Account label
balance float Account balance
currency string Account currency
company_name string Company name of the account
validation_details Validation Details Double authentication options on the account
validation_details.global string Type of validation to perform on secure operations (beneficiary or transfer). Applied only if the validation is not set on the operation
validation_details.beneficiary string Type of validation required to perform an operation on beneficiaries. This param has priority over global
validation_details.transfer string Type of validation required to perform an operation on transfers. This param has priority over global
owner Owner Owner of the account
owner.gender_label string Gender of the owner
owner.first_name string First name of the owner
owner.last_name string Gender of the owner
rib Rib RIB of the account
rib.iban string IBAN of the account
rib.bic string Bic code
rib.bank string Bank Code
rib.branch string Sort Code
rib.number string Account number
rib.checksum string RIB Key
rib.establishment string Bank name
rib.pdf_url string Url to download the RIB

Enumerated Values

Parameter Value Description
validation_details.* none no validation required
validation_details.* simple double auth with mobile app
validation_details.* full double auth with mobile app and facial recognition
owner.gender_label Monsieur -
owner.gender_label Madame -
owner.gender_label Madame, Monsieur -
currency EUR Euro
currency USD Dollar
currency GBP Pound

Operation

List of operations

Code samples

curl -X GET https://api-stg.manager.one/operations \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Get the account operations. You can search with free text through the 'search' parameter.

Request

GET /operations

Parameters

Parameter In Type Required Description
search query string false Text to search
type query string false credit/debit filter
category query string false kind of operation
attachment query integer(int32) false if set filter result by attachment: 1:operation with any attachment, 0:without any attachment
card query string false kind of operation
from query string(date) false From date (eq: 2017-01-01)
to query string(date) false To date (eq: 2017-01-31)
min query number(float) false Minimum amount to filter on
max query number(float) false Maximum amount to filter on
afb_code query integer false Afb code of the operation, works only if category and type parameters are not used

Enumerated Values

Parameter Values
type credit
type debit
category deposit_cash
category deposit_check
category fees
category other
category payment_check
category credit_card
category redraw_atm
category refund
category prelevement
card true
card false

Example response

200 Response

[
  {
    "id": 1,
    "created_at": 1567692972,
    "executed_at": 1567693673,
    "status": "string",
    "label": "string",
    "type": "string",
    "category": "string",
    "category_label": "string",
    "afbCode": 1,
    "amount": 10,
    "currency": "string",
    "beneficiary": {Beneficiary Object},
    "comment": "string",
    "document": null, // @deprecated, will always return this
    "documents": [
        {
           "updated_at": 12345,
           "filename": "test.zip",
           "mime_type": "test.zip",
           "url": "string"
        },
        {..}
    ],
    "nb_documents": 2,
    "bill": {
        "updated_at": 12345,
        "filename": "test.zip",
        "mime_type": "test.zip",
        "url": "string"
    },
    "detail": {
        "vat": {
            "amount": 0,
            "rate": 0
        },
        "categories": [
         {
            "id": 5,
            "label": "Transport",
            "name": "transport",
            "default": true,
            "card": true,
            "standard": true
         }
        ],
        "guest": null
    },
    "restaurant": false,
    "assignments": [
        {
            "id": 1,
            "label": "project-1"
        },
        {..}
    ], 
    "attributions": [
        {
            "uuid": "72350D0A-504D-435F-B656-FC74DC11E962",
            "first_name": "John",
            "last_name": "Doe",
            "picture": {
              "url": "http://api-stg.manager.one/user/72350D0A-504D-435F-B656-FC74DC11E962/picture",
            }
        },
        {..}
    ] 
  },
  {
    "id": 2,
    "created_at": 1567692972,
    "executed_at": 1567692972,
    "status": "string",
    "label": "string",
    "type": "string",
    "category": "string",
    "category_label": "string",
    "afbCode": 1,
    "amount": 10,
    "currency": "string",
    "beneficiary":{Beneficiary Object},
    "comment": "string",
    "document": {
        "updated_at": 12345,
        "filename": "test.zip",
        "mime_type": "test.zip",
        "url": "string"
    },
    "documents": [
        {
           "updated_at": 12345,
           "filename": "test.zip",
           "mime_type": "test.zip",
           "url": "string"
        },
        {..}
    ],
    "detail": {
        "vat": {
            "amount": 0,
            "rate": 0
        },
        "categories": [
            {
                "id": 5,
                "label": "Transport",
                "name": "transport",
                "default": true,
                "card": true,
                "standard": true
            }
        ],
        "guest": null
    },
    "restaurant": false,
    "assignments": [
        {
            "id": 1,
            "label": "project-1"
        },
        {..}
    ], 
    "attributions": [
        {
            "uuid": "72350D0A-504D-435F-B656-FC74DC11E962",
            "first_name": "John",
            "last_name": "Doe",
            "picture": {
              "url": "http://api-stg.manager.one/user/72350D0A-504D-435F-B656-FC74DC11E962/picture",
            }
        },
        {..}
    ]
  }
}

Response

Status Code 200 OK

Array of operations

Name Type Description
id integer Id of operation
created_at integer Creation date timestamp
executed_at integer Execution date timestamp
status string State of the operation, DONE, CANCELED, PENDING etc..
label string User label
type string D (Debit) / C (Credit)
category string Transfer/Withdraw/SEPA etc..
category_label string Category name translated
afb_code integer Afb code of the operation
amount number(double) Amount of the operation, in cents
currency string EUR/USD etc..
employee_number string Employee_number of the credit card owner
beneficiary Beneficiary -
comment string false
document deprecated Document see documents instead.
documents Document[] Documents linked with the operation (Invoice,...). Multiple documents.
nb_documents integer Count of linked documents
bill Bill (child of Document) Bill linked with the operation (manager.one fees)
detail OperationDetail Details of the operation
detail.vat OperationDetailVat VAT of the operation
detail.vat.amount number(double) VAT amount of the operation, in cents
detail.vat.rate number(double) VAT rate of the operation, in percent
detail.categories array of Category Associated Categories
detail.categories.id integer ID of associated Category
detail.categories.label string Name of the category translated
detail.categories.name string Name of the category
detail.categories.card boolean Category can be applied to a credit card operation
detail.categories.default boolean Category not created by the user
assignments Assignment[] List of assignments of the operation, can be the name of the related project for example
assignments.id integer id of the assignments
assignments.label string Label of the assignments
attributions Attribution[] List of users related to the operation
attributions.uuid string uuid of the user
attributions.first_name string First name of the user
attributions.last_name string Last name of the user
attributions.employee_number string Employee number of the user

Enumerated Values

Parameter Values
category deposit_cash, deposit_check, fees, other, payment_check,credit_card, redraw_atm, refund, prelevement
afb_code 1 (Payment check), 2 (Deposit check), 4 (Deposit cash)
- 5 (Transfer got (credit)), 6 (Transfer send (debit))
- 8 (Automatic debit), 11 (Card operation), 12 (Transfer rejected)
- 29 (Withdrawal), 33 (Fee operation), 91 (Generic Operation)

Detail of an operation

Code samples

curl -X GET https://api-stg.manager.one/operations/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Get all the details of an operation.

Request

GET /operations/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true The operation ID

Example response

200 Response

{
    "id": 0,
    "created_at": 1567692972,
    "executed_at": 1567693673,
    "status": "string",
    "label": "string",
    "type": "string",
    "category": "string",
    "category_label": "string",
    "afbCode": 1,
    "amount": 10,
    "currency": "string",
    "beneficiary": {
        "id": 123,
        "label": "string",
        "short_tag": "GOPR",
        "iban": "FR7630001007941234567890185",
        "account_number_formatted": "FR76 3000 1007 9412 3456 7890 185",
        "bic": "string",
        "is_sepa": true,
        "phone_number": "0033612345678",
        "email": "alex@manager.one",
        "comment": "Somme comment",
        "bank_data": {
            "bic": "BOUSFRPPXXX",
            "bank": "BOURSORAMA",
            "street": "18 QUAI DU POINT DU JOUR",
            "zip": "92659",
            "city": "BOULOGNE BILLANCOURT",
            "state": "ILE-DE-FRANCE",
            "country": "FRANCE",
            "country_iso": "FR",
            "sepa": true
        },
        "address": {
            "street": "48, Rue de la Vielle Ecole",
            "zip": "75116",
            "city": "Paris",
            "country": "France"
        },
        "social_security_number": "123456789"
    },
    "comment": "string",
    "document": null, // @deprecated, will always return this
    "documents": [
        {
           "updated_at": 12345,
           "filename": "test.zip",
           "mime_type": "test.zip",
           "url": "string"
        },
        {..}
    ],
    "nb_documents": 2,
    "bill": {
        "updated_at": 12345,
        "filename": "test.zip",
        "mime_type": "test.zip",
        "url": "string"
    },
    "detail": {
        "vat": {
            "amount": 0,
            "rate": 0
        },
        "categories": [
         {
            "id": 5,
            "label": "Transport",
            "name": "transport",
            "default": true,
            "card": true,
            "standard": true
         }
        ],
        "guest": null
    },
    "restaurant": false,
    "assignments": [
        {
            "id": 1,
            "label": "project-1"
        },
      {..}
    ], 
    "attributions": [
        {
            "uuid": "72350D0A-504D-435F-B656-FC74DC11E962",
            "first_name": "John",
            "last_name": "Doe",
            "picture": {
              "url": "http://api-stg.manager.one/user/72350D0A-504D-435F-B656-FC74DC11E962/picture",
            }
        },
        {..}
    ] 
}

Response

The operation

Status Code 200 OK

Name Type Description
id integer Id of operation
created_at integer Creation date timestamp
executed_at integer Execution date timestamp
status string State of the operation, DONE, CANCELED, PENDING etc..
label string User label
type string D (Debit) / C (Credit)
category string Transfer/Withdraw/SEPA etc..
category_label string Category name translated
afb_code integer Afb code of the operation
amount number(double) Amount of the operation, in cents
currency string EUR/USD etc..
employee_number string Employee_number of the credit card owner
beneficiary Beneficiary -
comment string false
document deprecated Document see documents instead.
documents Document[] Documents linked with the operation (Invoice,...). Multiple documents.
nb_documents integer Count of linked documents
bill Bill (child of Document) Bill linked with the operation (manager.one fees)
detail OperationDetail Details of the operation
detail.vat OperationDetailVat VAT of the operation
detail.vat.amount number(double) VAT amount of the operation, in cents
detail.vat.rate number(double) VAT rate of the operation, in percent
detail.categories array of Category Associated Categories
detail.categories.id integer ID of associated Category
detail.categories.label string Name of the category translated
detail.categories.name string Name of the category
detail.categories.card boolean Category can be applied to a credit card operation
detail.categories.default boolean Category not created by the user
assignments Assignment[] List of assignments of the operation, can be the name of the related project for example
assignments.id integer id of the assignments
assignments.label string Label of the assignments
attributions Attribution[] List of users related to the operation
attributions.uuid string uuid of the user
attributions.first_name string First name of the user
attributions.last_name string Last name of the user
attributions.employee_number string Employee number of the user

Enumerated Values

Parameter Values
category deposit_cash, deposit_check, fees, other, payment_check,credit_card, redraw_atm, refund, prelevement
afb_code 1 (Payment check), 2 (Deposit check), 4 (Deposit cash)
- 5 (Transfer got (credit)), 6 (Transfer send (debit))
- 8 (Automatic debit), 11 (Card operation), 12 (Transfer rejected)
- 29 (Withdrawal), 33 (Fee operation), 91 (Generic Operation)

Errors

Status Meaning Description Schema
404 Not Found The operation doesn't exist NotFoundHttpException

Download the bill attached to an operation

Code samples

curl -X GET https://api-stg.manager.one/operations/{id}/bill \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Download the bill attached to the Operation

Request

GET /operations/{id}/bill

Parameters

Parameter In Type Required Description
id path integer(int32) true The operation ID

Example response

200 Response

Response

The bill

Status Code 200 OK

Errors

Status Meaning Description Schema
404 Not Found The operation or the bill doesn't exist NotFoundHttpException

[DEPRECATED] Download the document attached to an operation

Request

GET /operations/{id}/{documentType}

List the operation documents

Code samples

curl -X GET https://api-stg.manager.one/operations/{id}/documents \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Request

GET /operations/{id}/documents

Parameters

Parameter In Type Required Description
id path integer(int32) true operation id

Example response

200 Response

 {
    "documents": [
       {
          "id",
          "updated_at": 12345,
          "filename": "string",
          "mime_type": "string",
          "url": "string"
       },
       {..}
    ]
 }

Response

List of this document array

Status Code 200 OK

see detailed API fields on Document

Errors

Status Meaning Description Schema
404 Not Found The operation or the file doesn't exist NotFoundHttpException

Download the operation documents

Code samples

curl -X GET https://api-stg.manager.one/operations/{id}/documents/{document} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Download one of them

Request

GET /operations/{id}/documents/{document}

Parameters

Parameter In Type Required Description
id path integer(int32) true operation id
document path integer(int32) true document id

Example response

200 Response

Response

Binary file

Status Code 200 OK

Errors

Status Meaning Description Schema
404 Not Found The operation or the file doesn't exist NotFoundHttpException


Download all of them

Request

GET /operations/{id}/documents/all

Parameters

Parameter In Type Required Description
id path integer(int32) true operation id

Example response

200 Response

Response

ZIP Archive

Status Code 200 OK

Errors

Status Meaning Description Schema
404 Not Found The operation or the file doesn't exist NotFoundHttpException

[DEPRECATED] Attach a file to an operation

Request

POST /operations/{id}/{documentType}

Attach files to operation

Code samples

curl -X POST https://api-stg.manager.one/operations/{id}/documents \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN' \
  -F files[]="@/path/to/a/file.jpg" [, -F files[]="@/path/to/a/file.jpg"]

Request

POST /operations/{id}/documents

Parameters

Parameter In Type Required Description
id path integer(int32) true The transfer ID
files form-data file[] true documents to attach

Example response

201 Response

 {
    "documents": [
       {
          "id",
          "updated_at": 12345,
          "filename": "string",
          "mime_type": "string",
          "url": "string"
       },
       {..}
    ]
 }

Response

List of this document array

Status Code 201 Created

Name Type Description
ID integer ID of the document
updated_at integer Date of update
filename string Filename of the document
mime_type string MIME Type of the file
url string URL to download the file if uploaded

Errors

Status Meaning Description Schema
404 Not Found The operation doesn't exist NotFoundHttpException

[DEPRECATED] Delete the document of an operation

Request

DELETE /operations/{id}/{documentType}

Delete linked documents of operation

Delete one of them

Code samples

curl -X DELETE https://api-stg.manager.one/operations/{id}/documents/{document} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Request

DELETE /operations/{id}/documents/{document}

Parameters

Parameter In Type Required Description
id path integer(int32) true operation id
document path integer(32) true document id

Example response

204 Response

Response

Status Code 204 No Content

Errors

Status Meaning Description Schema
404 Not Found The operation or the document does not exists NotFoundHttpException

Delete all linked documents

Code samples

curl -X DELETE https://api-stg.manager.one/operations/{id}/documents \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Request

DELETE /operations/{id}/documents

Parameters

Parameter In Type Required Description
id path integer(int32) true operation

Example response

204 Response

Response

Status Code 204 No Content

Errors

Status Meaning Description Schema
404 Not Found The operation or the document does not exists NotFoundHttpException

Statement

List of statements

Code samples

curl -X GET https://api-stg.manager.one/statements \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

List of statements with an optional filter by year

Request

GET /statements

Parameters

Parameter In Type Required Description
year query integer(int32) false The year filter

Example response

200 Response

[
  {
    "id": 1,
    "month": 10,
    "year": 2018,
    "eom_balance": 1234567.89,
    "document": {
          "updated_at": 12345,
          "filename": "statement-1.zip",
          "mime_type": "statement-1.zip",
          "url": "string"
        },
    "document_url": "string"
  },
  {
    "id": 2,
    "month": 11,
    "year": 2018,
    "eom_balance": 123000,
    "document": {
          "updated_at": 12345,
          "filename": "statement-1.zip",
          "mime_type": "statement-1.zip",
          "url": "string"
        },
    "document_url": "string"
  }
]

Response

Status Code 200 OK

Array of statements

Name Type Description
id integer Statement ID
month integer Statement month
year integer Statement year
eom_balance number Balance at the end of the month
document Document The statement
document.filename string filename of the document
document.mime_type string MIME Type of the file
document.url string URL to download the file if uploaded
document_url string URL to download document

Download the statement PDF

Code samples

curl -X GET https://api-stg.manager.one/statements/{id}/document \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Download the statement PDF

Request

GET /statements/{id}/document

Parameters

Parameter In Type Required Description
id path integer(int32) true The statement ID

Example response

200 Response

Responses

The statement

Status Code 200 OK

Errors

Status Meaning Description Schema
404 Not Found Not Found NotFoundHttpException

Download multiple statements

Code samples

curl -X GET https://api-stg.manager.one/statements/{id},{id}.../document \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Download multiple statements

Request

GET /statements/{id},{id}.../document

Parameters

Parameter In Type Required Description
id path string true List of statement ID comma separated

Example response

200 Response

Responses

The statements

Status Code 200 OK

Errors

Status Meaning Description Schema
404 Not Found Not Found NotFoundHttpException

Transfer

List of transfers

Code samples

curl -X GET https://api-stg.manager.one/transfers \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

List of transfers

Request

GET /transfers

Parameters

Parameter In Type Required Description
search query string false Text to search
status query string false Status
from query string(date) false From date (eq: 2017-01-01)
to query string(date) false To date (eq: 2017-01-31)
min query number(double) false The minimum amount to looking for
max query number(double) false The maximum amount to looking for
cancelled query boolean false Including cancelled transfers

Example response

200 Response

[
  {
    "amount": 123,
    "beneficiary": {
      "id": 123,
      "label": "string",
      "short_tag": "GOPR",
      "iban": "FR7630001007941234567890185",
      "account_number_formatted": "FR76 3000 1007 9412 3456 7890 185",
      "bic": "string",
      "is_sepa": true,
      "phone_number": "0591731935",
      "email": "alex@manager.one",
      "comment": "string",
      "address": {
        "street": "56, boulevard Louise Maillet",
        "zip": "75002",
        "city": "PARIS 02",
        "country": "FR"
      },
      "social_security_number": "123456789",
      "rib": null,
      "validation": null,
      "bank_data": {
        "bic": "BOUSFRPPXXX",
        "bank": "BOURSORAMA",
        "street": "18 QUAI DU POINT DU JOUR",
        "zip": "92659",
        "city": "BOULOGNE BILLANCOURT",
        "state": "ILE-DE-FRANCE",
        "country": "FRANCE",
        "country_iso": "FR",
        "sepa": true
      }
    },
    "created_at": 1542300827,
    "certificate": {
      "id": 1,
      "updated_at": 1542300829,
      "filename": "transfer-certificate.pdf",
      "mime_type": "application/pdf",
      "url": "string"
    },
    "comment": "string",
    "currency": "EUR",
    "document": null,
    "execution_date": "2018-11-16",
    "id": 1225,
    "fx_amount": null,
    "fx_currency": null,
    "fx_rate": null,
    "fx_fees": null,
    "label": "string",
    "similarTransfers": null,
    "send_notification": false,
    "status": "pending",
    "status_label": "En attente",
    "statusLabel": "En attente",
    "type": "direct",
    "updatable_until": 1542301427,
    "user": null,
    "o_auth_service": {
      "name": "test_service"
    },
    "validated_at": null,
    "validation_token": "389ee29fae55ccda35d5a5c5f412bfb2",
     "account": {
         "uuid": 1,
         "label": "test_account",
         "balance": 10308.63,
         "currency": "EUR",
         "company_name": "test_company",
         "validation_details": {
            "beneficiary": "simple",
            "transfer": "none"
         },
         "owner": {
           "gender_label": "Mr",
           "first_name" : "Jean",
           "last_name": "Dupont"
         }
       }
    },
  {
    "amount": 456,
    "beneficiary": {
      "id": 123,
      "label": "string",
      "short_tag": "GOPR",
      "iban": "FR7630001007941234567890185",
      "account_number_formatted": "FR76 3000 1007 9412 3456 7890 185",
      "bic": "string",
      "is_sepa": true,
      "phone_number": "0591731935",
      "email": "alex@manager.one",
      "comment": "string",
      "address": {
        "street": "56, boulevard Louise Maillet",
        "zip": "75002",
        "city": "PARIS 02",
        "country": "FR"
      },
      "social_security_number": "123456789",
      "rib": null,
      "validation": null,
      "bank_data": {
        "bic": "BOUSFRPPXXX",
        "bank": "BOURSORAMA",
        "street": "18 QUAI DU POINT DU JOUR",
        "zip": "92659",
        "city": "BOULOGNE BILLANCOURT",
        "state": "ILE-DE-FRANCE",
        "country": "FRANCE",
        "country_iso": "FR",
        "sepa": true
      }
    },
    "created_at": 1542300827,
    "certificate": {
      "id": 2,
      "updated_at": 1542300829,
      "filename": "transfer-certificate.pdf",
      "mime_type": "application/pdf",
      "url": "string"
    },
    "comment": "string",
    "currency": "EUR",
    "document": null,
    "execution_date": "2018-11-16",
    "id": 1225,
    "fx_amount": null,
    "fx_currency": null,
    "fx_rate": null,
    "fx_fees": null,
    "label": "string",
    "similarTransfers": null,
    "send_notification": false,
    "status": "pending",
    "status_label": "En attente",
    "statusLabel": "En attente",
    "type": "direct",
    "updatable_until": 1542301427,
    "user": null,
    "o_auth_service": {
      "name": "test_service"
    },
    "validated_at": null,
    "validation_token": "389ee29fae55ccda35d5a5c5f412bfb2",
    "account": {
      "id": "c603a61b-5b91-4787-9663-c0ae08551f2f",
      "label": "test_account",
      "balance": 10308.63,
      "currency": "EUR",
      "company_name": "test_company",
      "validation_details": {
         "beneficiary": "simple",
         "transfer": "none"
      },
      "owner": {
        "gender_label": "Mr",
        "first_name" : "Jean",
        "last_name": "Dupont"
      }
    }
  },
  {...}
]

Responses

Status Code 200

Array of transfers

Name Type Description
amount number(double) Amount of the transfer
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
created_at integer Creation date
certificate document Certificate of the transfer
certificate.id integer Beneficiary ID
certificate.updated_at integer Date of update
certificate.filename string filename of the document
certificate.mime_type string MIME Type of the file
certificate.url string URL to download the file if uploaded
comment string User defined comment or reference
currency string Currency of the transfer EUR,USD etc..
document Document Document linked with the transfer (Invoice,...)
document.updated_at integer Date of update
document.filename string filename of the document
document.mime_type string MIME Type of the file
document.url string URL to download the file if uploaded
document_url string URL of the document
execution_date string(date) Date of execution
id integer Id of transfer
fx_amount number(double) Foreign Fees
fx_currency string Foreign currency
fx_rate number(double) Foreign rate
fx_fees number(double) Foreign Fees
label string User label
similar_transfers Transfer Similar transfers if exist
send_notification boolean Send a notification to the beneficiary
status string State of the transfer
status_label string State of the transfer translated
type string Type of transfer
updatable_until integer Date until the operation can be updated
user User User who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
o_auth_service OAuthService OAuthService who created the transfer
o_auth_service.name string name of the service
validated_at integer Validated at (when the transfer need validation)
validation_token string Validation token of the transfer (can be checked here https://www.manager.one/fr/wirecheck)
account Account Account
account.id integer Id of the account
account.label string Label of the account
account.balance number (double) Balance of the account
account.currency string Currency of the account

Enumerated Values

Property Value Description
status double_check Need validation of the bank (not SEPA)
status done Transfer done
status pending Transfer wait for processing
status processing Transfer in progress
status sent Transfer sent to the bank
status to_validate The transfer need the validation of the account owner
status wait_signature Wait for a signature of the bank (not SEPA)
status cancelled Transfer cancelled

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Get transfer fees

Code samples

curl -X GET https://api-stg.manager.one/transfers/fees?currency=string&amount=string&is_sepa=boolean \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Get fees from transfer (SEPA and not SEPA)

Request

GET /transfers/fees?currency=USD&amount=20&is_sepa=false

Parameters

Parameter In Type Description
currency query string currency iso code
amount query string amount value
is_sepa query boolean transfer sepa or not. False by default

Example response

200 Response

Responses

Status Code 200 OK

{
  "estimated_fees": "17.26",
  "estimated_amount": "55.47",
  "exchange_rate": "1.23234424"
}

Exchange details

Properties

Name Type Required Restrictions Description
estimated_fees number false none Fees estimation
estimated_amount number false none Amount estimation (transfer amount + fees)
exchange_rate number false none Exchange rate

Errors

Status Meaning Description Schema
400 Bad Request Error in request BadRequestHttpException
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found No data NotFoundHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Creates a transfer

Code samples

curl -X POST https://api-stg.manager.one/transfers \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Creates a transfer using provided data

Request

POST /transfers

Body parameter

{
  "send_notification": "true",
  "amount": 100.54,
  "currency": "EUR",
  "label": "transfer label",
  "comment": "transfer comment",
  "type": "direct",
  "execution_date": "2018-01-01",
  "beneficiary_id": 1
}
document: file

Properties

Name In Type Required Description
send_notification body boolean false Send a notification to the beneficiary
amount body number(double) true Amount of the transfer
currency body string true EUR/USD etc..
label body string false Transfer label
comment body string false Comment or reference
type body string false Type of transfer
execution_date body string(date) false Date of execution
beneficiary_id body integer false ID of beneficiary
Document form-data file false for SEPA, true for others The document to attach to the transfer

Enumerated Values

Property Value
type direct
type delayed
type periodic

Example response

201 Response

{
  "amount": 123,
  "beneficiary": {
    "id": 123,
    "label": "string",
    "short_tag": "GOPR",
    "iban": "FR7630001007941234567890185",
    "account_number_formatted": "FR76 3000 1007 9412 3456 7890 185",
    "bic": "string",
    "is_sepa": true,
    "phone_number": "0591731935",
    "email": "alex@manager.one",
    "comment": "string",
    "address": {
      "street": "56, boulevard Louise Maillet",
      "zip": "75002",
      "city": "PARIS 02",
      "country": "FR"
    },
    "social_security_number": "123456789",
    "rib": null,
    "validation": null,
    "bank_data": {
      "bic": "BOUSFRPPXXX",
      "bank": "BOURSORAMA",
      "street": "18 QUAI DU POINT DU JOUR",
      "zip": "92659",
      "city": "BOULOGNE BILLANCOURT",
      "state": "ILE-DE-FRANCE",
      "country": "FRANCE",
      "country_iso": "FR",
      "sepa": true
    }
  },
  "created_at": 1542300827,
  "certificate": {
    "id": 1017,
    "updated_at": 1542300829,
    "filename": "transfer-certificate.pdf",
    "mime_type": "application/pdf",
    "url": "string"
  },
  "comment": "string",
  "currency": "EUR",
  "document": null,
  "execution_date": "2018-11-16",
  "id": 1225,
  "fx_amount": null,
  "fx_currency": null,
  "fx_rate": null,
  "fx_fees": null,
  "label": "string",
  "similarTransfers": null,
  "send_notification": false,
  "status": "pending",
  "status_label": "En attente",
  "statusLabel": "En attente",
  "type": "direct",
  "updatable_until": 1542301427,
  "user": null,
  "o_auth_service": {
    "name": "test_service"
  },
  "validated_at": null,
  "validation_token": "389ee29fae55ccda35d5a5c5f412bfb2",
  "account": {
    "id": "c603a61b-5b91-4787-9663-c0ae08551f2f",
    "label": "test_account",
    "balance": 10308.63,
    "currency": "EUR",
    "company_name": "test_company",
    "validation_details": {
       "beneficiary": "simple",
       "transfer": "none"
    },
    "owner": {
      "gender_label": "Mr",
      "first_name" : "Jean",
      "last_name": "Dupont"
    }
  }
}

Responses

Name Type Description
amount number(double) Amount of the transfer
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
created_at integer Creation date
certificate document Certificate of the transfer
certificate.id integer Beneficiary ID
certificate.updated_at integer Date of update
certificate.filename string filename of the document
certificate.mime_type string MIME Type of the file
certificate.url string URL to download the file if uploaded
comment string User defined comment or reference
currency string Currency of the transfer EUR,USD etc..
document Document Document linked with the transfer (Invoice,...)
document.updated_at integer Date of update
document.filename string filename of the document
document.mime_type string MIME Type of the file
document.url string URL to download the file if uploaded
document_url string URL of the document
execution_date string(date) Date of execution
id integer Id of transfer
fx_amount number(double) Foreign Fees
fx_currency string Foreign currency
fx_rate number(double) Foreign rate
fx_fees number(double) Foreign Fees
label string User label
similar_transfers Transfer Similar transfers if exist
send_notification boolean Send a notification to the beneficiary
status string State of the transfer
status_label string State of the transfer translated
type string Type of transfer
updatable_until integer Date until the operation can be updated
user User User who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
o_auth_service OAuthService OAuthService who created the transfer
o_auth_service.name string name of the service
validated_at integer Validated at (when the transfer need validation)
validation_token string Validation token of the transfer (can be checked here https://www.manager.one/fr/wirecheck)
account Account Account
account.id integer Id of the account
account.label string Label of the account
account.balance number (double) Balance of the account
account.currency string Currency of the account

Enumerated Values

Property Value Description
status double_check Need validation of the bank (not SEPA)
status done Transfer done
status pending Transfer wait for processing
status processing Transfer in progress
status sent Transfer sent to the bank
status to_validate The transfer need the validation of the account owner
status wait_signature Wait for a signature of the bank (not SEPA)
status cancelled Transfer cancelled

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

Import files to create transfers

Code samples

curl -X POST https://api-stg.manager.one/transfers/import \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Import a SEPA XML file or some paysheets to create multiple transfers.

This endpoint analyses imported files and returns detected transfers. After using this endpoint, use Create multiple transfers with returned transfers to create transfers.

If paysheets are imported, they will be attached to transfers when you will create them.

Request

POST /transfers/import

Body parameter

sepa: true
file: file

Parameters

Parameter In Type Required Description
sepa body boolean false SEPA file or not
file body file true The SEPA file or XML

Example response

202 Response

{
  "valid":[
    {
      "transfer": {
        "amount": 1319.32,
        "beneficiary": {
          "id": 1,
          "label": "John",
          "short_tag": null,
          "iban": "FR7630001007941234561890185",
          "account_number_formatted": "FR76 3000 1007 9412 3456 1890 185",
          "bic": "SOGEFRPPXXX",
          "is_sepa": true,
          "phone_number": null,
          "email": "john@manager.one",
          "comment": null,
          "address": {
            "street": "8, boulevard Charpentier",
            "zip": "71800",
            "city": "ST GERMAIN EN BRIONNAIS",
            "country": "FR"
          },
          "social_security_number": "1500789151856",
          "rib": null,
          "validation": null,
          "bank_data": {
            "bic": "BDFEFRPPCCT",
            "bank": "BANQUE DE FRANCE",
            "street": "",
            "zip": "",
            "city": "",
            "country": "FRANCE",
            "country_iso": null,
            "sepa": true
          }
        },
        "currency": "EUR",
        "document": {
         "id": 1,
         "updated_at": 12345,
         "filename": "payslip-john.pdf",
         "mime_type": "application/pdf",
         "url": "string"
        },
        "execution_date": "2018-01-19",
        "label": "PAYSLIP January 2018 John",
        "type": "direct",
        "send_notification": true,
        "temporary_file": 1,
        "period": "01-2018",
        "is_paysheet": true
      },
      "beneficiary": {
        "id": 1,
        "label": "John",
        "short_tag": null,
        "iban": "FR76 3000 1007 9412 3456 1890 185",
        "account_number_formatted": "FR76 3000 1007 9412 3456 1890 185",
        "bic": "SOGEFRPPXXX",
        "is_sepa": true,
        "phone_number": null,
        "email": "john@manager.one",
        "comment": null,
        "address": {
          "street": "8, boulevard Charpentier",
          "zip": "71800",
          "city": "ST GERMAIN EN BRIONNAIS",
          "country": "FR"
        },
        "social_security_number": "1500789151856",
        "rib": null,
        "validation": {
          "id": 1,
          "created_at": 123456,
          "updated_at": 123456,
          "status": "accepted",
          "label": "Ajout de bénéficiaire",
          "sub_label": "John",
          "policy": "simple",
          "attempts": 0,
          "allowed": false
        },
        "bank_data": {
          "bic": "BDFEFRPPCCT",
          "bank": "BANQUE DE FRANCE",
          "street": "",
          "zip": "",
          "city": "",
          "country": "FRANCE",
          "country_iso": null,
          "sepa": true
        }
      }
    }
  ],
  "invalid": [
    {
      "transfer": {
        "amount": 1452.46,
        "beneficiary": null,
        "currency": "EUR",
        "document": {
          "id": 2,
          "updated_at": 12345,
          "filename": "string",
          "mime_type": "application/pdf",
          "url": "string"
        },
        "execution_date": "2018-01-19",
        "label": "PAYSLIP January 2018 Alison",
        "type": "direct",
        "send_notification": true,
        "temporary_file": 1025,
        "period": "01-2018",
        "is_paysheet": true
      },
      "beneficiary": {
        "id": null,
        "label": "Alison",
        "short_tag": null,
        "iban": null,
        "account_number_formatted": null,
        "bic": null,
        "is_sepa": null,
        "phone_number": null,
        "email": null,
        "comment": null,
        "address": null,
        "social_security_number": "1500734251004",
        "rib": null,
        "validation": null
      }
    }
  ]
}

Responses

This endpoint returns two transfer tables, a valid one with valid transfers that can be created and an invalid one with invalid transfers.

If an invalid transfer has a beneficiary_label and a transfer amount, but does not have a beneficiary_id, it can be validated by creating the beneficiary with the Create beneficiary endpoint. After creating the beneficiary, import the file(s) a second time to get the valid the transfer.

Valid transfers can be created with the Create multiple transfers endpoint.

Name Type Description
valid array Array of valid transfers
transfer Transfer A valid transfer
transfer.amount number(double) Amount of the transfer
transfer.beneficiary Beneficiary Beneficiary of the transfer
transfer.beneficiary.id integer Beneficiary ID
transfer.beneficiary.label string Name / social reason of the beneficiary
transfer.beneficiary.short_tag string Associated code
transfer.beneficiary.iban string IBAN
transfer.beneficiary.account_number_formatted string Formatted Account number
transfer.beneficiary.bic string BIC code
transfer.beneficiary.is_sepa boolean SEPA or not
transfer.beneficiary.phone_number string Beneficiary phone number
transfer.beneficiary.email string(email) Beneficiary email
transfer.beneficiary.comment string Comment on the beneficiary
transfer.beneficiary.address Address Address of the beneficiary
transfer.beneficiary.address.street string Street of the beneficiary
transfer.beneficiary.address.zip string zip code
transfer.beneficiary.address.city string City of the beneficiary
transfer.beneficiary.address.country string Country of the beneficiary
transfer.beneficiary.social_security_number string Beneficiary social security number
transfer.beneficiary.rib Document Rib of the beneficiary
transfer.beneficiary.rib.updated_at integer Date of update
transfer.beneficiary.rib.filename string filename of the document
transfer.beneficiary.rib.mime_type string MIME Type of the file
transfer.beneficiary.rib.url string URL to download the file if uploaded
transfer.beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
transfer.beneficiary.validation.id integer Id of the validation
transfer.beneficiary.validation.created_at integer Creation date
transfer.beneficiary.validation.updated_at integer Date of update
transfer.beneficiary.validation.status string Status of the validation of the beneficiary
transfer.beneficiary.validation.label string Type of the validation
transfer.beneficiary.validation.sub_label string Some information about the validation
transfer.beneficiary.validation.policy string Type of policy
transfer.beneficiary.validation.attempts integer Number of attempts
transfer.beneficiary.validation.allowed boolean Type of the validation
transfer.beneficiary.bank_data Iban Bank data of the beneficiary
transfer.beneficiary.bank_data.bic string Bank Identifier Code
transfer.beneficiary.bank_data.bank string Bank of the beneficiary
transfer.beneficiary.bank_data.street string Street of the bank
transfer.beneficiary.bank_data.zip string Zip code of the bank
transfer.beneficiary.bank_data.city string City of the bank
transfer.beneficiary.bank_data.state string State of the bank
transfer.beneficiary.bank_data.country string Country of the bank
transfer.beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
transfer.beneficiary.bank_data.sepa boolean SEPA or not
transfer.currency string Currency of the transfer EUR,USD etc..
transfer.document deprecated Document see documents instead.
documents Document[] -
transfer.execution_date string(date) Date of execution
transfer.label string User label
transfer.type string Type of transfer
transfer.send_notification boolean Send a notification to the beneficiary
transfer.temporary_file integer Id of the file uploaded to attach to the operation (the payslip)
transfer.period string If the transfer has been generated from a paysheet, month and year of the paysheet
transfer.is_paysheet boolean Import from a paysheet or not
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
invalid array Array of invalid transfers
transfer Transfer an invalid transfer
beneficiary Beneficiary Beneficiary of the transfer

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

Create multiple transfers

Code samples

curl -X POST https://api-stg.manager.one/transfers/batch \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Creates multiple transfers using provided data.

You can use this endpoint after using the import file endpoint with the data returned or just build a requests from scratch.

If you have imported some paysheets, they will be attached to the transfers with the field temporary_file.

You can also attach a file to a transfer by two methods:

Request

POST /transfers/batch

Body parameter

{
  "transfers": [
    {
      "send_notification": true,
      "amount": 1319.32,
      "currency": "EUR",
      "label": "PAYSLIP January 2018 John",
      "comment": "transfer comment",
      "type": "direct",
      "execution_date": "2018-01-19",
      "beneficiary_id": 1,
      "temporary_file": 1
    },
    {
      "send_notification": true,
      "amount": "100,54",
      "currency": "EUR",
      "label": "PAYSLIP January 2018 Alison",
      "comment": "transfer comment",
      "type": "direct",
      "execution_date": "2018-01-19",
      "beneficiary_id": 1,
    }
  ]
}
document: ["1": file] #Attach the file with the second transfer

Parameters

Array of Transfer

Name In Type Required Description
transfers body array true Array of transfers to create
send_notification body boolean false Send a notification to the beneficiary
amount body number(double) true Amount of the operation
currency body string true EUR/USD etc..
label body string false User label
comment body string false User comment or reference
type body string false Type of transfer
execution_date body string(date) false Date of execution
beneficiary_id body integer false Beneficiary ID
temporary_file body integer false ID of the document already uploaded (for payslip)
Document form-data file false The document to attach (if temporary_file is not used)

Enumerated Values

Property Value
type direct
type delayed
type periodic

Example response

201 Response

{
  "0": {
    "amount": 1319.32,
    "beneficiary": {
      "id": 1,
      "label": "John",
      "short_tag": null,
      "iban": "FR7630001007941234561890185",
      "account_number_formatted": "FR76 3000 1007 9412 3456 1890 185",
      "bic": "SOGEFRPPXXX",
      "is_sepa": true,
      "phone_number": null,
      "email": "john@manager.one",
      "comment": null,
      "address": {
        "street": "8, boulevard Charpentier",
        "zip": "71800",
        "city": "ST GERMAIN EN BRIONNAIS",
        "country": "FR"
      },
      "social_security_number": "1500789151856",
      "rib": null,
      "validation": null,
      "bank_data": {
        "bic": "BDFEFRPPCCT",
        "bank": "BANQUE DE FRANCE",
        "street": "",
        "zip": "",
        "city": "",
        "country": "FRANCE",
        "country_iso": null,
        "sepa": true
      }
    },
    "created_at": 123456,
    "certificate": {
      "id": 1,
      "updated_at": 123456,
      "filename": "transfer-certificate-payslip-february-2018-john.pdf",
      "mime_type": "application/pdf",
      "url": "string"
    },
    "comment": null,
    "currency": "EUR",
    "document": {
     "id": 1,
     "updated_at": 12345,
     "filename": "payslip-john.pdf",
     "mime_type": "application/pdf",
     "url": "string"
    },
    "execution_date": "2018-01-19",
    "id": 1,
    "fx_amount": null,
    "fx_currency": null,
    "fx_rate": null,
    "fx_fees": null,
    "label": "PAYSLIP January 2018 John",
    "similar_transfers": null,
    "send_notification": true,
    "status": "processing",
    "status_label": "En cours",
    "type": "direct",
    "updatable_until": 123456,
    "user": null,
    "o_auth_service": {
      "name": "test_service"
    },
    "validated_at": null,
    "validation_token": "5e8163fd9dd0879e714f57228f0ac87d"
  },
  "1": {
    "amount": 1452.46,
    "beneficiary": {
      "id": 2,
      "label": "Alison",
      "short_tag": null,
      "iban": "FR7630001007941234567890179",
      "account_number_formatted": "FR76 3000 1007 9412 3456 7890 179",
      "bic": "string",
      "is_sepa": true,
      "phone_number": "0500000000",
      "email": "alison@manager.one",
      "comment": "string",
      "address": {
        "street": "56, boulevard Louise Maillet",
        "zip": "75002",
        "city": "PARIS 02",
        "country": "FR"
      },
      "social_security_number": "123456789",
      "rib": null,
      "validation": null,
      "bank_data": {
        "bic": "BOUSFRPPXXX",
        "bank": "BOURSORAMA",
        "street": "18 QUAI DU POINT DU JOUR",
        "zip": "92659",
        "city": "BOULOGNE BILLANCOURT",
        "state": "ILE-DE-FRANCE",
        "country": "FRANCE",
        "country_iso": "FR",
        "sepa": true
      }
    },
    "created_at": 123456,
    "certificate": {
      "id": 2,
      "updated_at": 123456,
      "filename": "transfer-certificate-payslip-february-2018-alison.pdf",
      "mime_type": "application/pdf",
      "url": "string"
    },
    "comment": null,
    "currency": "EUR",
    "document": {
      "id": 2,
      "updated_at": 1475419716,
      "filename": "none",
      "mime_type": "application/pdf",
      "url": "https://api-mone.docker.dev/transfers/3234/document"
    },
    "execution_date": "2018-01-19",
    "id": 2,
    "fx_amount": null,
    "fx_currency": null,
    "fx_rate": null,
    "fx_fees": null,
    "label": "PAYSLIP February 2018 Alison",
    "similar_transfers": null,
    "send_notification": true,
    "status": "pending",
    "status_label": "En attente",
    "type": "direct",
    "updatable_until": 1542710975,
    "user": null,
    "o_auth_service": {
      "name": "test_service"
    },
    "validated_at": null,
    "validation_token": "22d4fcc75a53c71a056262cafa90bd74"
  },
  "account": {
    "id": "c603a61b-5b91-4787-9663-c0ae08551f2f",
    "label": "test_account",
    "balance": 10308.63,
    "currency": "EUR",
    "company_name": "test_company",
    "validation_details": {
       "beneficiary": "simple",
       "transfer": "none"
    },
    "owner": {
      "gender_label": "Mr",
      "first_name" : "Jean",
      "last_name": "Dupont"
    }
  }
}

Responses

Array of transfers

Name Type Description
amount number(double) Amount of the transfer
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
created_at integer Creation date
certificate document Certificate of the transfer
certificate.id integer Beneficiary ID
certificate.updated_at integer Date of update
certificate.filename string filename of the document
certificate.mime_type string MIME Type of the file
certificate.url string URL to download the file if uploaded
comment string User defined comment or reference
currency string Currency of the transfer EUR,USD etc..
document deprecated Document see documents instead.
documents Document[] -
execution_date string(date) Date of execution
id integer Id of transfer
fx_amount number(double) Foreign Fees
fx_currency string Foreign currency
fx_rate number(double) Foreign rate
fx_fees number(double) Foreign Fees
label string User label
similar_transfers Transfer Similar transfers if exist
send_notification boolean Send a notification to the beneficiary
status string State of the transfer
status_label string State of the transfer translated
type string Type of transfer
updatable_until integer Date until the operation can be updated
user User User who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
o_auth_service OAuthService OAuthService who created the transfer
o_auth_service.name string name of the service
validated_at integer Validated at (when the transfer need validation)
validation_token string Validation token of the transfer

Account

Name Type Description
account Account Account
account.id integer Id of the account
account.balance number (double) Balance of the account
account.label string Label of the account
account.currency string Currency of the account

Enumerated Values

Property Value Description
transfer.status double_check Need validation of the bank (not SEPA)
transfer.status done Transfer done
transfer.status pending Transfer wait for processing
transfer.status processing Transfer in progress
transfer.status sent Transfer sent to the bank
transfer.status to_validate The transfer need the validation of the account owner
transfer.status wait_signature Wait for a signature of the bank (not SEPA)

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

Get a transfer

Code samples

curl -X GET https://api-stg.manager.one/transfers/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Return a transfer

Request

GET /transfers/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true The transfer ID

Example response

200 Response

Example response

200 Response

{
  "amount": 1319.32,
  "beneficiary": {
    "id": 1,
    "label": "John",
    "short_tag": null,
    "iban": "FR7630001007941234561890185",
    "account_number_formatted": "FR76 3000 1007 9412 3456 1890 185",
    "bic": "SOGEFRPPXXX",
    "is_sepa": true,
    "phone_number": null,
    "email": "john@manager.one",
    "comment": null,
    "address": {
      "street": "8, boulevard Charpentier",
      "zip": "71800",
      "city": "ST GERMAIN EN BRIONNAIS",
      "country": "FR"
    },
    "social_security_number": "1500789151856",
    "rib": null,
    "validation": null,
    "bank_data": {
      "bic": "BDFEFRPPCCT",
      "bank": "BANQUE DE FRANCE",
      "street": "",
      "zip": "",
      "city": "",
      "country": "FRANCE",
      "country_iso": null,
      "sepa": true
    }
  },
  "created_at": 123456,
  "certificate": {
    "id": 1,
    "updated_at": 123456,
    "filename": "transfer-certificate-payslip-february-2018-john.pdf",
    "mime_type": "application/pdf",
    "url": "string"
  },
  "comment": null,
  "currency": "EUR",
  "document": {
   "id": 1,
   "updated_at": 12345,
   "filename": "payslip-john.pdf",
   "mime_type": "application/pdf",
   "url": "string"
  },
  "execution_date": "2018-01-19",
  "id": 1,
  "fx_amount": null,
  "fx_currency": null,
  "fx_rate": null,
  "fx_fees": null,
  "label": "PAYSLIP January 2018 John",
  "similar_transfers": null,
  "send_notification": true,
  "status": "processing",
  "status_label": "En cours",
  "type": "direct",
  "updatable_until": 123456,
  "user": null,
  "o_auth_service": {
    "name": "test_service"
  },
  "validated_at": null,
  "validation_token": "5e8163fd9dd0879e714f57228f0ac87d",
  "account": {
    "id": "c603a61b-5b91-4787-9663-c0ae08551f2f",
    "label": "test_account",
    "balance": 10308.63,
    "currency": "EUR",
    "company_name": "test_company",
    "validation_details": {
       "beneficiary": "simple",
       "transfer": "none"
    },
    "owner": {
      "gender_label": "Mr",
      "first_name" : "Jean",
      "last_name": "Dupont"
    }
  }
}

Responses

Transfer

Name Type Description
amount number(double) Amount of the transfer
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
created_at integer Creation date
certificate document Certificate of the transfer
certificate.id integer Beneficiary ID
certificate.updated_at integer Date of update
certificate.filename string filename of the document
certificate.mime_type string MIME Type of the file
certificate.url string URL to download the file if uploaded
comment string User defined comment or reference
currency string Currency of the transfer EUR,USD etc..
document Document Document linked with the transfer (Invoice,...)
document.updated_at integer Date of update
document.filename string filename of the document
document.mime_type string MIME Type of the file
document.url string URL to download the file if uploaded
document_url string URL of the document
execution_date string(date) Date of execution
id integer Id of transfer
fx_amount number(double) Foreign Fees
fx_currency string Foreign currency
fx_rate number(double) Foreign rate
fx_fees number(double) Foreign Fees
label string User label
similar_transfers Transfer Similar transfers if exist
send_notification boolean Send a notification to the beneficiary
status string State of the transfer
status_label string State of the transfer translated
type string Type of transfer
updatable_until integer Date until the operation can be updated
user User User who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
o_auth_service OAuthService OAuthService who created the transfer
o_auth_service.name string name of the service
validated_at integer Validated at (when the transfer need validation)
validation_token string Validation token of the transfer (can be checked here https://www.manager.one/fr/wirecheck)
account Account Account
account.id integer Id of the account
account.label string Label of the account
account.balance number (double) Balance of the account
account.currency string Currency of the account

Enumerated Values

Property Value Description
status double_check Need validation of the bank (not SEPA)
status done Transfer done
status pending Transfer wait for processing
status processing Transfer in progress
status sent Transfer sent to the bank
status to_validate The transfer need the validation of the account owner
status wait_signature Wait for a signature of the bank (not SEPA)
status cancelled Transfer cancelled

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found The transfer doesn't exist NotFoundHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Update a transfer

Code samples

curl -X PUT https://api-stg.manager.one/transfers/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Update a specific transfer

Request

PUT /transfers/{id}

Body parameter

{
  "amount": "100,12",
  "label": "transfer label",
  "comment": "transfer comment",
  "type": "direct",
  "execution_date": "2018-01-01",
  "validated_at": "1521535875"
}

Parameters

Parameter In Type Required Description
id path integer(int32) true The transfer ID
amount body number(double) false Amount of the transfer
label body string false Label of the transfer
comment body string false Comment or reference
type body string false Type of transfer
execution_date body string(date) false Date of execution
validated_at body integer false Validated at

Enumerated Values

Property Value
type direct
type delayed
type periodic

Example response

200 Response

{
  "amount": 1319.32,
  "beneficiary": {
    "id": 1,
    "label": "John",
    "short_tag": null,
    "iban": "FR7630001007941234561890185",
    "account_number_formatted": "FR76 3000 1007 9412 3456 1890 185",
    "bic": "SOGEFRPPXXX",
    "is_sepa": true,
    "phone_number": null,
    "email": "john@manager.one",
    "comment": null,
    "address": {
      "street": "8, boulevard Charpentier",
      "zip": "71800",
      "city": "ST GERMAIN EN BRIONNAIS",
      "country": "FR"
    },
    "social_security_number": "1500789151856",
    "rib": null,
    "validation": null,
    "bank_data": {
      "bic": "BDFEFRPPCCT",
      "bank": "BANQUE DE FRANCE",
      "street": "",
      "zip": "",
      "city": "",
      "country": "FRANCE",
      "country_iso": null,
      "sepa": true
    }
  },
  "created_at": 123456,
  "certificate": {
    "id": 1,
    "updated_at": 123456,
    "filename": "transfer-certificate-payslip-february-2018-john.pdf",
    "mime_type": "application/pdf",
    "url": "string"
  },
  "comment": null,
  "currency": "EUR",
  "document": {
   "id": 1,
   "updated_at": 12345,
   "filename": "payslip-john.pdf",
   "mime_type": "application/pdf",
   "url": "string"
  },
  "execution_date": "2018-01-19",
  "id": 1,
  "fx_amount": null,
  "fx_currency": null,
  "fx_rate": null,
  "fx_fees": null,
  "label": "PAYSLIP January 2018 John",
  "similar_transfers": null,
  "send_notification": true,
  "status": "processing",
  "status_label": "En cours",
  "type": "direct",
  "updatable_until": 123456,
  "user": null,
  "o_auth_service": {
    "name": "test_service"
  },
  "validated_at": null,
  "validation_token": "5e8163fd9dd0879e714f57228f0ac87d",
  "account": {
    "id": "c603a61b-5b91-4787-9663-c0ae08551f2f",
    "label": "test_account",
    "balance": 10308.63,
    "currency": "EUR",
    "company_name": "test_company",
    "validation_details": {
       "beneficiary": "simple",
       "transfer": "none"
    },
    "owner": {
      "gender_label": "Mr",
      "first_name" : "Jean",
      "last_name": "Dupont"
    }
  }
}

Responses

Status Code 200 OK

Transfer

Name Type Description
amount number(double) Amount of the transfer
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
created_at integer Creation date
certificate document Certificate of the transfer
certificate.id integer Beneficiary ID
certificate.updated_at integer Date of update
certificate.filename string filename of the document
certificate.mime_type string MIME Type of the file
certificate.url string URL to download the file if uploaded
comment string User defined comment or reference
currency string Currency of the transfer EUR,USD etc..
document Document Document linked with the transfer (Invoice,...)
document.updated_at integer Date of update
document.filename string filename of the document
document.mime_type string MIME Type of the file
document.url string URL to download the file if uploaded
document_url string URL of the document
execution_date string(date) Date of execution
id integer Id of transfer
fx_amount number(double) Foreign Fees
fx_currency string Foreign currency
fx_rate number(double) Foreign rate
fx_fees number(double) Foreign Fees
label string User label
similar_transfers Transfer Similar transfers if exist
send_notification boolean Send a notification to the beneficiary
status string State of the transfer
status_label string State of the transfer translated
type string Type of transfer
updatable_until integer Date until the operation can be updated
user User User who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
o_auth_service OAuthService OAuthService who created the transfer
o_auth_service.name string name of the service
validated_at integer Validated at (when the transfer need validation)
validation_token string Validation token of the transfer (can be checked here https://www.manager.one/fr/wirecheck)
account Account Account
account.id integer Id of the account
account.label string Label of the account
account.balance number (double) Balance of the account
account.currency string Currency of the account

Enumerated Values

Property Value Description
status double_check Need validation of the bank (not SEPA)
status done Transfer done
status pending Transfer wait for processing
status processing Transfer in progress
status sent Transfer sent to the bank
status to_validate The transfer need the validation of the account owner
status wait_signature Wait for a signature of the bank (not SEPA)
status cancelled Transfer cancelled

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found The transfer doesn't exist NotFoundHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

Cancel a transfer

Code samples

curl -X DELETE https://api-stg.manager.one/transfers/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Cancel a specific transfer

Request

DELETE /transfers/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true The transfer ID

Example response

200 Response

{
  "amount": 1319.32,
  "beneficiary": {
    "id": 1,
    "label": "John",
    "short_tag": null,
    "iban": "FR7630001007941234561890185",
    "account_number_formatted": "FR76 3000 1007 9412 3456 1890 185",
    "bic": "SOGEFRPPXXX",
    "is_sepa": true,
    "phone_number": null,
    "email": "john@manager.one",
    "comment": null,
    "address": {
      "street": "8, boulevard Charpentier",
      "zip": "71800",
      "city": "ST GERMAIN EN BRIONNAIS",
      "country": "FR"
    },          
    "social_security_number": "1500789151856",
    "rib": null,
    "validation": null,
    "bank_data": {
      "bic": "BDFEFRPPCCT",
      "bank": "BANQUE DE FRANCE",
      "street": "",
      "zip": "",
      "city": "",
      "country": "FRANCE",
      "country_iso": null,
      "sepa": true
    }
  },
  "created_at": 123456,
  "certificate": {
    "id": 1,
    "updated_at": 123456,
    "filename": "transfer-certificate-payslip-february-2018-john.pdf",
    "mime_type": "application/pdf",
    "url": "string"
  },
  "comment": "transfer comment",
  "currency": "EUR",
  "document": {
   "id": 1,
   "updated_at": 12345,
   "filename": "payslip-john.pdf",
   "mime_type": "application/pdf",
   "url": "string"
  },  
  "execution_date": "2019-01-01",
  "id": 1,
  "fx_amount": null,
  "fx_currency": null,
  "fx_rate": null,
  "fx_fees": null,
  "label": "PAYSLIP January 2018 John",
  "similarTransfers": null,
  "similar_transfers": null,
  "send_notification": true,
  "status": "cancelled",
  "status_label": "Annulé",
  "statusLabel": "Annulé",
  "type": "direct",
  "updatable_until": 123456,
  "user": null,
  "o_auth_service": {
    "name": "test_service"
  },
  "validated_at": null,
  "validation_token": "408f8fa8c36324569ca4c4d7cd3c6715",
  "account": {
    "id": "c603a61b-5b91-4787-9663-c0ae08551f2f",
    "label": "test_account",
    "balance": 10308.63,
    "currency": "EUR",
    "company_name": "test_company",
    "validation_details": {
       "beneficiary": "simple",
       "transfer": "none"
    },
    "owner": {
      "gender_label": "Mr",
      "first_name" : "Jean",
      "last_name": "Dupont"
    }
  }
}

Responses

Status Code 200 OK

Transfer

Name Type Description
amount number(double) Amount of the transfer
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
created_at integer Creation date
certificate document Certificate of the transfer
certificate.id integer Beneficiary ID
certificate.updated_at integer Date of update
certificate.filename string filename of the document
certificate.mime_type string MIME Type of the file
certificate.url string URL to download the file if uploaded
comment string User defined comment or reference
currency string Currency of the transfer EUR,USD etc..
document Document Document linked with the transfer (Invoice,...)
document.updated_at integer Date of update
document.filename string filename of the document
document.mime_type string MIME Type of the file
document.url string URL to download the file if uploaded
document_url string URL of the document
execution_date string(date) Date of execution
id integer Id of transfer
fx_amount number(double) Foreign Fees
fx_currency string Foreign currency
fx_rate number(double) Foreign rate
fx_fees number(double) Foreign Fees
label string User label
similar_transfers Transfer Similar transfers if exist
send_notification boolean Send a notification to the beneficiary
status string State of the transfer
status_label string State of the transfer translated
type string Type of transfer
updatable_until integer Date until the operation can be updated
user User User who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
o_auth_service OAuthService OAuthService who created the transfer
o_auth_service.name string name of the service
validated_at integer Validated at (when the transfer need validation)
validation_token string Validation token of the transfer (can be checked here https://www.manager.one/fr/wirecheck)
account Account Account
account.id integer Id of the account
account.label string Label of the account
account.balance number (double) Balance of the account
account.currency string Currency of the account

Enumerated Values

Property Value Description
status double_check Need validation of the bank (not SEPA)
status done Transfer done
status pending Transfer wait for processing
status processing Transfer in progress
status sent Transfer sent to the bank
status to_validate The transfer need the validation of the account owner
status wait_signature Wait for a signature of the bank (not SEPA)
status cancelled Transfer cancelled

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

Download the file attached to a transfer

Code samples

curl -X GET https://api-stg.manager.one/transfers/{id}/{documentType} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Get a file attached to a transfer

Request

GET /transfers/{id}/{documentType}

Parameters

Parameter In Type Required Description
id path integer(int32) true Transfer ID
documentType path string true Document type

Enumerated Values

Parameter Value
documentType document deprecated
(see « Download the operation documents » instead.)
documentType certificate
documentType international

[DEPRECATED] Attach a file to a transfer

Request

POST /transfers/{id}/{documentType}

[DEPRECATED] Delete the document

Request

DELETE /transfers/{id}/{documentType}

Check if the token is linked to a transfer

Code samples

curl -X GET https://api-stg.manager.one/transfers/check/{token} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Check if the token is linked to a transfer

Request

GET /transfers/check/{token}

Parameters

Parameter In Type Required Description
token path string true The transfer token

Example response

200 Response

{
  "amount": "100,00",
  "beneficiary": {
    "id": 123,
    "label": "string",
    "short_tag": "GOPR",
    "iban": "FR7630001007941234567890185",
    "account_number_formatted": "FR76 3000 1007 9412 3456 7890 185",
    "bic": "string",
    "is_sepa": true,
    "phone_number": "0033612345678",
    "email": "alex@manager.one",
    "comment": "Somme comment",
    "bank_data": {
      "bic": "BOUSFRPPXXX",
      "bank": "BOURSORAMA",
      "street": "18 QUAI DU POINT DU JOUR",
      "zip": "92659",
      "city": "BOULOGNE BILLANCOURT",
      "state": "ILE-DE-FRANCE",
      "country": "FRANCE",
      "country_iso": "FR",
      "sepa": true
    },
    "address": {
      "street": "48, Rue de la Vielle Ecole",
      "zip": "75116",
      "city": "Paris",
      "country": "France"
    },
    "social_security_number": "123456789"
  },
  "created_at": "1521535875",
  "currency": "EUR",
  "execution_date": "2018-01-01",
  "status": "done",
  "status_label": "Terminé"
}

Response

Status Code 200 OK

The checked Transfer

Name Type Description
amount number(double) Amount of the transfer
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
created_at integer Creation date
currency string Currency of the transfer EUR,USD etc..
execution_date string(date) Date of execution
status string State of the operation
status_label string Label for the operation

Enumerated Values

Property Value Description
status double_check Need validation of the bank (not SEPA)
status done Transfer done
status pending Transfer wait for processing
status processing Transfer in progress
status sent Transfer sent to the bank
status to_validate The transfer need the validation of the account owner
status wait_signature Wait for a signature of the bank (not SEPA)

Errors

Status Meaning Description Schema
404 Not Found The transfer doesn't exist NotFoundHttpException
403 Forbidden Not authorized ForbiddenHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Beneficiary

List of beneficiaries

Code samples

curl -X GET https://api-stg.manager.one/beneficiaries \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

List of beneficiaries

Request

GET /beneficiaries

Parameters

Parameter In Type Required Description
expand query string false Comma separated list of other fields to return

Enumerated Values

Parameter Value
expand address
expand beneficiary_list

Example response

200 Response

[
  {
    "id": 1,
    "label": "John",
    "short_tag": null,
    "iban": "FR76 3000 1007 9412 3456 1890 185",
    "account_number_formatted": "FR76 3000 1007 9412 3456 1890 185",
    "bic": "SOGEFRPPXXX",
    "is_sepa": true,
    "phone_number": null,
    "email": "john@manager.one",
    "comment": null,
    "address": {
      "street": "8, boulevard Charpentier",
      "zip": "71800",
      "city": "ST GERMAIN EN BRIONNAIS",
      "country": "FR"
    },
    "social_security_number": "1500789151856",
    "rib": null,
    "validation": {
      "id": 1,
      "created_at": 123456,
      "updated_at": 123456,
      "status": "accepted",
      "label": "Ajout de bénéficiaire",
      "sub_label": "ADRIEN HERBERT",
      "policy": "simple",
      "attempts": 0,
      "allowed": false
    },
    "bank_data": {
      "bic": "BDFEFRPPCCT",
      "bank": "BANQUE DE FRANCE",
      "street": "",
      "zip": "",
      "city": "",
      "country": "FRANCE",
      "country_iso": null,
      "sepa": true
    }
  },
  {
    "id": 2,
    "label": "Alison",
    "short_tag": "GOPR",
    "iban": "FR7630001007941234567890185",
    "account_number_formatted": "FR76 3000 1007 9412 3456 7890 534",
    "bic": "string",
    "is_sepa": true,
    "phone_number": "0591731935",
    "email": "alison@manager.one",
    "comment": "string",
    "address": {
      "street": "56, boulevard Louise Maillet",
      "zip": "75002",
      "city": "PARIS 02",
      "country": "FR"
    },
    "social_security_number": "123456789",
    "rib": null,
    "validation": null,
    "bank_data": {
      "bic": "BOUSFRPPXXX",
      "bank": "BOURSORAMA",
      "street": "18 QUAI DU POINT DU JOUR",
      "zip": "92659",
      "city": "BOULOGNE BILLANCOURT",
      "state": "ILE-DE-FRANCE",
      "country": "FRANCE",
      "country_iso": "FR",
      "sepa": true
    }
  }
]

Responses

Status Code 200 OK

Array of Beneficiaries

Name Type Description
id integer Beneficiary ID
label string Name / social reason of the beneficiary
short_tag string Associated code
iban string IBAN
account_number_formatted string Formatted Account number
bic string BIC code
is_sepa boolean SEPA or not
phone_number string Beneficiary phone number
email string(email) Beneficiary email
comment string Comment on the beneficiary
address Address Address of the beneficiary
address.street string Street
address.zip string zip code
address.city string City
address.country string Country code
social_security_number string Beneficiary social security number
rib Document Rib of the beneficiary
rib.updated_at integer Date of update
rib.filename string filename of the document
rib.mime_type string MIME Type of the file
rib.url string URL to download the file if uploaded
validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
validation.id integer Id of the validation
validation.created_at integer Creation date
validation.updated_at integer Date of update
validation.status string Status of the validation of the beneficiary
validation.label string Type of the validation
validation.sub_label string Some information about the validation
validation.policy string Type of policy
validation.attempts integer Number of attempts
validation.allowed boolean Type of the validation
bank_data Iban Bank data of the beneficiary
bank_data.bic string Bank Identifier Code
bank_data.bank string Bank of the beneficiary
bank_data.street string Street of the bank
bank_data.zip string Zip code of the bank
bank_data.city string City of the bank
bank_data.state string State of the bank
bank_data.country string Country of the bank
bank_data.country_iso string Country code
bank_data.sepa boolean SEPA or not

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Create a beneficiary

Code samples

curl -X POST https://api-stg.manager.one/beneficiaries \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Create a beneficiary

Request

POST /beneficiaries

Body parameter

{
  "label": "string",
  "short_tag": "GOPR",
  "iban": "FR7630001007941234567890185",
  "bic": "string",
  "phone_number": "0591731935",
  "email": "alex@manager.one",
  "comment": "Somme comment",
  "beneficiary_list_id": 0,
  "is_sepa": true,
  "bank_data": {
    "bic": "BOUSFRPPXXX",
    "bank": "BOURSORAMA",
    "street": "18 QUAI DU POINT DU JOUR",
    "zip": "92659",
    "city": "BOULOGNE BILLANCOURT",
    "state": "ILE-DE-FRANCE",
    "country": "FRANCE",
    "country_iso": "FR",
    "sepa": true
  },
  "address": {
    "street": "48, Rue de la Vielle Ecole",
    "zip": "75116",
    "city": "Paris",
    "country": "France"
  },
  "social_security_number": "123456789"
}

Parameters

Name Type Required Description
label string true Name / social reason of the beneficiary
short_tag string false Associated code
iban string true IBAN
bic string true BIC code
phone_number string false Beneficiary phone number
email string(email) false User email
comment string false Comment on the Beneficiary
beneficiary_list_id integer false Id of the beneficiary_list
is_sepa boolean false SEPA or not
bank_data Iban Only when not SEPA Bank data of the beneficiary
bank_data.bic string Only when not SEPA Bank Identifier Code
bank_data.bank string Only when not SEPA Bank of the beneficiary
bank_data.street string Only when not SEPA Street of the bank
bank_data.zip string Only when not SEPA Zip code of the bank
bank_data.city string Only when not SEPA City of the bank
bank_data.state string Only when not SEPA State of the bank
bank_data.country string Only when not SEPA Country of the bank
bank_data.country_iso string Only when not SEPA Country ISO 3166-1 alpha-2 of the bank
bank_data.sepa boolean Only when not SEPA SEPA or not
address Address Only when not SEPA Address of the beneficiary
address.street string Only when not SEPA Street of the beneficiary
address.zip string Only when not SEPA zip code
address.city string Only when not SEPA City of the beneficiary
address.country string Only when not SEPA Country of the beneficiary
social_security_number string false Beneficiary social security number
rib file false Rib attached to the beneficiary.

Example response

201 Response

{
  "id": 1,
  "label": "string",
  "short_tag": "GOPR",
  "iban": "FR7630001007941234567890185",
  "account_number_formatted": "FR76 3000 1007 9412 3456 7890 534",
  "bic": "string",
  "is_sepa": true,
  "phone_number": "0591731935",
  "email": "alex@manager.one",
  "comment": "string",
  "address": {
    "street": "48, Rue de la Vielle Ecole",
    "zip": "75116",
    "city": "Paris",
    "country": "France"
  },
  "social_security_number": "123456789",
  "rib": null,
  "validation": null,
  "bank_data": {
    "bic": "BOUSFRPPXXX",
    "bank": "BOURSORAMA",
    "street": "18 QUAI DU POINT DU JOUR",
    "zip": "92659",
    "city": "BOULOGNE BILLANCOURT",
    "state": "ILE-DE-FRANCE",
    "country": "FRANCE",
    "country_iso": "FR",
    "sepa": true
  }
}

Responses

Status Code 201 CREATED

Name Type Description
id integer Beneficiary ID
label string Name / social reason of the beneficiary
short_tag string Associated code
iban string IBAN
account_number_formatted string Formatted Account number
bic string BIC code
is_sepa boolean SEPA or not
phone_number string Beneficiary phone number
email string(email) Beneficiary email
comment string Comment on the beneficiary
address Address Address of the beneficiary
address.street string Street
address.zip string zip code
address.city string City
address.country string Country code
social_security_number string Beneficiary social security number
rib Document Rib of the beneficiary
rib.updated_at integer Date of update
rib.filename string filename of the document
rib.mime_type string MIME Type of the file
rib.url string URL to download the file if uploaded
validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
validation.id integer Id of the validation
validation.created_at integer Creation date
validation.updated_at integer Date of update
validation.status string Status of the validation of the beneficiary
validation.label string Type of the validation
validation.sub_label string Some information about the validation
validation.policy string Type of policy
validation.attempts integer Number of attempts
validation.allowed boolean Type of the validation
bank_data Iban Bank data of the beneficiary
bank_data.bic string Bank Identifier Code
bank_data.bank string Bank of the beneficiary
bank_data.street string Street of the bank
bank_data.zip string Zip code of the bank
bank_data.city string City of the bank
bank_data.state string State of the bank
bank_data.country string Country of the bank
bank_data.country_iso string Country code
bank_data.sepa boolean SEPA or not

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

View a beneficiary

Code samples

curl -X GET https://api-stg.manager.one/beneficiaries/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

View a beneficiary

Request

GET /beneficiaries/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true The beneficiary ID

Example response

201 Response

{
  "id": 1,
  "label": "string",
  "short_tag": "GOPR",
  "iban": "FR7630001007941234567890185",
  "account_number_formatted": "FR76 3000 1007 9412 3456 7890 534",
  "bic": "string",
  "is_sepa": true,
  "phone_number": "0591731935",
  "email": "alex@manager.one",
  "comment": "string",
  "address": {
    "street": "48, Rue de la Vielle Ecole",
    "zip": "75116",
    "city": "Paris",
    "country": "France"
  },
  "social_security_number": "123456789",
  "rib": null,
  "validation": null,
  "bank_data": {
    "bic": "BOUSFRPPXXX",
    "bank": "BOURSORAMA",
    "street": "18 QUAI DU POINT DU JOUR",
    "zip": "92659",
    "city": "BOULOGNE BILLANCOURT",
    "state": "ILE-DE-FRANCE",
    "country": "FRANCE",
    "country_iso": "FR",
    "sepa": true
  }
}

Responses

Status Code 200 OK

Name Type Description
id integer Beneficiary ID
label string Name / social reason of the beneficiary
short_tag string Associated code
iban string IBAN
account_number_formatted string Formatted Account number
bic string BIC code
is_sepa boolean SEPA or not
phone_number string Beneficiary phone number
email string(email) Beneficiary email
comment string Comment on the beneficiary
address Address Address of the beneficiary
address.street string Street
address.zip string zip code
address.city string City
address.country string Country code
social_security_number string Beneficiary social security number
rib Document Rib of the beneficiary
rib.updated_at integer Date of update
rib.filename string filename of the document
rib.mime_type string MIME Type of the file
rib.url string URL to download the file if uploaded
validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
validation.id integer Id of the validation
validation.created_at integer Creation date
validation.updated_at integer Date of update
validation.status string Status of the validation of the beneficiary
validation.label string Type of the validation
validation.sub_label string Some information about the validation
validation.policy string Type of policy
validation.attempts integer Number of attempts
validation.allowed boolean Type of the validation
bank_data Iban Bank data of the beneficiary
bank_data.bic string Bank Identifier Code
bank_data.bank string Bank of the beneficiary
bank_data.street string Street of the bank
bank_data.zip string Zip code of the bank
bank_data.city string City of the bank
bank_data.state string State of the bank
bank_data.country string Country of the bank
bank_data.country_iso string Country code
bank_data.sepa boolean SEPA or not

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found The beneficiary doesn't exist None

Update a beneficiary

Code samples

curl -X PUT https://api-stg.manager.one/beneficiaries/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Update a beneficiary

Request

PUT /beneficiaries/{id}

Body parameter

{
  "short_tag": "MONE",
  "comment": "some comment",
  "address": {
     "street": "1 rue de Paris",
     "zip": "75000",
     "city": "Paris",
     "country": "France"
  }
}

Parameters

Name In Type Required Description
label body string false Name / social reason of the beneficiary
short_tag body string false Associated code
phone_number body string false Beneficiary phone number
email body string(email) false User email
comment body string false Comment on the Beneficiary
beneficiary_list_id body integer false Id of the beneficiary_list
address body Address false Address of the beneficiary
address.street body string false Street of the beneficiary
address.zip body string false zip code
address.city body string false City of the beneficiary
address.country body string false Country of the beneficiary
social_security_number body string false Beneficiary social security number

Example response

200 Response

{
  "id": 1,
  "label": "string",
  "short_tag": "MONE",
  "iban": "FR7630001007941234567890185",
  "account_number_formatted": "FR76 3000 1007 9412 3456 7890 534",
  "bic": "string",
  "is_sepa": true,
  "phone_number": "0591731935",
  "email": "alex@manager.one",
  "comment": "Somme comment",
  "address": {
    "street": "1 rue de Paris",
    "zip": "75000",
    "city": "Paris",
    "country": "France"
  },
  "social_security_number": "123456789",
  "rib": null,
  "validation": null,
  "bank_data": {
    "bic": "BOUSFRPPXXX",
    "bank": "BOURSORAMA",
    "street": "18 QUAI DU POINT DU JOUR",
    "zip": "92659",
    "city": "BOULOGNE BILLANCOURT",
    "state": "ILE-DE-FRANCE",
    "country": "FRANCE",
    "country_iso": "FR",
    "sepa": true
  }
}

Responses

Status Code 200 OK

Name Type Description
id integer Beneficiary ID
label string Name / social reason of the beneficiary
short_tag string Associated code
iban string IBAN
account_number_formatted string Formatted Account number
bic string BIC code
is_sepa boolean SEPA or not
phone_number string Beneficiary phone number
email string(email) Beneficiary email
comment string Comment on the beneficiary
address Address Address of the beneficiary
address.street string Street
address.zip string zip code
address.city string City
address.country string Country code
social_security_number string Beneficiary social security number
rib Document Rib of the beneficiary
rib.updated_at integer Date of update
rib.filename string filename of the document
rib.mime_type string MIME Type of the file
rib.url string URL to download the file if uploaded
validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
validation.id integer Id of the validation
validation.created_at integer Creation date
validation.updated_at integer Date of update
validation.status string Status of the validation of the beneficiary
validation.label string Type of the validation
validation.sub_label string Some information about the validation
validation.policy string Type of policy
validation.attempts integer Number of attempts
validation.allowed boolean Type of the validation
bank_data Iban Bank data of the beneficiary
bank_data.bic string Bank Identifier Code
bank_data.bank string Bank of the beneficiary
bank_data.street string Street of the bank
bank_data.zip string Zip code of the bank
bank_data.city string City of the bank
bank_data.state string State of the bank
bank_data.country string Country of the bank
bank_data.country_iso string Country code
bank_data.sepa boolean SEPA or not

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

Delete a beneficiary

Code samples

curl -X DELETE https://api-stg.manager.one/beneficiaries/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Delete a beneficiary

Request

DELETE /beneficiaries/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true The beneficiary ID

Example response

204 Response

Responses

Status Code 204 No Content

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found The beneficiary doesn't exist NotFoundHttpException
500 Internal Server Error Unknown error when deleting the beneficiary ServerErrorHttpException

Get rib of beneficiary

Code samples

curl -X GET https://api-stg.manager.one/beneficiaries/{id}/rib \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Get the rib of a beneficiary (if a rib have been uploaded).

Request

GET /beneficiaries/{id}/rib

Parameters

Parameter In Type Required Description
id path integer(int32) true Beneficiary id

Example response

200 Response

Responses

Status Code 200 OK

Document

Name Type Description
ID integer ID of the document
updated_at integer Date of update
filename string Filename of the document
mime_type string MIME Type of the file
url string URL to download the file if uploaded

Beneficiary List

List of beneficiary lists

Code samples

curl -X GET https://api-stg.manager.one/beneficiary-lists \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Get all beneficiary lists

Request

GET /beneficiary-lists

Parameters

Parameter In Type Required Description
expand query string false List of other fields to return

Enumerated Values

Parameter Value
expand beneficiaries

Example response

200 Response

[
  {
    "id": 1,
    "label": "string",
    "comment": "string",
    "nb_beneficiaries": 2,
    "list_type": {
     "id": 1,
     "name":"Suppliers",
     "label":"Fournisseurs"
    }
  },
  {
    "id": 2,
    "label": "string",
    "comment": "string",
    "nb_beneficiaries": 5,
    "list_type": {
     "id": 1,
     "name":"Suppliers",
     "label":"Fournisseurs"
    }
  },
  {
    "id": 3,
    "label": "string",
    "comment": "string",
    "nb_beneficiaries": 3,
    "list_type": {
      "id": null,
      "name":"custom",
      "label":"custom"
    }
  },
  {...}
]

Responses

Status Code 200 OK

Array of Beneficiary List

Name Type Description
id integer BeneficiaryList ID
label string Label of the list
comment string Comment about the list
nb_beneficiaries integer Number of beneficiaries
list_type BeneficiaryListType Type of list
list_type.id integer Type of list
list_type.name string Name of the type
list_type.label string Name of the type translated (Only for default types)

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Create a beneficiary list

Code samples

curl -X POST https://api-stg.manager.one/beneficiary-lists \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Create a beneficiary list

Request

POST /beneficiary-lists

Body parameter

{
  "label": "string",
  "list_type": {
    "name": "string"
  }, 
  "comment": "string"
}

Parameters

Parameter In Type Required Description
label body string true Label of the list
list_type_id body string false ID of the type of list, if it already exists
list_type body BeneficiaryListType false List Type, if it does not exist or does not have an id
list_type.name body string false Name of the type of list
comment body string false Comment about the list

Example response

201 Response

{
  "id": 5,
  "label": "Developer",
  "comment": null,
  "nb_beneficiaries": 0,
  "list_type": {
    "id": null,
    "name": "freelance",
    "label": "freelance"
  }
}

Responses

Status Code 201 CREATED

Name Type Description
id integer BeneficiaryList ID
label string Label of the list
comment string Comment about the list
nb_beneficiaries integer Number of beneficiaries
list_type BeneficiaryListType Type of list
list_type.id integer Type of list
list_type.name string Name of the type
list_type.label string Name of the type translated (Only for default types)

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

View a beneficiary list

Code samples

curl -X GET https://api-stg.manager.one/beneficiary-lists/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

View a beneficiary list

Request

GET /beneficiary-lists/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true The beneficiary list ID
expand query array[string] false List of other fields to return

Enumerated Values

Parameter Value
expand beneficiaries

Example response

200 Response

{
  "id": 5,
  "label": "Developer",
  "comment": null,
  "nb_beneficiaries": 0,
  "list_type": {
    "id": null,
    "name": "freelance",
    "label": "freelance"
  }
}

Responses

Status Code 200 OK

Name Type Description
id integer BeneficiaryList ID
label string Label of the list
comment string Comment about the list
nb_beneficiaries integer Number of beneficiaries
list_type BeneficiaryListType Type of list
list_type.id integer Type of list
list_type.name string Name of the type
list_type.label string Name of the type translated (Only for default types)

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found The beneficiary list doesn't exist NotFoundHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Update a beneficiary list

Code samples

curl -X PUT https://api-stg.manager.one/beneficiary-lists/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Update a beneficiary list

Request

PUT /beneficiary-lists/{id}

Body parameter

{
  "label": "string",
  "list_type": {
    "name": "string"
  }, 
  "comment": "string"
}

Parameters

Parameter In Type Required Description
label body string true Label of the list
list_type_id body string false ID of the type of list, if it already exists
list_type body BeneficiaryListType false List Type, if it does not exist or does not have an id
list_type.name body string false Name of the type of list
comment body string false Comment about the list

Example response

200 Response

{
  "id": 5,
  "label": "Developer",
  "comment": null,
  "nb_beneficiaries": 0,
  "list_type": {
    "id": null,
    "name": "freelance",
    "label": "freelance"
  }
}

Responses

Status Code 200 OK

Name Type Description
id integer BeneficiaryList ID
label string Label of the list
comment string Comment about the list
nb_beneficiaries integer Number of beneficiaries
list_type BeneficiaryListType Type of list
list_type.id integer Type of list
list_type.name string Name of the type
list_type.label string Name of the type translated (Only for default types)

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found The beneficiary list doesn't exist NotFoundHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

Delete a beneficiary list

Code samples

curl -X DELETE https://api-stg.manager.one/beneficiary-lists/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Delete a beneficiary list

Request

DELETE /beneficiary-lists/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true The beneficiary list ID

Example response

204 Response

Responses

Status Code 204 No Content

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found The beneficiary list doesn't exist NotFoundHttpException
500 Internal Server Error Unknown error when deleting the beneficiary list ServerErrorHttpException

Document

Upload document

Code samples

curl -X POST https://api-stg.manager.one/documents?type=string \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'
  -F file="@/path/to/a/file.jpg"

Upload a document

Request

POST /documents

Parameters

Parameter In Type Required Description
type query string(int32) false Document type
file form-data file true The document to attach

Enumerated Values

Parameter Value
type document

Example response

200 Response

 {
   "id",
   "updated_at": 12345,
   "filename": "string",
   "mime_type": "string",
   "url": "string"
 }

Responses

Status Code 200 OK

Name Type Description
ID integer ID of the document
updated_at integer Date of update
filename string Filename of the document
mime_type string MIME Type of the file
url string URL to download the file if uploaded

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException

Get document

Code samples

curl -X GET https://api-stg.manager.one/documents/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Get a document by id

Request

GET /documents/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true Document ID

Example response

200 Response

Responses

The file

Status Code 200 OK

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found The document doesn't exist NotFoundHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Update document

Code samples

curl -X POST https://api-stg.manager.one/documents/{id} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'
  -F file="@/path/to/a/file.jpg"

Update a document

Request

POST /documents/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true Id of the document
file form-data file true The document to attach

Enumerated Values

Parameter Value
type document

Example response

200 Response

Responses

Status Code 200 OK

The file

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found The document doesn't exist NotFoundHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Delete document by id

Code samples

curl -X DELETE https://api-stg.manager.one/documents/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Delete a document uploaded

Request

DELETE /documents/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true Document ID

Example response

404 Response

Responses

Status Code 204 No Content

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
404 Not Found The document doesn't exist NotFoundHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Periodic Transfer

List of periodic transfers

Code samples

curl -X GET https://api-stg.manager.one/periodic-transfers \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Get list of periodic transfers

Request

GET /periodic-transfers

Parameters

Parameter In Type Required Description
search query string false Text to search
status query string false Status
from query string(date) false From date (eq: 2017-01-01)
to query string(date) false To date (eq: 2017-01-31)
min query number(double) false The minimum amount to looking for
max query number(double) false The maximum amount to looking for

Example response

200 Response

[
  {
    "id": 1,
    "created_at": 123456789,
    "updated_at": 123456789,
    "type": "periodic",
    "amount": 123,
    "currency": "EUR",
    "label": "G Suite",
    "comment": null,
    "start_date": "2018-01-01",
    "end_date": "2018-12-31",
    "enabled": true,
    "beneficiary": {
      "id": 123,
      "label": "Simone-Lorraine Toussaint",
      "short_tag": "GOPR",
      "iban": "FR7630001007941234567890185",
      "account_number_formatted": "FR76 3000 1007 9412 3456 7890 185",
      "bic": "string",
      "is_sepa": true,
      "phone_number": "0591731935",
      "email": "alex@manager.one",
      "comment": "string",
      "address": {
        "street": "56, boulevard Louise Maillet",
        "zip": "75002",
        "city": "PARIS 02",
        "country": "FR"
      },
      "social_security_number": "123456789",
      "rib": null,
      "validation": {
        "id": 194,
        "created_at": 1542723785,
        "updated_at": 1542921574,
        "status": "accepted",
        "label": "Ajout de bénéficiaire",
        "sub_label": "Simone-Lorraine Toussaint",
        "policy": "simple",
        "attempts": 0,
        "allowed": false
      },
      "bank_data": {
        "bic": "BOUSFRPPXXX",
        "bank": "BOURSORAMA",
        "street": "18 QUAI DU POINT DU JOUR",
        "zip": "92659",
        "city": "BOULOGNE BILLANCOURT",
        "state": "ILE-DE-FRANCE",
        "country": "FRANCE",
        "country_iso": "FR",
        "sepa": true
      }
    },
    "user": {
      "uuid": "b63gf4c3-4d7e-4a56-ac29-76f0e74gddc1",
      "id": 14,
      "gender": 1,
      "gender_label": "Monsieur",
      "first_name": "Adrien",
      "last_name": "Herbert",
      "email": "adrien.herbert@manager.one"
    },
    "status": "active",
    "statusLabel": "Actif",
    "period": "weekly",
    "send_notification": true
  },
  {...}
]

Response

Status Code 200 OK

List of periodic transfers

Name Type Description
id integer permanent transfer id
created_at integer creation date
updated_at integer Date of update
type string permanent transfer type
amount number(double) amount value
currency string currency iso label
label string comment or reference
comment string Comment on the transfer
start_date string Date of update
end_date string Date of update
enabled boolean current status
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
user User User who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
user User Service who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
o_auth_service OAuthService Service who create the service
o_auth_service.name string name of the service
status string State of the transfer
status_label string State of the transfer translated
period string Period of the transfer
send_notification boolean Send a notification to the beneficiary

Enumerated Values

Property Value Description
type periodic Periodic transfer
currency EUR Euro
currency USD Dollar
currency GBP Pound
status active Transfer is enabled
status suspended Transfer has been suspended
period weekly Weekly Transfer
period monthly Monthly Transfer
period quarterly Quarterly Transfer
period biannual Biannual Transfer
period annual Annual Transfer

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Create a periodic transfer

Code samples

curl -X POST https://api-stg.manager.one/periodic-transfers \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Create a periodic transfer

Request

POST /periodic-transfers

Body parameter

{
  "amount": 100.54,
  "currency": "EUR",
  "label": "transfer label",
  "comment": "transfer comment",
  "beneficiary_id": 1,
  "start_date": "2018-01-01",
  "end_date": "2018-12-31",
  "period": "weekly",
  "send_notification": "true"
}

Parameters

Parameter In Type Required Description
amount body number(double) true Amount of the transfer
currency body string true EUR/USD etc..
label body string false Transfer label
comment body string false Comment or reference
beneficiary_id body integer true ID of beneficiary
start_date body ISO date/time true Date of the first transfer
end_date body ISO date/time true ID of beneficiary
period body string true Period of the transfer
send_notification body boolean false Send a notification to the beneficiary

Enumerated Values

Property Value Description
currency EUR Euro
currency USD Dollar
currency GBP Pound
period weekly Weekly Transfer
period monthly Monthly Transfer
period quarterly Quarterly Transfer
period biannual Biannual Transfer
period annual Annual Transfer

Example response

200 Response

{
    "id": 1,
    "created_at": 123456789,
    "updated_at": 123456789,
    "type": "periodic",
    "amount": 100.54,
    "currency": "EUR",
    "label": "transfer label",
    "comment": "transfer comment",
    "start_date": "2018-01-01",
    "end_date": "2018-12-31",
    "enabled": true,
    "beneficiary": {
      "id": 1,
      "label": "Simone-Lorraine Toussaint",
      "short_tag": "GOPR",
      "iban": "FR7630001007941234567890185",
      "account_number_formatted": "FR76 3000 1007 9412 3456 7890 185",
      "bic": "string",
      "is_sepa": true,
      "phone_number": "0591731935",
      "email": "alex@manager.one",
      "comment": "string",
      "address": {
        "street": "56, boulevard Louise Maillet",
        "zip": "75002",
        "city": "PARIS 02",
        "country": "FR"
      },
      "social_security_number": "123456789",
      "rib": null,
      "validation": {
        "id": 194,
        "created_at": 1542723785,
        "updated_at": 1542921574,
        "status": "accepted",
        "label": "Ajout de bénéficiaire",
        "sub_label": "Simone-Lorraine Toussaint",
        "policy": "simple",
        "attempts": 0,
        "allowed": false
      },
      "bank_data": {
        "bic": "BOUSFRPPXXX",
        "bank": "BOURSORAMA",
        "street": "18 QUAI DU POINT DU JOUR",
        "zip": "92659",
        "city": "BOULOGNE BILLANCOURT",
        "state": "ILE-DE-FRANCE",
        "country": "FRANCE",
        "country_iso": "FR",
        "sepa": true
      }
    },
    "o_auth_service": {
      "name": "test_service"
    },
    "status": "active",
    "statusLabel": "Actif",
    "period": "weekly",
    "send_notification": true
  }

Responses

Status Code 200 OK

Periodic transfer

Name Type Description
id integer permanent transfer id
created_at integer creation date
updated_at integer Date of update
type string permanent transfer type
amount number(double) amount value
currency string currency iso label
label string comment or reference
comment string Comment on the transfer
start_date string Date of update
end_date string Date of update
enabled boolean current status
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
user User User who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
user User Service who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
o_auth_service OAuthService Service who create the service
o_auth_service.name string name of the service
status string State of the transfer
status_label string State of the transfer translated
period string Period of the transfer
send_notification boolean Send a notification to the beneficiary

Enumerated Values

Property Value Description
type periodic Periodic transfer
currency EUR Euro
currency USD Dollar
currency GBP Pound
status active Transfer is enabled
status suspended Transfer has been suspended
period weekly Weekly Transfer
period monthly Monthly Transfer
period quarterly Quarterly Transfer
period biannual Biannual Transfer
period annual Annual Transfer

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

Get a periodic transfer

Code samples

curl -X GET https://api-stg.manager.one/periodic-transfers/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Return a specific user periodic transfer

Request

GET /periodic-transfers/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true The periodic transfer ID

Example response

200 Response

{
    "id": 1,
    "created_at": 123456789,
    "updated_at": 123456789,
    "type": "periodic",
    "amount": 100.54,
    "currency": "EUR",
    "label": "transfer label",
    "comment": "transfer comment",
    "start_date": "2018-01-01",
    "end_date": "2018-12-31",
    "enabled": true,
    "beneficiary": {
      "id": 1,
      "label": "Simone-Lorraine Toussaint",
      "short_tag": "GOPR",
      "iban": "FR7630001007941234567890185",
      "account_number_formatted": "FR76 3000 1007 9412 3456 7890 185",
      "bic": "string",
      "is_sepa": true,
      "phone_number": "0591731935",
      "email": "alex@manager.one",
      "comment": "string",
      "address": {
        "street": "56, boulevard Louise Maillet",
        "zip": "75002",
        "city": "PARIS 02",
        "country": "FR"
      },
      "social_security_number": "123456789",
      "rib": null,
      "validation": {
        "id": 194,
        "created_at": 1542723785,
        "updated_at": 1542921574,
        "status": "accepted",
        "label": "Ajout de bénéficiaire",
        "sub_label": "Simone-Lorraine Toussaint",
        "policy": "simple",
        "attempts": 0,
        "allowed": false
      },
      "bank_data": {
        "bic": "BOUSFRPPXXX",
        "bank": "BOURSORAMA",
        "street": "18 QUAI DU POINT DU JOUR",
        "zip": "92659",
        "city": "BOULOGNE BILLANCOURT",
        "state": "ILE-DE-FRANCE",
        "country": "FRANCE",
        "country_iso": "FR",
        "sepa": true
      }
    },
    "o_auth_service": {
      "name": "test_service"
    },
    "status": "active",
    "statusLabel": "Actif",
    "period": "weekly",
    "send_notification": true
  }

Responses

Status Code 200 OK

Periodic transfer

Name Type Description
id integer permanent transfer id
created_at integer creation date
updated_at integer Date of update
type string permanent transfer type
amount number(double) amount value
currency string currency iso label
label string comment or reference
comment string Comment on the transfer
start_date string Date of update
end_date string Date of update
enabled boolean current status
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
user User User who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
user User Service who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
o_auth_service OAuthService Service who create the service
o_auth_service.name string name of the service
status string State of the transfer
status_label string State of the transfer translated
period string Period of the transfer
send_notification boolean Send a notification to the beneficiary

Enumerated Values

Property Value Description
type periodic Periodic transfer
currency EUR Euro
currency USD Dollar
currency GBP Pound
status active Transfer is enabled
status suspended Transfer has been suspended
period weekly Weekly Transfer
period monthly Monthly Transfer
period quarterly Quarterly Transfer
period biannual Biannual Transfer
period annual Annual Transfer

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Update a periodic transfer

Code samples

curl -X PUT https://api-stg.manager.one/periodic-transfers/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Update a periodic transfer

Request

PUT /periodic-transfers/{id}

Body parameter

{
  "amount": "100,12",
  "currency": "EUR",
  "label": "transfer label",
  "comment": "transfer comment",
  "enabled": true,
  "end_date": "2018-12-31",
  "send_notification": "true"
}

Parameters

Parameter In Type Required Description
id path integer(int32) true The transfer ID
amount body number(double) false Amount of the transfer
currency body string false EUR/USD etc..
label body string false Transfer label
comment body string false Comment or reference
enabled body boolean false Enable or stop the periodic transfer
end_date body ISO date/time false ID of beneficiary
send_notification body boolean false Send a notification to the beneficiary

Example response

200 Response

{
    "id": 1,
    "created_at": 123456789,
    "updated_at": 123456789,
    "type": "periodic",
    "amount": 100.54,
    "currency": "EUR",
    "label": "transfer label",
    "comment": "transfer comment",
    "start_date": "2018-01-01",
    "end_date": "2018-12-31",
    "enabled": true,
    "beneficiary": {
      "id": 1,
      "label": "Simone-Lorraine Toussaint",
      "short_tag": "GOPR",
      "iban": "FR7630001007941234567890185",
      "account_number_formatted": "FR76 3000 1007 9412 3456 7890 185",
      "bic": "string",
      "is_sepa": true,
      "phone_number": "0591731935",
      "email": "alex@manager.one",
      "comment": "string",
      "address": {
        "street": "56, boulevard Louise Maillet",
        "zip": "75002",
        "city": "PARIS 02",
        "country": "FR"
      },
      "social_security_number": "123456789",
      "rib": null,
      "validation": {
        "id": 194,
        "created_at": 1542723785,
        "updated_at": 1542921574,
        "status": "accepted",
        "label": "Ajout de bénéficiaire",
        "sub_label": "Simone-Lorraine Toussaint",
        "policy": "simple",
        "attempts": 0,
        "allowed": false
      },
      "bank_data": {
        "bic": "BOUSFRPPXXX",
        "bank": "BOURSORAMA",
        "street": "18 QUAI DU POINT DU JOUR",
        "zip": "92659",
        "city": "BOULOGNE BILLANCOURT",
        "state": "ILE-DE-FRANCE",
        "country": "FRANCE",
        "country_iso": "FR",
        "sepa": true
      }
    },
    "o_auth_service": {
      "name": "test_service"
    },
    "status": "active",
    "statusLabel": "Actif",
    "period": "weekly",
    "send_notification": true
  }

Responses

Status Code 200 OK

Periodic transfer

Name Type Description
id integer permanent transfer id
created_at integer creation date
updated_at integer Date of update
type string permanent transfer type
amount number(double) amount value
currency string currency iso label
label string comment or reference
comment string Comment on the transfer
start_date string Date of update
end_date string Date of update
enabled boolean current status
beneficiary Beneficiary Beneficiary of the transfer
beneficiary.id integer Beneficiary ID
beneficiary.label string Name / social reason of the beneficiary
beneficiary.short_tag string Associated code
beneficiary.iban string IBAN
beneficiary.account_number_formatted string Formatted Account number
beneficiary.bic string BIC code
beneficiary.is_sepa boolean SEPA or not
beneficiary.phone_number string Beneficiary phone number
beneficiary.email string(email) Beneficiary email
beneficiary.comment string Comment on the beneficiary
beneficiary.address Address Address of the beneficiary
beneficiary.address.street string Street of the beneficiary
beneficiary.address.zip string zip code
beneficiary.address.city string City of the beneficiary
beneficiary.address.country string Country of the beneficiary
beneficiary.social_security_number string Beneficiary social security number
beneficiary.rib Document Rib of the beneficiary
beneficiary.rib.updated_at integer Date of update
beneficiary.rib.filename string filename of the document
beneficiary.rib.mime_type string MIME Type of the file
beneficiary.rib.url string URL to download the file if uploaded
beneficiary.validation Validation Validation of the beneficiary. This is related to the level of security sets by the account owner. If the option is enabled, the beneficiary must be validated by the owner
beneficiary.validation.id integer Id of the validation
beneficiary.validation.created_at integer Creation date
beneficiary.validation.updated_at integer Date of update
beneficiary.validation.status string Status of the validation of the beneficiary
beneficiary.validation.label string Type of the validation
beneficiary.validation.sub_label string Some information about the validation
beneficiary.validation.policy string Type of policy
beneficiary.validation.attempts integer Number of attempts
beneficiary.validation.allowed boolean Type of the validation
beneficiary.bank_data Iban Bank data of the beneficiary
beneficiary.bank_data.bic string Bank Identifier Code
beneficiary.bank_data.bank string Bank of the beneficiary
beneficiary.bank_data.street string Street of the bank
beneficiary.bank_data.zip string Zip code of the bank
beneficiary.bank_data.city string City of the bank
beneficiary.bank_data.state string State of the bank
beneficiary.bank_data.country string Country of the bank
beneficiary.bank_data.country_iso string Country ISO 3166-1 alpha-2 of the bank
beneficiary.bank_data.sepa boolean SEPA or not
user User User who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
user User Service who created the transfer
user.uuid string User Unique identifier
user.id integer ID of the user
user.gender integer int match gender type
user.gender_label string gender type
user.first_name string User first name
user.last_name string User last name
user.email string(email) User email
o_auth_service OAuthService Service who create the service
o_auth_service.name string name of the service
status string State of the transfer
status_label string State of the transfer translated
period string Period of the transfer
send_notification boolean Send a notification to the beneficiary

Enumerated Values

Property Value Description
type periodic Periodic transfer
currency EUR Euro
currency USD Dollar
currency GBP Pound
status active Transfer is enabled
status suspended Transfer has been suspended
period weekly Weekly Transfer
period monthly Monthly Transfer
period quarterly Quarterly Transfer
period biannual Biannual Transfer
period annual Annual Transfer

Errors

Status Meaning Description Schema
403 Forbidden Not authorized ForbiddenHttpException
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

Delete a periodic transfer

Code samples

curl -X DELETE https://api-stg.manager.one/periodic-transfers/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization:Bearer TOKEN'

Delete a periodic transfer

Request

DELETE /periodic-transfers/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true The transfer ID

Example response

204 Response

Responses

Status Code 204 No Content

Errors

Status Meaning Description Schema
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

Sign-up

This API allows you to create new requests to register new manager.one accounts.

The Sign up workflow is divided into 4 steps :

  1. Create a Sign up request with all the information that you have.

  2. Upload all required documents in your possession.

  3. Redirect the user to our dynamic form to complete the Sign up. The form will check the Sign up request and generate the form fields for the missing data.

  4. The user complete the fields in our form and finish his Sign up.

  5. The user is redirected to your website.

The sign-up objects

This is a list of all objects used in the Sign up API.

SignUpRequest

Request to register a new manager.one account.

Name Type Description
id string Id of the sign-up request
redirect_uri string URI to redirect the user after the end of the sign-up
form_url string URL of the form to complete the sign-up
user User User of the account
company Company Company of the account
stakeholders Array of stakeholders Stakeholders of the company

User

User of the account.

Name Type Description
gender integer Gender of the user
first_name string First name of the user
last_name string Last name of the user
email string Email of the user
phone string Phone of the user

Company

Company of the account.

Name Type Description
registration_type string Type of registration, existing_company or new_company
name string Company name
legal_form LegalForm Legal form
address Address Address of the company
phone string Phone of the company
capital_amount interger Capital amount
up_capital_amount integer Paid-up capital amount
number_of_actions integer Number of actions of the company
siret string SIRET
status Document Status of the company
proof_of_address Document Proof of address of the company
kbis Document Kbis of the company
proof_of_activity Document Proof of activity of the company
draft_status Document Draft status of the company

Stakeholder

Stakeholder of the company.

Name Type Description
id string Unique identifer of the stakeholder
is_physical boolean Physical or legal person
is_beneficial_owner boolean Is beneficial owner of the company
is_company_officer boolean Is company officer of the company
number_of_actions integer Number of actions of the stakeholder
title string Job title
legal_person LegalPerson Information about the legal person stakeholder
physical_person PhysicalPerson Information about the physical person stakeholder

PhysicalPerson

Information about a physical person.

Name Type Description
gender boolean Gender of the stakeholder
first_name string First name
last_name string Last name
birth_date string Birth date
birth_city string Birth city
nationnality string Nationality
is_pep boolean Is political exposed person
address Address Address of the stakeholder
email string email
marital_status string Marital status

Information about a legal person.

Name Type Description
company_name string Company name
siret string SIRET
legal_form LegalForm Legal form
address Address Address
phone string Phone
email string Email
company_officer_name string Company officer name

Address

Name Type Description
street string Street
zip string Zip code
city string City
country string ISO Alpha 2 code of the country

Legal form of a company.

Name Type Description
code integer INSEE code

Document

Name Type Description
id integer Id of the document
updated_at integer Date of update
filename string Filename of the document
mime_type string MIME Type of the file
url string URL to download the file if uploaded

1. Create a sign-up-request

The first step of the Sign up is to create a new Sign up request.

Companies and stakeholders have two different models, one for existing companies and the other one for new companies, make sure to use the right model.

Fields flagged as not required are not mandatory to create the request, but they will need to be fulfilled to finish the sign up process.

For a better user experience, send all the information that you have in the request. All the missing data will need to be completed by the user in the dynamic form.

Request

Code samples

curl -X POST https://api-stg.manager.one/sign-up/request \

Body parameter new company

{
  "redirect_uri": "string",
    "user": {
      "gender": 1,
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone": "string"
    },
  "company": {
    "registration_type": "new_company",
    "name": "string",
    "legal_form": {
      "code": 5510,
    },
    "address": {
      "street": "string",
      "zip": "string",
      "city": "string",
      "country": "FR"
    },
    "phone": "string",
    "capital_amount": 100000,
    "up_capital_amount": null,
    "number_of_actions": 100
  },
  "stakeholders": [
    {
      "is_physical": true,
      "is_beneficial_owner": true,
      "is_company_officer": true,
      "number_of_actions": 30,
      "title": "PRE",
      "physical_person": {
        "gender": 2,
        "first_name": "string",
        "last_name": "string",
        "birth_date": "1972-12-22",
        "birth_city": "string",
        "nationality": "FR",
        "is_pep": false
        "address": {
          "street": "string",
          "zip": "string",
          "city": "string",
          "country": "FR"
        },
        "email": "string",
        "marital_status": "string",
      }
    },
    {
      "is_physical": false,
      "is_beneficial_owner": true,
      "is_company_officer": true,
      "number_of_actions": 40,
      "legal_person": {
        "company_name": "string",
        "siret": "string",
        "legal_form": {
          "code": 5410,
        }
        "address": {
          "street": "string",
          "zip": "string",
          "city": "string",
          "country": "FR"
        },
        "phone": "string",
        "email": "string",
        "company_officer_name": "string",
      }
    }
  ]
}

POST /sign-up/request

Parameters

Name Type Required Description
redirect_uri string false URI to redirect the user after the end of the sign-up
user User true User of the account
company Company true Company of the account
stakeholders Array of stakeholders false Stakeholders of the company

User parameters

Name Type Required Description
gender integer false Gender of the user
first_name string true First name of the user
last_name string true Last name of the user
email string true Email of the user
phone string false Phone of the user

Company parameters

Existing company

Name Type Required Description
registration_type string true Type of registration
name string true Company name
legal_form LegalForm false Legal form
legal_form.code integer false INSEE code
address Address true Address of the company
address.street string true Street
address.zip string true Zip code
address.city string true City
address.country string true ISO Alpha 2 code of the country
phone string false phone of the company
siret string false SIRET


New company

Name Type Required Description
registration_type string true Type of registration
name string true Company name
legal_form LegalForm false Legal form
legal_form.code integer false INSEE code
address Address true Address of the company
address.street string true Street
address.zip string true Zip code
address.city string true City
address.country string true ISO Alpha 2 code of the country
phone string false phone
capital_amount interger false Capital amount
up_capital_amount integer false Paid-up capital amount
number_of_actions integer false Number of actions of the company

Enumerated Values

Parameter Value
type_of_registration existing_company
type_of_registration new_company

Stakeholders parameters

The user should be a stakeholder of the company.

Physical Stakeholder for existing companies

Name Type Required Description
is_physical boolean true Physical or legal person
is_beneficial_owner boolean false Is beneficial owner of the company
is_company_officer boolean false Is company officer of the company
physical_person PhysicalPerson true Information about the physical person
physical_person.gender boolean false Gender
physical_person.first_name string false First name
physical_person.last_name string true Last name
physical_person.birth_date string false Birth date
physical_person.birth_city string false Birth city
physical_person.nationality string false Nationality
physical_person.is_pep boolean false Is political exposed person


Physical Stakeholder for new companies

Name Type Required Description
is_physical boolean true Physical or legal person
is_beneficial_owner boolean false Is beneficial owner of the company
is_company_officer boolean false Is company officer of the company
number_of_actions integer false Number of actions of the stakeholder
title string false Job title
physical_person PhysicalPerson true Information about the physical person
physical_person.gender boolean false Gender of the stakeholder
physical_person.first_name string false First name
physical_person.last_name string true Last name
physical_person.birth_date string false Birth date
physical_person.birth_city string false Birth city
physical_person.nationnality string false Nationality
physical_person.is_pep boolean false Is political exposed person
physical_person.address Address false Address of the stakeholder
physical_person.address.street string false Street
physical_person.address.zip string false Zip code
physical_person.address.city string false City
physical_person.address.country string false ISO Alpha 2 code of the country
physical_person.email string false email
physical_person.marital_status string false Marital status


Legal Person Stakeholder for existing companies

Name Type Required Description
is_physical boolean true Physical or legal person
is_beneficial_owner boolean false Is beneficial owner
is_company_officer boolean false Is company officer of the company
legal_person LegalPerson true Information about the legal person
legal_person.company_name string true Company name
legal_person.siret string false SIRET
legal_person.legal_form LegalForm false Legal form
legal_person.legal_form.code integer false INSEE code
legal_person.address Address false Address
legal_person.address.street string false Street
legal_person.address.zip string false Zip code
legal_person.address.city string false City
legal_person.address.country string false ISO Alpha 2 code of the country
legal_person.phone string false Phone


Legal Person Stakeholder for new companies

Name Type Required Description
is_physical boolean true Physical or legal person
is_beneficial_owner boolean false Is beneficial owner
is_company_officer boolean false Is company officer of the company
number_of_actions integer false Number of actions of the stakeholder
legal_person LegalPerson true Information about the legal person
legal_person.company_name string true Company name
legal_person.siret string false SIRET
legal_person.legal_form LegalForm false Legal form
legal_person.legal_form.code integer false INSEE code
legal_person.address Address false Address
legal_person.address.street string false Street
legal_person.address.zip string false Zip code
legal_person.address.city string false City
legal_person.address.country string false ISO Alpha 2 code of the country
legal_person.phone string false Phone
legal_person.email string false Email
legal_person.company_officer_name string false Company officer name

Example response:

200

{
  "id": "string",
  "redirect_uri": "http:\/\/www.test.com",
  "form_url": "http:\/\/signup-partenaire.recette.manager.one?id={{string}}",
  "user": {
    "gender": 1,
    "gender_label": "string",
    "first_name": "string",
    "last_name": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "proof_of_address": null,
    "identity_card": null,
  },
  "company": {
    "name": "string",
    "siret": "string",
    "phone": "string",
    "address": {
      "street": "string",
      "zip": "string",
      "city": "string",
      "country": "FR"
    },
    "registration_type": "existing_company",
    "legal_form": {
      "label": "SA nationale \u00e0 conseil d'administration",
      "code": 5510,
      "abbreviation": "SA",
      "is_ei": false
    },
    "status": null,
    "kbis": null,
  },
  "stakeholders": [
    {
      "id": "string",
      "is_physical": true,
      "is_beneficial_owner": true,
      "is_company_officer": true,
      "physical_person": {
        "gender": 1,
        "gender_label": "string",
        "birth_city": "string",
        "birth_date": "1907-05-27",
        "first_name": "string",
        "last_name": "string",
        "nationality": "BE",
        "is_pep": true,
        "identity_card": null,
      }
    },
    {
      "id": "string",
      "is_physical": false,
      "is_beneficial_owner": false,
      "is_company_officer": false,
      "legal_person": {
        "siret": "string",
        "company_name": "string",
        "phone": "string",
        "legal_form": {
          "label": "SARL nationale",
          "code": 5410,
          "abbreviation": "SARL",
          "is_ei": false
        },
        "address": {
          "street": "string",
          "zip": "string",
          "city": "string",
          "country": "FR"
        }
        "company_kbis": null,
      }
    }
  ]
}

Responses

Status Code 200 OK

Returns a SignUpRequest object

Errors

Status Meaning Description Schema
422 Unprocessable Entity Validation error FieldsValidationErrors
500 Internal Server Error Unknown error ServerErrorHttpException

2. Upload the documents

Some supporting documents are required to complete the Sign up.

No document is required to create the request, but they will be needed to complete the onboarding.

If you do not have all of them, you can upload some of the documents and the user will upload the other ones in the dynamic form.

User documents

Required documents related to the user of the account.

Code samples

curl -X POST https://api-stg.manager.one/sign-up/request/user/proof_of_identity \
     -H 'Content-Type: multipart/form-data' \
     -H 'Accept: application/json' \
     -H 'X-Sign-up-request=081B7439-58AE-4C23-9A5C-9FB8CF331B05'
     -F file="@/path/to/a/file.jpg"

Request

POST /sign-up/request/user/{document_type}

Required documents

Document type
proof_of_identity
proof_of_address

Responses

Example response

200

 {
   "id",
   "updated_at": 12345,
   "filename": "string",
   "mime_type": "string",
   "url": "string"
 }

Status Code 200 OK

Returns a Document object

Errors

Status Meaning Description Schema
404 Not Found Sign-up request not found NotFoundHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Company documents

Required documents related to the company ot the account.

Code samples

curl -X POST https://api-stg.manager.one/sign-up/request/company/status \
     -H 'Content-Type: multipart/form-data' \
     -H 'Accept: application/json' \
     -H 'X-Sign-up-request=081B7439-58AE-4C23-9A5C-9FB8CF331B05'
     -F file="@/path/to/a/file.jpg"

Request

POST /sign-up/request/company/{document_type}

Required documents

Document type Existing company New company EI Association
proof_of_address required required required required
status required - - required
draft_status - required - -
proof_of_activity - - required -
kbis required - - -

Responses

Example response

200

 {
   "id",
   "updated_at": 12345,
   "filename": "string",
   "mime_type": "string",
   "url": "string"
 }

Status Code 200 OK

Returns a Document object

Errors

Status Meaning Description Schema
404 Not Found Sign-up request not found NotFoundHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

Stakeholders documents

Required documents related to stakeholders of the company.

Code samples

curl -X POST https://api-stg.manager.one/sign-up/request/stakeholders/company_kbis \
     -H 'Content-Type: multipart/form-data' \
     -H 'Accept: application/json' \
     -H 'X-Sign-up-request=081B7439-58AE-4C23-9A5C-9FB8CF331B05'
     -F file="@/path/to/a/file.jpg"

Request

POST /sign-up/request/stakeholders/{document_type}

Required documents

Document type Physical person Legal person
proof_of_identity required -
company_kbis - required

Responses

Example response

200

 {
   "id",
   "updated_at": 12345,
   "filename": "string",
   "mime_type": "string",
   "url": "string"
 }

Status Code 200 OK

Returns a Document object

Errors

Status Meaning Description Schema
404 Not Found Sign-up request not found NotFoundHttpException
500 Internal Server Error Unknown error ServerErrorHttpException

3. Redirect the user

Once you have created the request, you can redirect the user to the dynamic form to complete the Sign up.

The URL of the dynamic form is returned in the Sign up request.

The user will finish his Sign up by completing the missing information.

Even if you provided all the information, the user will have to complete his password and validate the terms.

alt text

4. Go back on your website

If you provided a redirect_uri, the user will be redirected to your website at the end of the Sign up.

alt text

Resources

Marital status

Marital status
Célibataire
Marié(e)
Concubinage
Pacsé(e)
Séparé(e)
Divorcé(e)
Veuf(ve)
Non communiqué


Job title

Title Label French label
DGE Director-General Directeur général
DIR Director Directeur
GER Managing director Gérant
MDJ Legal Representative Mandataire judiciaire
PRE President Président
RCT Representative of local authorities Représentant de collectivité territoriale
NON Corporate officer Non mandataire
ZAU Other Autre


Code Label Abbreviation
1100 Auto-Entrepreneur AE
5498 Entreprise unipersonnelle à responsabilité limitée EURL
1000 Entreprise individuelle à responsabilité limitée (01.01.2010) EIRL
5410 Société à responsabilité limitée SARL
5510 Société anonyme SA
5710 Société par actions simplifiée SAS
5720 Société par actions simplifiée unipersonnelle SASU
5785 Société d'exercice libéral SEL
6540 Société civile immobilièrer SCI
9220 Association AS
1000 Entreprise individuelle EI
6598 Entreprise agricole à responsabilité limitée EARL
6533 Groupement agricole d'exploitation en commun GAEC
6210 Groupement européen d'intérêt économique GEIE
6220 Groupement d'intérêt économique GIE
6599 Société civile SC
5308 Société en commandite par actions SCA
5460 Autre SARL coopérative COOP
6589 Société civile de moyens SCM
5458 Société coopérative ouvrière de production SCOP
6585 Société civile professionnelle SCP
5306 Société en commandite simple SCS
5585 Société d'exercice libéral à forme anonyme SELAFA
5485 Société d'exercice libéral à responsabilité limitée SELARL
5785 Société d'exercice libéral par actions simplifiée SELAS
5385 Société d'exercice libéral en commandite par actions SELCA
0 Société d'économie mixte SEM
0 Société d'économie mixte locale SEML
2310 Société en participation SEP
5632 Société d'intérêt collectif agricole SICA
5202 Société en nom collectif SNC
3120 Société commerciale étrangère immatriculée au RCS PMDEIRCS
3220 Société étrangère non immatriculée au RCS PMDENRCS

Country codes

Country Alpha-2 code
Afghanistan AF
Albania AL
Algeria DZ
American Samoa AS
Andorra AD
Angola AO
Anguilla AI
Antarctica AQ
Antigua and Barbuda AG
Argentina AR
Armenia AM
Aruba AW
Australia AU
Austria AT
Azerbaijan AZ
Bahamas (the) BS
Bahrain BH
Bangladesh BD
Barbados BB
Belarus BY
Belgium BE
Belize BZ
Benin BJ
Bermuda BM
Bhutan BT
Bolivia (Plurinational State of) BO
Bonaire, Sint Eustatius and Saba BQ
Bosnia and Herzegovina BA
Botswana BW
Bouvet Island BV
Brazil BR
British Indian Ocean Territory (the) IO
Brunei Darussalam BN
Bulgaria BG
Burkina Faso BF
Burundi BI
Cabo Verde CV
Cambodia KH
Cameroon CM
Canada CA
Cayman Islands (the) KY
Central African Republic (the) CF
Chad TD
Chile CL
China CN
Christmas Island CX
Cocos (Keeling) Islands (the) CC
Colombia CO
Comoros (the) KM
Congo (the Democratic Republic of the) CD
Congo (the) CG
Cook Islands (the) CK
Costa Rica CR
Croatia HR
Cuba CU
Curaçao CW
Cyprus CY
Czechia CZ
Côte d'Ivoire CI
Denmark DK
Djibouti DJ
Dominica DM
Dominican Republic (the) DO
Ecuador EC
Egypt EG
El Salvador SV
Equatorial Guinea GQ
Eritrea ER
Estonia EE
Eswatini SZ
Ethiopia ET
Falkland Islands (the) [Malvinas] FK
Faroe Islands (the) FO
Fiji FJ
Finland FI
France FR
French Guiana GF
French Polynesia PF
French Southern Territories (the) TF
Gabon GA
Gambia (the) GM
Georgia GE
Germany DE
Ghana GH
Gibraltar GI
Greece GR
Greenland GL
Grenada GD
Guadeloupe GP
Guam GU
Guatemala GT
Guernsey GG
Guinea GN
Guinea-Bissau GW
Guyana GY
Haiti HT
Heard Island and McDonald Islands HM
Holy See (the) VA
Honduras HN
Hong Kong HK
Hungary HU
Iceland IS
India IN
Indonesia ID
Iran (Islamic Republic of) IR
Iraq IQ
Ireland IE
Isle of Man IM
Israel IL
Italy IT
Jamaica JM
Japan JP
Jersey JE
Jordan JO
Kazakhstan KZ
Kenya KE
Kiribati KI
Korea (the Democratic People's Republic of) KP
Korea (the Republic of) KR
Kuwait KW
Kyrgyzstan KG
Lao People's Democratic Republic (the) LA
Latvia LV
Lebanon LB
Lesotho LS
Liberia LR
Libya LY
Liechtenstein LI
Lithuania LT
Luxembourg LU
Macao MO
Madagascar MG
Malawi MW
Malaysia MY
Maldives MV
Mali ML
Malta MT
Marshall Islands (the) MH
Martinique MQ
Mauritania MR
Mauritius MU
Mayotte YT
Mexico MX
Micronesia (Federated States of) FM
Moldova (the Republic of) MD
Monaco MC
Mongolia MN
Montenegro ME
Montserrat MS
Morocco MA
Mozambique MZ
Myanmar MM
Namibia NA
Nauru NR
Nepal NP
Netherlands (the) NL
New Caledonia NC
New Zealand NZ
Nicaragua NI
Niger (the) NE
Nigeria NG
Niue NU
Norfolk Island NF
Northern Mariana Islands (the) MP
Norway NO
Oman OM
Pakistan PK
Palau PW
Palestine, State of PS
Panama PA
Papua New Guinea PG
Paraguay PY
Peru PE
Philippines (the) PH
Pitcairn PN
Poland PL
Portugal PT
Puerto Rico PR
Qatar QA
Republic of North Macedonia MK
Romania RO
Russian Federation (the) RU
Rwanda RW
Réunion RE
Saint Barthélemy BL
Saint Helena, Ascension and Tristan da Cunha SH
Saint Kitts and Nevis KN
Saint Lucia LC
Saint Martin (French part) MF
Saint Pierre and Miquelon PM
Saint Vincent and the Grenadines VC
Samoa WS
San Marino SM
Sao Tome and Principe ST
Saudi Arabia SA
Senegal SN
Serbia RS
Seychelles SC
Sierra Leone SL
Singapore SG
Sint Maarten (Dutch part) SX
Slovakia SK
Slovenia SI
Solomon Islands SB
Somalia SO
South Africa ZA
South Georgia and the South Sandwich Islands GS
South Sudan SS
Spain ES
Sri Lanka LK
Sudan (the) SD
Suriname SR
Svalbard and Jan Mayen SJ
Sweden SE
Switzerland CH
Syrian Arab Republic SY
Taiwan (Province of China) TW
Tajikistan TJ
Tanzania, United Republic of TZ
Thailand TH
Timor-Leste TL
Togo TG
Tokelau TK
Tonga TO
Trinidad and Tobago TT
Tunisia TN
Turkey TR
Turkmenistan TM
Turks and Caicos Islands (the) TC
Tuvalu TV
Uganda UG
Ukraine UA
United Arab Emirates (the) AE
United Kingdom of Great Britain and Northern Ireland (the) GB
United States Minor Outlying Islands (the) UM
United States of America (the) US
Uruguay UY
Uzbekistan UZ
Vanuatu VU
Venezuela (Bolivarian Republic of) VE
Viet Nam VN
Virgin Islands (British) VG
Virgin Islands (U.S.) VI
Wallis and Futuna WF
Western Sahara EH
Yemen YE
Zambia ZM
Zimbabwe ZW
Åland Islands AX