Our Apis

Beneficiaries 1.4.1


The Beneficiaries API enables you to get the trusted beneficiaries of the Arkea payment service user.

Test It !

The sandbox page describes how to obtain access token for a particular use case. Once you have access token you will be able to quickly test the API in the API Reference section below.

  • Under "API Reference" , expand the endpoint description you want to test and click on “Try it out”
  • Fill the fields of the request and body (if any) 
    • access token has to be specified in the Authorization header (Bearer scheme) 
      For instance : "Bearer ygzVxruT52IkFZw5GOAYAq82ZFaH"
    • Signature and X-Request-ID headers are not used out of the production mode and they won’t be any in the response
      But because the header is specified as "required" in OpenAPI specification you will have to specify any value
  • Click on “Execute” to send the request

The API can off course be used with same the access token outside this page with or without a mutual TLS connection.

Go Live !

The production mode is available, you can see how it works here

Functional details

Implementation notes

STET version compatibility:

You can get the name of the owner of a beneficiaries in a details field (usefull when a psu manage several spaces of accounts)

Change Log

March 2019: sandbox delivery

API reference