Request payout access token

Flow

  1. Create a Fintecture account
  2. Register a client application and get the credentials (i.e the app_id and app_secret) associated to it. A payout application is registered with the payout scope and a beneficiary bank account of type payout
  3. Encode your credentials using Base64 (Basic base64({app_id}:{app_secret})) to generate the Authorization header
  4. Request an access token using your credentials, the payout scope and the Authorization header
  5. Extract following information from provided response body:
    • access_token is to be used for endpoints' calls
    • expires_in allows you to know token's duration validity
  6. Use access_token for every payout endpoint requiring Bearer
  7. Check regularly expires_in and before access token's expiration, ask for a new one

What the token grants

A payout application holds the payout scope together with the pis scope, because a payout is initiated on the payment session endpoints. The access token of such an application always carries payout, whether or not you requested it.

A token carrying payout grants:

The other payment session operations — status update, debtor retrieval, event simulations, payment creation and refunds — require the pis scope, so request it explicitly (scope=pis payout, scopes being space-separated) when you need them. A request made with a token that lacks the scope an endpoint requires is rejected with invalid_scopes and the detail no_<scope>_scope.


Did this page help you?