Retrieve a credit record

Endpoint

https://api.verifik.co/v2/credits/:id

Retrieve information about a specific Credit record within Verifik’s system. This endpoint provides detailed data regarding the credit record, so you can know if it's an usage or purchase record.

Headers

Include the necessary authentication headers for authorization and content-type, such as:

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Request Parameters

  • Path Parameter:

    • id (string, required): The unique identifier for the credit record you want to retrieve.

Request

curl --location 'https://api.verifik.co/v2/credits' \
--header 'Authorization: Bearer eyJhbGciOiJI...zIkpXVFBLuWixs'

Response

On a successful request, you will receive a JSON object with the details of the specified Credit. Key fields include the status, amount, category , client, etc.

Success Response (200)

{
    "data": {
        "_id": "67c0d39dab480fc9ff6da66d",
        "amount": 249,
        "status": "approved",
        "category": "purchase",
        "client": "613a3a48f2c84b454153add7",
        "superAdmin": null,
        "transaction": "67c0d39dab480fc9ff6da66c",
        "invoice": "67c0d39dab480fc9ff6da66a",
        "memo": "invoice 67c0d39dab480fc9ff6da66a created for 249, pdf: https://pay.stripe.com/invoice/acct_1L2d4wFO6i3ofqGH/test_YWNjdF8xTDJkNHdGTzZpM29mcUdILF9ScXc5U0tGQlNmS1RGb0hmWW5BenF3STRielFkbjlQLDEzMTIzMTEzMw0200yT8hFmhA/pdf?s=ap",
        "expiresAt": "2025-03-27T23:59:59.999Z",
        "isExpired": false,
        "updatedAt": "2025-02-27T21:05:33.666Z",
        "createdAt": "2025-02-27T21:05:33.666Z",
        "__v": 0
    }
}

Error Responses

Status Code
Description

404

Credit not found

Last updated