> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://beta-docs.payabli.com/api-reference/paypoint/get-paypoint-settings/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server.

# Get paypoint settings

GET https://api-sandbox.payabli.com/api/Paypoint/settings/{entry}

Retrieves an paypoint's basic settings like custom fields, identifiers, and invoicing settings.

Reference: https://beta-docs.payabli.com/api-reference/paypoint/get-paypoint-settings

## Authentication

- `requestToken` header (required) — API Key authentication via header

## Servers

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

## Request

### Path parameters

- `entry` (string, required) — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)

## Response

### 200

Success

- `customFields` (list of KeyValue, optional) — Any custom fields defined for the org.
- `forInvoices` (list of KeyValue, optional)
- `forPayOuts` (list of KeyValue, optional)
- `forWallets` (list of KeyValue, optional) — Information about digital wallet settings for the entity.
- `general` (list of KeyValue, optional)
- `identifiers` (list of KeyValue, optional)

## Errors

### 400 Bad Request Error

Bad request/ invalid data

- `any`

### 401 Unauthorized Error

Unauthorized request.

- `any`

### 500 Internal Server Error

Internal API Error

- `any`

### 503 Service Unavailable Error

Database connection error

- `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `responseData` (map from string to any, optional) — The object containing the response data.
- `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'.

## Types

### KeyValue

- `key` (string, optional) — Key name.
- `readOnly` (boolean, optional) — When `true`, the element is read-only.
- `value` (string, optional) — Key value.

## Examples

**Response**

```json
{
  "customFields": [
    {
      "key": "customerID",
      "readOnly": false,
      "value": ""
    },
    {
      "key": "test",
      "readOnly": false,
      "value": ""
    },
    {
      "key": "newfield",
      "readOnly": false,
      "value": ""
    },
    {
      "key": "testfield",
      "readOnly": false,
      "value": ""
    }
  ],
  "forInvoices": [
    {
      "key": "brandColor",
      "value": "#0594fad1"
    },
    {
      "key": "requiredInvoiceNumber",
      "value": "true"
    },
    {
      "key": "invoicePrefix",
      "value": "INV-"
    },
    {
      "key": "invoiceNumber",
      "value": "1"
    },
    {
      "key": "dueDate",
      "value": "NET30"
    },
    {
      "key": "dueDateCustom",
      "value": "Invalid Date"
    },
    {
      "key": "memoNote",
      "value": "Thank you for your business!"
    },
    {
      "key": "footerNote",
      "value": "default footer testing"
    },
    {
      "key": "includePaymentLink",
      "value": "true"
    },
    {
      "key": "paylinkHeader",
      "value": "Gruzya Adventure Outfitters"
    },
    {
      "key": "paylinkDescription",
      "value": "Pay Invoice"
    },
    {
      "key": "contactUsText",
      "value": "Contact Us"
    },
    {
      "key": "contactUsEmail",
      "value": "support@gruzyaadventureoutfitters.com"
    },
    {
      "key": "contactUsPhone",
      "value": "5551234567"
    },
    {
      "key": "invoiceNumbering",
      "value": "autoapply"
    },
    {
      "key": "paymentVisa",
      "value": "true"
    },
    {
      "key": "paymentMastercard",
      "value": "true"
    },
    {
      "key": "paymentDiscover",
      "value": "true"
    },
    {
      "key": "paymentAmex",
      "value": "true"
    },
    {
      "key": "paymentAch",
      "value": "true"
    },
    {
      "key": "paymentApplePay",
      "value": "false"
    },
    {
      "key": "paymentGooglePay",
      "value": "false"
    },
    {
      "key": "requireInvoiceNumber",
      "value": "false"
    },
    {
      "key": "autoCreateInvoice",
      "value": "true"
    },
    {
      "key": "",
      "value": ""
    }
  ],
  "forPayOuts": [
    {
      "key": "autoCapture",
      "readOnly": false,
      "value": "true"
    },
    {
      "key": "autoPay",
      "readOnly": false,
      "value": "true"
    },
    {
      "key": "autoDownloadCheckImage",
      "readOnly": false,
      "value": "false"
    }
  ],
  "forWallets": [
    {
      "key": "isApplePayEnabled",
      "readOnly": false,
      "value": "false"
    }
  ],
  "general": [
    {
      "key": "currency",
      "readOnly": true,
      "value": "USD"
    },
    {
      "key": "disableAutoReceipt",
      "readOnly": true,
      "value": "true"
    },
    {
      "key": "sendApprovedReceipt",
      "readOnly": false,
      "value": "true"
    },
    {
      "key": "sendDeclinedReceipt",
      "readOnly": false,
      "value": "true"
    },
    {
      "key": "",
      "readOnly": true,
      "value": ""
    }
  ],
  "identifiers": [
    {
      "key": "key",
      "readOnly": false,
      "value": "value"
    }
  ]
}
```

**SDK Code**

```python Example settings configuration
import requests

url = "https://api-sandbox.payabli.com/api/Paypoint/settings/8cfec329267"

headers = {"requestToken": "<apiKey>"}

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

print(response.json())
```

```javascript Example settings configuration
const url = 'https://api-sandbox.payabli.com/api/Paypoint/settings/8cfec329267';
const options = {method: 'GET', headers: {requestToken: '<apiKey>'}};

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

```go Example settings configuration
package main

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

func main() {

	url := "https://api-sandbox.payabli.com/api/Paypoint/settings/8cfec329267"

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

	req.Header.Add("requestToken", "<apiKey>")

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

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

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

}
```

```ruby Example settings configuration
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Paypoint/settings/8cfec329267")

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

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

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

```java Example settings configuration
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Paypoint/settings/8cfec329267")
  .header("requestToken", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Paypoint/settings/8cfec329267', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

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

```csharp Example settings configuration
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/Paypoint/settings/8cfec329267");
var request = new RestRequest(Method.GET);
request.AddHeader("requestToken", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Example settings configuration
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Paypoint/settings/8cfec329267")! 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()
```

> If you're a software company, you're a payments company™