NAV Navbar
Test Environment

Documentation API v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Getting Started

OAuth 2.0

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

More info about OAuth 2.0 :

Get a code

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

Code samples

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

Request

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 callback

Example responses

OK

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

Errors

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

Access denied

> www.your-callback-url.com?error=access_denied

Response

Redirect the user to your callback url 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.

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": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}

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

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

Account

Get account

Code samples

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

Get the account logged.

Request

GET /accounts

Example response

200

[
  {
       "label": "string",
       "balance": "float",
       "currency": "string",
       "company_name": "string",
       "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
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
owner.gender_label Monsieur
owner.gender_label Madame
owner.gender_label Madame, Monsieur
currency EUR
currency USD
currency GBP

Operation

List of operations

Code samples

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

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 Value
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

[
  {
    "id": 1,
    "executed_at": 0,
    "status": "string",
    "label": "string",
    "type": "string",
    "category": "string",
    "amount": 0,
    "detail": {
      "vat": {
        "vat_amount": 0,
        "vat_rate": 0,
        "category_id": 0
      }
    },
    "currency": "string",
    "beneficiary": 1,
    "document": {
      "updated_at": 12345,
      "filename": "test.zip",
      "mime_type": "test.zip",
      "url": "string"
    },
    "document_url": "string",
    "bill": {
      "updated_at": 12345,
      "filename": "test.zip",
      "mime_type": "test.zip",
      "url": "string"
    },
    "bill_url": "string"
  },
  {
    "id": 2,
    "executed_at": 0,
    "status": "string",
    "label": "string",
    "type": "string",
    "category": "string",
    "amount": 0,
    "detail": {
      "vat": {
        "vat_amount": 0,
        "vat_rate": 0,
        "category_id": 0
      }
    },
    "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",
          "ES",
          "EN"
        ],
        "sepa": true
      },
      "address": {
        "street": "48, Rue de la Vielle Ecole",
        "zip": "75116",
        "city": "Paris",
        "country": "France"
      },
      "social_security_number": "123456789"
    },
    "document": {
      "updated_at": 12345,
      "filename": "test.zip",
      "mime_type": "test.zip",
      "url": "string"
    },
    "document_url": "string",
    "bill": {
      "updated_at": 12345,
      "filename": "test.zip",
      "mime_type": "test.zip",
      "url": "string"
    },
    "bill_url": "string"
  }
]

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..
updated_at integer Update date timestamp
beneficiary Beneficiary Beneficiary of the operation (if it is a 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
comment string false
document Document Document linked with the operation (Invoice,...)
document.updated_at integer Update date
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
bill Bill Bill linked with the operation (manager.one fees)
bill.updated_at integer Update date
bill.filename string filename of the document
bill.mime_type string MIME Type of the file
bill.url string URL to download the file if uploaded
detail OperationDetail) Details of the operation
detail.vat OperationDetailVat none
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 object Associated Category
detail.categories.id string ID of associated Category
detail.categories.label string Name of the category translated
detail.categories.resource_type string Model associated with, operation if null
detail.categories.name string Name of the category
detail.categories.default boolean Not created by the user

Enumerated Values

Parameter Value
category deposit_cash
category deposit_check
category fees
category other
category payment_check
category credit_card
category redraw_atm
category refund
category prelevement
Parameter Value Description
afb_code 1 Payment check
afb_code 2 Deposit check
afb_code 4 Deposit cash
afb_code 5 Transfer got (credit)
afb_code 6 Transfer send (debit)
afb_code 8 Automatic debit
afb_code 11 Card operation
afb_code 12 Transfer rejected
afb_code 29 Withdrawal
afb_code 33 Fee operation
afb_code 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 API_KEY'

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": 0,
  "executed_at": 0,
  "status": "string",
  "label": "string",
  "type": "string",
  "category": "string",
  "category_label": "string",
  "afbCode": 1,
  "amount": 0,
  "currency": "string",
  "updated_at": 0,
  "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": {
    "updated_at": 12345,
    "filename": "test.zip",
    "mime_type": "test.zip",
    "url": "string"
  },
  "document_url": "string",
  "bill": {
    "updated_at": 12345,
    "filename": "test.zip",
    "mime_type": "test.zip",
    "url": "string"
  },
  "credit_card":"je sais âs",
  "bill_url": "string",
  "detail": {
    "vat": {
      "vat_amount": 0,
      "vat_rate": 0,
      "category_id": 0
    }
  }
}

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..
updated_at integer Update date timestamp
beneficiary Beneficiary Beneficiary of the operation (if it is a 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
comment string false
document Document Document linked with the operation (Invoice,...)
document.updated_at integer Update date
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
bill Bill Bill linked with the operation (manager.one fees)
bill.updated_at integer Update date
bill.filename string filename of the document
bill.mime_type string MIME Type of the file
bill.url string URL to download the file if uploaded
detail OperationDetail) Details of the operation
detail.vat OperationDetailVat none
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 object Associated Category
detail.categories.id string ID of associated Category
detail.categories.label string Name of the category translated
detail.categories.resource_type string Model associated with, operation if null
detail.categories.name string Name of the category
detail.categories.default boolean Not created by the user

Enumerated Values

Parameter Value
category deposit_cash
category deposit_check
category fees
category other
category payment_check
category credit_card
category redraw_atm
category refund
category prelevement
Parameter Value Description
afb_code 1 Payment check
afb_code 2 Deposit check
afb_code 4 Deposit cash
afb_code 5 Transfer got (credit)
afb_code 6 Transfer send (debit)
afb_code 8 Automatic debit
afb_code 11 Card operation
afb_code 12 Transfer rejected
afb_code 29 Withdrawal
afb_code 33 Fee operation
afb_code 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 API_KEY'

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

Download the document attached to an operation

Code samples

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

Download the document

Request

GET /operations/{id}/{documentType}

Parameters

Parameter In Type Required Description
id path integer(int32) true The transfer ID
documentType path string true The document type

Enumerated Values

Parameter Value
documentType document

Example response

200 Response

Response

The document

Status Code 200 OK

Errors

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

Attach a file to an operation

Code samples

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

Attach a file to an operation

Request

POST /operations/{id}/{documentType}

Parameters

Parameter In Type Required Description
id path integer(int32) true The transfer ID
documentType path string true Document type
file form-data file true The document to attach

Enumerated Values

Parameter Value
documentType document

Example responses

201 Response

Response

The document uploaded

Status Code 200 OK

Errors

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

Delete the document of an operation

Code samples

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

Delete the document attached to an operation

Request

DELETE /operations/{id}/{documentType}

Parameters

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

Enumerated Values

Parameter Value
documentType document

Example responses

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 API_KEY'

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 responses

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 API_KEY'

Download the statement PDF

Request

GET /statements/{id}/document

Parameters

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

Example responses

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 API_KEY'

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 responses

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 API_KEY'

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 responses

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": {
      "id": 36,
      "label": "Test account",
      "balance": 2907.58
    }
  },
  {
    "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": 36,
      "label": "Test account",
      "balance": 2907.58
    }
  },
  {...}
]

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 Update date
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 Update date
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 Update date
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 Update date
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
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 API_KEY'

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 responses

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 API_KEY'

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 The document to attach to the transfer

Enumerated Values

Property Value
type direct
type delayed
type periodic

Example responses

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": 36,
    "label": "Test account",
    "balance": 2907.58,
  }
}

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 Update date
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 Update date
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 Update date
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 Update date
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
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 API_KEY'

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 responses

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 Update date
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 Update date
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 Document Document linked with the transfer (Invoice,...)
transfer.document.updated_at integer Update date
transfer.document.filename string filename of the document
transfer.document.mime_type string MIME Type of the file
transfer.document.url string URL to download the file if uploaded
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 Update date
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 Update date
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 API_KEY'

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 responses

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": 1,
    "balance": 10308.63,
    "label": "test_account",
    "currency": "EUR"
  }
}

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 Update date
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 Update date
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 Update date
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 Update date
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

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 API_KEY'

Return a transfer

Request

GET /transfers/{id}

Parameters

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

Example responses

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": 1,
    "balance": 10308.63,
    "label": "test_account",
    "currency": "EUR"
  }   
}

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 Update date
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 Update date
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 Update date
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 Update date
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
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 API_KEY'

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 responses

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": 1,
    "balance": 10308.63,
    "label": "test_account",
    "currency": "EUR"
  }   
}

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 Update date
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 Update date
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 Update date
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 Update date
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
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 API_KEY'

Cancel a specific transfer

Request

DELETE /transfers/{id}

Parameters

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

Example responses

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": 36,
    "balance": 11675.72,
    "label": null,
    "currency": "EUR"
  }
}

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 Update date
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 Update date
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 Update date
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 Update date
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
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 API_KEY'

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
documentType certificate
documentType international

Example responses

200 Response

Responses

The document

Status Code 200 OK

Responses

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

Attach a file to a transfer

Code samples

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

Attach a file to a transfer

Request

POST /transfers/{id}/{documentType}

Body parameter

Parameters

Parameter In Type Required Description
id path integer(int32) true The transfer ID
documentType path string true Document type
file form-data file true The document to attach

Enumerated Values

Parameter Value
documentType document

Example responses

200 Response

Responses

The document uploaded

Status Code 200 OK

Errors

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

Delete the document

Code samples

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

Delete the attached document

Request

DELETE /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

Example responses

204 Response

Responses

Status Code 204 No Content

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 when deleting the document ServerErrorHttpException

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 API_KEY'

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 responses

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 API_KEY'

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 responses

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 of the beneficiary
address.zip string zip code
address.city string City of the beneficiary
address.country string Country of the beneficiary
social_security_number string Beneficiary social security number
rib Document Rib of the beneficiary
rib.updated_at integer Update date
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 Update date
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 ISO 3166-1 alpha-2 of the bank
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 API_KEY'

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

Example responses

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 of the beneficiary
address.zip string zip code
address.city string City of the beneficiary
address.country string Country of the beneficiary
social_security_number string Beneficiary social security number
rib Document Rib of the beneficiary
rib.updated_at integer Update date
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 Update date
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 ISO 3166-1 alpha-2 of the bank
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 API_KEY'

View a beneficiary

Request

GET /beneficiaries/{id}

Parameters

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

Example responses

200 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 of the beneficiary
address.zip string zip code
address.city string City of the beneficiary
address.country string Country of the beneficiary
social_security_number string Beneficiary social security number
rib Document Rib of the beneficiary
rib.updated_at integer Update date
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 Update date
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 ISO 3166-1 alpha-2 of the bank
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 API_KEY'

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 responses

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

Response

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 of the beneficiary
address.zip string zip code
address.city string City of the beneficiary
address.country string Country of the beneficiary
social_security_number string Beneficiary social security number
rib Document Rib of the beneficiary
rib.updated_at integer Update date
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 Update date
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 ISO 3166-1 alpha-2 of the bank
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 API_KEY'

Delete a beneficiary

Request

DELETE /beneficiaries/{id}

Parameters

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

Example responses

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 API_KEY'

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 responses

200 Response

Responses

Status Code 200 OK

Document

Name Type Description
ID integer ID of the document
updated_at integer Update date
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 API_KEY'

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 responses

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 API_KEY'

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 responses

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 API_KEY'

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 responses

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 API_KEY'

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 responses

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 API_KEY'

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 responses

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 API_KEY'
  -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 responses

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 Update date
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 API_KEY'

Get a document by id

Request

GET /documents/{id}

Parameters

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

Example responses

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 API_KEY'
  -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 responses

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 API_KEY'

Delete a document uploaded

Request

DELETE /documents/{id}

Parameters

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

Example responses

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 API_KEY'

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 responses

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 update date
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 update date
end_date string update date
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 Update date
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 Update date
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 API_KEY'

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 responses

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 update date
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 update date
end_date string update date
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 Update date
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 Update date
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 API_KEY'

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 responses

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 update date
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 update date
end_date string update date
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 Update date
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 Update date
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 API_KEY'

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 responses

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 update date
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 update date
end_date string update date
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 Update date
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 Update date
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 API_KEY'

Delete a periodic transfer

Request

DELETE /periodic-transfers/{id}

Parameters

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

Example responses

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

Errors

ForbiddenHttpException

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

Properties

Name Type
name Forbidden
message string
code integer
status 403
type yii\web\ForbiddenHttpException

UnauthorizedHttpException

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

Properties

Name Type
name Unauthorized
message string
code integer
status 401
type yii\web\UnauthorizedHttpException

NotFoundHttpException

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

Properties

Name Type
name Not Found
message string
code integer
status 404
type yii\web\NotFoundHttpException

ServerErrorHttpException

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

Properties

Name Type
name Internal Server Error
message string
code integer
status 500
type yii\web\ServerErrorHttpException

BadRequestHttpException

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

Properties

Name Type
name string
message string
code integer
status 400
type yii\web\BadRequestHttpException

Fields Validation Errors

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

Array of validation errors

Properties

Name Type
Array of validation errors [FieldValidationErrors]

Field Validation Errors

{
  "field": "string",
  "message": "string"
}

Properties

Name Type
field string
message string