Contract / Payouts

Get available payout transitions by contract payout id

This method requires the ContractPayouts:Get permission to be associated with your role.

GET

/fm/contract/payouts/{contract_payout_id}/available-transitions

curl --request GET \
  --url https://api.catch-e.com/fm/contract/payouts/{contract_payout_id}/available-transitions \
  --header 'Authorization: <api-key>'

[
  {
    "contract_payout_status_id": "<string>",
    "description": "<string>"
  }
]

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

contract_payout_idstringrequired

Maximum string length: 20

Pattern: ^[1-9]{1}[0-9]*$

Response

Success - returns an array of available transitions

itemsobject[]

Show child attributes

Still need help? Ask the team