> ## Documentation Index
> Fetch the complete documentation index at: https://doc2.payloco.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 👋 Welcome to Payloco API Reference

Payloco provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library.

<CardGroup horizontal cols={2} row={3}>
  <Card horizontal title="Try a Payment" href="/api-reference/acquiring/payment" icon="money-bill">
    Explore the versatile payments endpoint, through multiple test scenarios
  </Card>

  <Card horizontal title="Refund" href="/api-reference/acquiring/refund" icon="receipt">
    Process refunds for completed payments using our API
  </Card>

  <Card horizontal title="Transfer" href="/api-reference/transfers/transfer" icon="vault">
    Initiate a transfer request using the API
  </Card>

  <Card horizontal title="Webhooks" href="/api-reference/payment-notification/payment-success" icon="circle-down">
    Receive real-time payment result notifications via webhooks
  </Card>
</CardGroup>

## Environment

We have a testing environment referred to <Tooltip tip="Testing environment!">"sandbox</Tooltip>," which you can set up to test API calls without affecting production data. You can sign up on our Dashboard to get API keys to access Payloco API.

Use the following base URLs when making requests to the APIs:

| Environment | Base URL                                                                     |
| ----------- | ---------------------------------------------------------------------------- |
| Sandbox     | [https://gate.uat.payloco.com/gateway](https://gate.uat.payloco.com/gateway) |
| Production  | [https://gate.payloco.com/gateway](https://gate.payloco.com/gateway)         |

## Payment Status Lifecycle

Payloco handles the complex functionality of a comprehensive payments flow through the Payments object that transitions through multiple states during its payments lifecycle. Given below are the various statuses a payment can have:

| Status  | Description       | Notes                                                 |
| ------- | ----------------- | ----------------------------------------------------- |
| SUCCESS | Payment succeeded | The user completed the payment                        |
| PENDING | Payment pending   | Waiting for the user to complete payment              |
| FAILED  | Payment failed    | Payment was unsuccessful                              |
| CLOSED  | Payment closed    | User did not complete payment within the valid period |