# Request to Pay

The Request to Pay API allows merchants to initiate a payment request directly from the merchant portal or POS to a shopper's PayLater mobile app. When called, the API sends a push notification to the shopper prompting them to review and approve the transaction within their app, where they can select their preferred installment plan and complete the purchase. This endpoint is designed for in-store, phone order, and remote checkout scenarios where the shopper is not transacting through a merchant's website.

## Endpoint

### Sandbox

`POST https://connect.uat.paylaterapp.com/api/paylater/merchant-portal/request-to-pay` 

### Production

`POST https://connect.paylaterapp.com/api/paylater/merchant-portal/request-to-pay` 

## Headers

* `x-api-key`: Your API key (Required)
* `Content-Type`: `application/json`

## Request Body

<table data-header-hidden><thead><tr><th>Parameter</th><th>Type</th><th width="156">Required</th><th>Description</th></tr></thead><tbody><tr><td>merchant_id</td><td>String</td><td>✅</td><td>Unique ID assigned to your business</td></tr><tr><td>outlet_id</td><td>Number</td><td>✅</td><td>Storefront or outlet identifier</td></tr><tr><td>mobile_number</td><td>String</td><td>✅</td><td>Registered Customer mobile number</td></tr><tr><td>order_amount</td><td>Decimal</td><td>✅</td><td>Requested payment amount</td></tr><tr><td>merchant_order_reference</td><td>String</td><td>✅</td><td>Merchant  unique transaction identifier</td></tr><tr><td>expiry_minutes</td><td>Integer</td><td>✅</td><td>Expiry time in minutes</td></tr></tbody></table>

## Sample cURL

```
curl --location 'https://connect.uat.paylaterapp.com/api/paylater/merchant-portal/request-to-pay' \
--header 'x-api-key: a4f9feba-19dd-47b7-8d09-268a25c44a35' \
--header 'Content-Type: application/json' \
--data '{
    "merchant_id": "138",
    "outlet_id": 1000000061,
    "mobile_number": "97451118021",
    "order_amount": 3015,
    "merchant_order_reference": "ORD-5",
    "expiry_minutes": 20
}'
```

## Success Response

```
{
    "merchant_order_reference": "ORD-5",
    "status": "SUCCESS",
    "expiry_date": "2026-04-28T10:15:41.477013291"
}
```

## Error Response (Example)

```
{
    "status": "FAILED",
    "message": "A Request-to-Pay already exists for this merchant order reference.",
    "http_code": 409,
    "error_reference": "RTP-409-DUPLICATE-REFERENCE"
}

{
    "status": "FAILED",
    "message": "Unable to process Request-to-Pay right now. Please try again later.",
    "http_code": 404,
    "error_reference": "RTP-UPSTREAM-ERROR"
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://paylater.gitbook.io/paylater-docs/getting-started/quickstart/request-to-pay.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.