Retrieve a fee schedule

Retrieve a fee schedule's details

GET https://<PayEngine-host>/api/fee-schedules/:id

Path Parameters

Name	Type	Description
id*	string	PayEngine fee schedule ID

200: OK

Fee Schedule Field Definitions

Field Name	Type	Description	Required
data.name	string	Fee schedule name	Required
data.description	string	Fee schedule description	Required
data.is_default	boolean	Indicate that fee schedule will be assigned to newly created onboarding application	Required
data.created_at	string	Timestamp when fee schedule was created	Required
data.updated_at	string	Timestamp when the fee schedule was updated	Required

Example Response

{
    "data": {
        "id": "aba76907-2a1a-41cf-8501-5cd4ba1ff400",
        "name": "CUSTOMER_01: VS/MC/DS 2.9% + $.30; AMEX 3.4% + $.30; ACH 1% + 0.18; MONTHLY $20; PCI $79",
        "description": "VS/MC/DS 2.9% + $.30; AMEX 3.4% + $.30; ACH 1% + 0.18; MONTHLY $20; PCI $79",
        "is_default": true,
        "created_at": "2022-02-10T04:50:39.817Z",
        "updated_at": "2022-02-10T04:50:39.817Z"
    }
}

cURL

curl --location --request GET 'http://<PayEngine-host>/api/fee-schedules/aba76907-2a1a-41cf-8501-5cd4ba1ff400' \
--header 'Authorization: Basic <YOUR_API_SECRET>'

Response

{
    "data": {
        "id": "aba76907-2a1a-41cf-8501-5cd4ba1ff400",
        "name": "CUSTOMER_01: VS/MC/DS 2.9% + $.30; AMEX 3.4% + $.30; ACH 1% + 0.18; MONTHLY $20; PCI $79",
        "description": "VS/MC/DS 2.9% + $.30; AMEX 3.4% + $.30; ACH 1% + 0.18; MONTHLY $20; PCI $79",
        "is_default": true,
        "created_at": "2022-02-10T04:50:39.817Z",
        "updated_at": "2022-02-10T04:50:39.817Z"
    }
}