HateoasLink

FDX / Data Structures / HateoasLink
HATEOAS Link, REST application constraint (Hypermedia As The Engine Of Application State)
HateoasLink Properties
#IdTypeDescription
1hrefstringURL to invoke the action on the resource
2actionHttpAction
3relstringRelation of this link to its containing entity, as defined by IETF RFC5988 with many relation values specified in its [Section 6.2.2](https://datatracker.ietf.org/doc/html/rfc5988#section-6.2.2), for example: * `self` - Link to the current resource latest state or with more detail * `prev` - Previous page in a paginated result set * `next` - Subsequent page in a paginated result set * `first` - First page in a paginated result set * `last` - Last page in a paginated result set * `related` - Link to a related resource, like a Transaction's referenceTransactionId * `up` - Link to a related 'parent' resource, like a child account's parent account * `payment` - Link to a payment-scheduling endpoint Specific to FDX, `rel` values can contain a data cluster or space-delimited list of data clusters which link to the referenced data type(s), for example: * `ACCOUNT_DETAILED` - Link to the account's details via `/accounts/{accountId}` * `PAYMENT_SUPPORT` - Link to the account's ID and bank ID for payments or transfers via `/accounts/{accountId}/payment-networks` * `CUSTOMER_CONTACT` - Link to the account's customer contact details via `/accounts/{accountId}/contact` * `TRANSACTIONS` - Link to the account's transactions list via `/accounts/{accountId}/transactions` * `REWARDS` - Link to the account's reward program via `/reward-programs/{rewardProgramId}` * `TRANSACTIONS REWARDS` - Specific link to the account's transaction rewards via `/accounts/{accountId}/reward-transactions` * `STATEMENTS` - Link to the account's statements list via `/accounts/{accountId}/statements` * `IMAGES` - Link to the transaction's images list via `/accounts/{accountId}/transaction-images/{imageId}`
4typesArray of ContentTypesContent-types that can be used in the Accept header

© Copyright 2026. All Rights Reserved. (www)