> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# Get an application

GET https://api-sandbox.payabli.com/api/v2/requests/{requestsReference}

Retrieves a boarding application by reference.

Reference: https://docs.payabli.com/developers/api-reference/applications/get-an-application

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Path parameters

- `requestsReference` (string, required) — The application reference.

## Response

### 200

The application.

- `success` (boolean, required) — Whether the request succeeded.
- `message` (string, required, nullable) — A human-readable result message.
- `traceId` (string, required, nullable) — The trace identifier for the request, useful for support.
- `data` (Application, required, nullable) — The application.

## Errors

### 401 Unauthorized Error

Unauthorized request.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

### 404 Not Found Error

The requested resource wasn't found.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

### 500 Internal Server Error

Internal server error.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

## Types

### Application

A boarding application (request), as returned when you create, get, or update one.

- `requestsReference` (string, required) — The application reference, used to read and manage the application.
- `businessReference` (string, required) — The reference of the business being boarded.
- `applicationStatus` (string, required) — The application's lifecycle status, as a lowercase name. For what moves an application between statuses, see [Boarding application statuses](/guides/pay-ops-boarding-application-status-reference). One of: - `draft` (1): Created and editable. The only status that accepts updates. - `submitted` (2): Submitted with the signature of record. - `verifying` (3): Automated verification is in progress. - `pendingreview` (4): Awaiting underwriting review. - `escalatedreview` (5): Escalated to a higher review tier. - `pendingdocuments` (6): Underwriting requested documents from the applicant. - `pendingresponse` (7): Underwriting asked the applicant a question. - `approved` (8): Approved and waiting for services to be enabled. - `autoapproved` (9): Approved without manual review. - `denied` (10): Denied. Terminal. - `withdrawn` (11): Withdrawn. Terminal. - `abandoned` (12): Reserved. No action moves an application to this status. - `error` (13): Processing hit an error. Payabli can recover the application from this status. - `activated` (14): The requested services are provisioned and live. Terminal. An `approved` or `autoapproved` application moves to `activated` automatically after all requested services are boarded.
- `applicationStatusCode` (integer, required) — The numeric code of the application's lifecycle status. See `applicationStatus` for the code of each status.
- `allowedActions` (list of string, required) — The lifecycle actions currently allowed on the application. The list can include actions that Payabli or its internal services perform, which you can't call through the API.
- `createdAt` (string, required) — When the application was created.
- `_links` (ApplicationLinks, required) — Hypermedia links for the application resource.
- `paypointReference` (string, required) — The reference of the paypoint the application boards.
- `paypointStatus` (string, required) — The status of the paypoint the application boards. New paypoints start in `pending`.
- `externalId` (string, optional, nullable) — An identifier from your own system.
- `parent` (string, optional, nullable) — The reference of the organization the application belongs to.
- `parentOrgName` (string, optional, nullable) — The name of the organization the application belongs to.
- `entityType` (string, optional, nullable) — The type of entity being boarded.
- `dbaName` (string, optional, nullable) — The doing-business-as name.
- `requestTemplate` (string, optional, nullable) — The reference of the boarding template applied to the application.
- `services` (RequestedServices, optional) — The services the application requests. Left out when the application doesn't request any.
- `tags` (list of string, optional, nullable) — Labels for the application.
- `representatives` (list of RepresentativeResponse, optional, nullable) — The representatives assigned to the application.
- `submittedAt` (string, optional, nullable) — When the application was submitted.

### PayabliErrorBodyResponseData

Object with detailed error context.

- `explanation` (string, optional) — Human-readable explanation of what happened.
- `todoAction` (string, optional) — Suggested resolution.

### ApplicationLinks

Hypermedia links for an application resource.

- `self` (string, optional) — Relative path to the application resource.
- `business` (string, optional) — Relative path to the business the application boards.

### RequestedServices

The services the application requests, grouped by direction. Values are case-insensitive on input and returned in the casing shown.

- `moneyIn` (list of enum, optional) — The Pay In services to request.
  - Allowed values: `Ach`, `Card`, `Cloud`, `Device`, `Wallet`, `Cash`, `Check`
- `moneyOut` (list of enum, optional) — The Pay Out services to request.
  - Allowed values: `Ach`, `VCard`, `Managed`, `Check`, `Rtp`, `Wire`, `Ghost`

### RepresentativeResponse

A sales or service representative assigned to the application.

- `userId` (string, optional, nullable) — The representative's user identifier.
- `repCode` (integer, optional, nullable) — The representative's code.
- `firstName` (string, optional, nullable) — The representative's first name.
- `lastName` (string, optional, nullable) — The representative's last name.
- `location` (string, optional, nullable) — The representative's location.
- `team` (string, optional, nullable) — The representative's team.

## Examples

**Response**

```json
{
  "success": true,
  "message": "Application retrieved successfully",
  "traceId": "0HNNNPRPLVN3H:00000009",
  "data": {
    "requestsReference": "3f3caa7b-bdfe-4bf1-814b-30d54859247c",
    "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "applicationStatus": "draft",
    "applicationStatusCode": 1,
    "allowedActions": [
      "submit",
      "withdraw",
      "abandon"
    ],
    "createdAt": "2026-07-01T15:00:01.734346",
    "_links": {
      "self": "/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c",
      "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "paypointReference": "019ff064-c690-7679-a73e-688418aadc7c",
    "paypointStatus": "pending",
    "externalId": "APP-2025-0417",
    "tags": [
      "priority"
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```