Payments platform supported by REST APIs

Instruments API

Method
Description

GET

getInstrumentDetails

https://test-apis.us-east-1.libertymutual.com/hydra/v1/instruments/{instrumentId}

This API returns details of the stored payment instrument

POST

storeInstrument

https://test-apis.us-east-1.libertymutual.com/hydra/v1/instruments

This API stored payment instrument details

POST

initiateInstrument

https://test-apis.us-east-1.libertymutual.com/hydra/v1/instruments/hosted-page/initiate

Creates instrument hosted page html snippet

Transactions API

Method
Description

GET

getPaymentByPaymentId

https://test-apis.us-east-1.libertymutual.com/hydra/v1/transactions/payments/{paymentId}

This API returns payment details for given payment Id

POST

Make Payment

https://test-apis.us-east-1.libertymutual.com/hydra/v1/transactions/payments

Make a payment now or schedule one in future

GET

getPaymentByClientPaymentId

https://test-apis.us-east-1.libertymutual.com/hydra/v1/transactions/payments

This API gives the payment information e.g. status for a given a client Id and Client payment id

Client Access Token API

Method
Description

POST

Generate Access Token

https://test-apis.us-east-1.libertymutual.com/hydra/v1/client-token

This API returns an access token

Batch Payments API

Method
Description

GET

Get Batch Payments File

https://test-apis.us-east-1.libertymutual.com/hydra/v1/batch/payments/{clientId}/{fileName}

API for getting Batch Payments file from Hydra. **Note:** Below is an example curl command. `curl -H "Authorization: Bearer xxxxx" https://test-apis.eu-west-1.lmig.com/hydra/v1/batch/payments/wem-ire_batch_payments_response_20200330_0004.txt --output whatever.txt`

PUT

Receive Batch Payments File

https://test-apis.us-east-1.libertymutual.com/hydra/v1/batch/payments/{clientId}/{fileName}

API for uploading Batch Payments file to Hydra. **Note:** The payload is a raw file content in the api body and this version of document (Swagger 2.0) doesnt support it to represent the same. Hence, below is an example curl command instead. Rest all other sections in this api document are still relevant. `curl -X PUT -H "Authorization: Bearer xxxxx" --upload-file wem-ire_batch_payments_request_20200330_0004.txt https://test-apis.eu-west-1.lmig.com/hydra/v1/batch/payments/wem-ire/wem-ire_batch_payments_request_20200330_0004.txt`

Hosted Payment Page API

Method
Description

POST

Initiate Hosted Page for Payment

https://test-apis.us-east-1.libertymutual.com/hydra/v1/transactions/payments/hosted-page/initiate

This API will bring us access-token to render the Hosted Pay Page (HPP) to capture payment instrument details