> For the complete documentation index, see [llms.txt](https://central-bank-of-libya.gitbook.io/devportal/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://central-bank-of-libya.gitbook.io/devportal/lypay/api-documentation/api-v1.md).

# API v1

Central API v1 guide for LYPay authentication, payments, transaction enquiries, utilities, and webhooks.

### LYPay integration reference

This section groups all current LYPay API capabilities under **API v1**. Use the pages below to understand what each operation is for and how it fits into the integration flow.

{% hint style="info" %}
For full request schemas, response schemas, field definitions, examples, and detailed operation behavior, use the official Postman documentation.
{% endhint %}

[Open LYPay API v1 on Postman →](https://documenter.getpostman.com/view/30951400/2sA3JGfjN7)

## API v1 areas

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-circle-info" style="color:$primary;">:circle-info:</i></h3></td><td><strong>About API v1</strong></td><td>Ownership, access model, authentication requirements, and integration guidance.</td><td><a href="/devportal/lypay/api-documentation/api-v1/about-api-v1.md">About API v1</a></td></tr><tr><td><h3><i class="fa-shield-keyhole" style="color:$primary;">:shield-keyhole:</i></h3></td><td><strong>Authentication</strong></td><td>Token, password-management, and token-revocation capabilities.</td><td><a href="/devportal/lypay/api-documentation/api-v1/authentication.md">Authentication</a></td></tr><tr><td><h3><i class="fa-money-bill-transfer" style="color:$primary;">:money-bill-transfer:</i></h3></td><td><strong>Payments</strong></td><td>Initiation, confirmation, refunds, payment details, and debit/credit-side enquiries.</td><td><a href="/devportal/lypay/api-documentation/api-v1/payments.md">Payments</a></td></tr><tr><td><h3><i class="fa-list-check" style="color:$primary;">:list-check:</i></h3></td><td><strong>Utilities &#x26; Reference</strong></td><td>Supporting institution and transaction-status reference capabilities.</td><td><a href="/devportal/lypay/api-documentation/api-v1/utilities-and-reference.md">Utilities &amp; Reference</a></td></tr><tr><td><h3><i class="fa-bell" style="color:$primary;">:bell:</i></h3></td><td><strong>Webhooks</strong></td><td>Asynchronous notifications and transaction-status updates sent to participating institutions.</td><td><a href="/devportal/lypay/api-documentation/api-v1/webhooks.md">Webhooks</a></td></tr></tbody></table>

## Typical API v1 transaction flow

{% stepper %}
{% step %}

### Authenticate

Obtain the credentials or token required for protected API operations.
{% endstep %}

{% step %}

### Initiate the payment

Create the funds-transfer request and capture the returned transaction identifiers and initial status.
{% endstep %}

{% step %}

### Confirm the payment

Confirm the initiated transfer using the required transaction information.
{% endstep %}

{% step %}

### Handle the outcome

Process the immediate final result or wait for the webhook when the transaction remains asynchronous.
{% endstep %}

{% step %}

### Query and operate

Use transaction enquiries, details, status references, refunds, and operational APIs as required.
{% endstep %}
{% endstepper %}

## Detailed API specification

The complete API v1 specification is maintained in Postman:

[View full API documentation on Postman →](https://documenter.getpostman.com/view/30951400/2sA3JGfjN7)