Open session

API to open a session from a fund lock

Responses

200 Ok

  • id [string]: Unique ID of the payment
  • amount_unit [number]: Amount of the session in cents
  • residual_amount_unit [number]: Residual amount of the fund lock in cents
  • currency [string]: Currency of the session
  • status [string]: Status of the session (OPEN)
  • type [string]: Type of payment that will be created on session completion (TO_BUSINESS_CHARGE)

400 Bad Request

  • code [integer]: Error code
    135 → invalid fund lock for a new session
  • message [string]: Error message

403 Forbidden or invalid authorization header

  • code [integer]: Error code
  • message [string]: Error message
Body Params
string
required

Unique ID of the fund lock

Headers
string
required

The host declared in the signature

string
required

The date declared in the signature

string
required

The digest declared in the signature

string
required

Signature of the request

string

The idempotent token of the request

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json
text/plain