Get Payable link

Request Information
URL GET {{basepath}}/api/:project/payable/:payable-id/link
CategoryPayable

Description

For retrieving the link to the payable to send the customer to.

Returns a PayableGetLinkResponse

Url variables
:project{{project}}
:payable-id{{payable_id}}
Header
Content-Typeapplication/json

Example responses

Get Payable link
Request Method & URL
GET {{basepath}}/api/:project/payable/:payable-id/link
Url variables
:project{{project}}
:payable-id{{payable_id}}
Response Code:
200 OK
Response Body:
{
    "responseId": "2_e7214947f55a3f2c8d96d8ac4d79ade57345ab52",
    "message": "The links are provided",
    "identifier": "2_2_8c73e745ae9af6105f0c9fad417c35fcb68f54d51637853082",
    "link": "https:\/\/mdfactoring.metaregistrar.work\/p\/2_2_8c73e745ae9af6105f0c9fad417c35fcb68f54d51637853082",
    "payLink": "https:\/\/mdfactoring.metaregistrar.work\/p\/2_2_8c73e745ae9af6105f0c9fad417c35fcb68f54d51637853082"
}
Get Payable link - But the payable is closed
Request Method & URL
GET {{basepath}}/api/:project/payable/:payable-id/link
Url variables
:project{{project}}
:payable-id{{payable_id}}
Response Code:
409 Conflict
Response Body:
{
    "message": "Payable is currently not in open status so payable link cannot be provided",
    "error": "invalid_status",
    "identifier": "1_2_e4a857a90c92a8b9d24bca61f74cb01c46697e951637851867",
    "status": "closed",
    "responseId": "2_496fb016af893d2412099d7392f7cd26a0a068d9"
}
Get Payable link but it is pending kickoff
Request Method & URL
GET {{basepath}}/api/:project/payable/:payable-id/link
Url variables
:project{{project}}
:payable-id{{payable_id}}
Response Code:
409 Conflict
Response Body:
{
    "message": "Payable is currently not in open status so payable link cannot be provided",
    "error": "invalid_status",
    "identifier": "2_2_8c73e745ae9af6105f0c9fad417c35fcb68f54d51637853082",
    "status": "pending_kickoff",
    "responseId": "2_bbdf93daa602d4b314bd206a6b6eb12a467bd829"
}