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

# Get receiving status

> GET /v1/receiving says whether customers can pay the business's invoices now, on which rail, whether card is on, and where to fix a block.

```
GET /v1/receiving
```

**Scope:** `invoices:read`

```bash theme={null}
curl https://api.stg.cleo-pay.com/v1/receiving \
  --header "Authorization: Bearer $CLEO_API_KEY"
```

## Response

<ResponseField name="canReceive" type="boolean">Customers can pay this business's invoices now.</ResponseField>

<ResponseField name="customerPaymentRail" type="string">
  `DWOLLA` or `CLEO_PAY`: the rail a customer pays on through a pay link today. It is the business's default rail.
</ResponseField>

<ResponseField name="cardPaymentsEnabled" type="boolean">Customers can pay by card. Cleo Pay rail only.</ResponseField>

<ResponseField name="blockedCode" type="string | null">
  `payments_locked`, `setup_incomplete`, `setup_required` or `feature_unavailable`. The same codes as the error envelope.
</ResponseField>

<ResponseField name="blockedReason" type="string | null">The block, in words.</ResponseField>

<ResponseField name="requirement" type="string | null">
  With `setup_required`: `cleo_pay_account`, `linked_bank`, `dwolla_account` or `bank_reauth`.
</ResponseField>

<ResponseField name="actionUrl" type="string | null">
  Absolute Cleo web link where the business fixes the block. While payments are locked, the booking link.
</ResponseField>

<ResponseField name="rails" type="array">Each rail's own `rail`, `canReceive` and `blockedReason`.</ResponseField>

Creating an invoice with `send`, sending one, and turning a pay link on answer with the same codes when receiving is blocked. See [Invoices](/concepts/invoices).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.