API Reference

Példa Folyamat

Create Client

POST /api/v1/clients

Példa body:

{
    "client": {
        "type": "organization",
        "taxId": "12345678-2-13",
        "organizationName": "Teszt Kft",
        "addresses": [
            {
                "isPrimary": true,
                "street": "Kéknefelejcs utca 6841 hrsz.",
                "postalCode": "2045",
                "city": " Törökbálint",
                "country": "HU"
            }
        ],
        "bankAccounts": [
            {
                "isPrimary": true,
                "accountNumber": "1177 3016 1111 1018 0000 0000",
                "bankName": "MNB",
                "label": "",
                "iban": "",
                "bic": "",
                "holderName": ""
            }
        ],
        "referenceId": "partner-reference-id-1234"
    },
    "user": {
        "email": "hello@example.com",
        "name": "Teszt Bence"
    }
}

Válasz:

{
    "client": {
        "apiKey": "api_key_1234",
        "id": "f3e33a8c-c463-4da8-8a2b-574a0065c725",
        "status": "created"
    },
    "user": {
        "id": "aefca73a-725d-46ab-b74b-34bdf09c7078",
        "status": "created"
    }
}

Create Case

POST /api/v1/cases

Példa body:

{
    "claims": [
        {
            "referenceId": "claim-id-1234",
            "amount": {
                "currency": "HUF",
                "amount": 500000
            },
            "legalObligationDate": "2023-09-05",
            "dueDate": "2023-09-13"
        }
    ],
    "type": "notice",
    "partnerId": "payee",
    "referenceId": "case-ref-1"
}

Válasz:

{
    "id": "e8f10153-0f7a-4de3-af26-3c539a9b0677",
    "payeeCaseReferenceId": "PS22142459",
    "referenceId": "",
    "status": "Piszkozat",
    "statusCode": "pending",
    "todoCode": null,
    "caseUrl": "https://sandbox.payee.tech/case/e8f10153-0f7a-4de3-af26-3c539a9b0677",
    "originalAmount": 55087,
    "currentAmount": 55087,
    "currency": "HUF",
    "createdAt": "2025-02-05T12:18:29+00:00",
    "claims": [
        {
            "id": "d016ff79-5eb5-4180-ac19-c8554974c71a",
            "claimUrl": "https://sandbox.payee.tech/claims/d016ff79-5eb5-4180-ac19-c8554974c71a",
            "currentAmount": 5000,
            "originalAmount": 5000,
            "currency": "HUF",
            "referenceId": "claim-id-1234"
        }
    ],
    "debtor": {
        "name": "BW Insulation Kft."
    }
}

Ügy Szerkesztése és Elindítása

A felhasználót át kell irányítani a caseUrl-re.

Ügy Státusz Lekérdezése (pull)

GET``/api/v1/cases/e8f10153-0f7a-4de3-af26-3c539a9b0677

Válasz:

{
    "id": "e8f10153-0f7a-4de3-af26-3c539a9b0677",
    "payeeCaseReferenceId": "PS22142457",
    "referenceId": "case-ref-1",
    "status": "Piszkozat",
    "statusCode": "pending",
    "todoCode": null,
    "caseUrl": "https://sandbox.payee.tech/case/e8f10153-0f7a-4de3-af26-3c539a9b0677",
    "originalAmount": 0,
    "currentAmount": 0,
    "currency": "HUF",
    "createdAt": "2025-02-05T12:13:19+00:00",
    "claims": [],
    "debtor": null
}

Ügy Státusz Webhook (push)

Egyelőre ilyen nincs az API-ban.

Igényelni lehet a hello@payee.tech email címen.