### Callback example headers and payload

Source: https://partner.getpliant.com/docs/callbacks

An example of the headers and raw JSON payload received in a callback.

```sql
webhook-id: fcc8b37b-9f9a-4e2c-bd0d-4e0610d92ec5
webhook-timestamp: 123456789
webhook-signature: v1a,t6CRz6htNVgx9O1y4PjSeBFZRlhu4fk0fZJy8pYEkgSp4hiOaowWLLzJM737t3jTZNlcw/Tc+m/8tGxm95qsAw==

{"test": true}
```

--------------------------------

### Event Format Examples

Source: https://partner.getpliant.com/docs/pci-widget-web

Examples of event objects triggered by the widget.

```json
{eventType: {eventType}, frameId: {frameId}}
```

```json
{eventType: CARD_DATA_CLEARED, frameId: myFrame123}
```

--------------------------------

### Example PCI Widget iframe with Parameters

Source: https://partner.getpliant.com/docs/pci-widget-web

An example of a fully parameterized iframe for the PCI widget, including a sample traceId and a JSON string for widget configuration.

```html
<iframe 
 src="https://pci-api.getpliant.com/card-details/widget?traceId=5c68c142-50a0-46e1-8a27-736a7908cc59&params=ewogICJ0aXRsZSI6ICJDYXJkIERldGFpbHMiLAogICJ0b2tlbiI6ICJ7cmVxdWVzdGVkIE9UUH0iLAogICJjYXJkSWQiOiAie1BsaWFudCdzIGNhcmRJZH0iLAogICJvdmVybGF5VGV4dCI6ICJTaG93IGNhcmQgZGV0YWlscyIsCiAgImNvcHlMYWJlbCI6ICJDb3B5IiwKICAiZnJhbWVJZCI6ICJjYXJkLWRldGFpbHMtd2lkZ2V0LWZyYW1lIiwKICAiY3NzQ2xhc3MiOiAid2lkZ2V0LWNvbnRhaW5lciIsCiAgInN0eWxlVXJsIjogIi4vd2lkZ2V0L3N0YXRpYy9wY2ktd2lkZ2V0LmNzcyIsCiAgInBhbiI6IHsKICAgICJsYWJlbCI6ICJDYXJkIG51bWJlciIsCiAgICAiZGlzcGxheSI6IHRydWUsCiAgICAiY2xpY2tUb0NvcHkiOiB0cnVlLAogICAgInRleHRPbkNvcHkiOiAiQ29weSBjYXJkIG51bWJlciIKICB9LAogICJjYXJkaG9sZGVyTmFtZSI6IHsKICAgICJsYWJlbCI6ICJDYXJkaG9sZGVyIG5hbWUiLAogICAgImRpc3BsYXkiOiB0cnVlLAogICAgImNsaWNrVG9Db3B5IjogdHJ1ZSwKICAgICJ0ZXh0T25Db3B5IjogIkNvcHkgY2FyZGhvZGRlciBuYW1lIgogIH0sCiAgImV4cGlyeURhdGUiOiB7CiAgICAibGFiZWwiOiAiRXhwIiwKICAgICJkaXNwbGF5IjogdHJ1ZSwKICAgICJjbGlja1RvQ29weSI6IHRydWUsCiAgICAidGV4dE9uQ29weSI6ICJDb3B5IGV4cGlyeSBkYXRlIgogIH0sCiAgImN2diI6IHsKICAgICJsYWJlbCI6ICJDVlYiLAogICAgImRpc3BsYXkiOiB0cnVlLAogICAgImNsaWNrVG9Db3B5IjogdHJ1ZSwKICAgICJ0ZXh0T25Db3B5IjogIkNvcHkgQ1ZWIiAKIH0KfSA=&quot; 
 allow="clipboard-read; clipboard-write">
</iframe>
```

--------------------------------

### Full Example of Test Transaction Generation

Source: https://partner.getpliant.com/docs/generate-test-transactions

This example demonstrates how to generate a test transaction with all optional fields specified. Ensure `cardToken` is provided; other fields have default values.

```json
{
  "cardToken": "123456",
  "numberOfTransactions": 1,
  "status": "CONFIRMED",
  "type": "PURCHASE",
  "amount":{
    "value": 1000,
    "currency": "EUR"
  },
  "fxAmount":{
    "value": 998,
    "currency": "USD"
  },
  "amountRange": {
    "from": 100,
    "to": 1000,
    "currency": "EUR"
  },
  "merchant": {
    "name": "AWS",
    "mcc": "9876"
  },
  "transactionCategory": "ADVERTISING_AND_MARKETING"
}
```

--------------------------------

### TOTP Main Method Example

Source: https://partner.getpliant.com/docs/totp-generation-example

Example usage of the TOTP generation within the main method. It defines a 64-byte seed for HMAC-SHA512 and initializes a time variable T0.

```java
public static void main(String[] args) {
        // Seed/Key for HMAC-SHA512 - 64 bytes
        String seed64 = "3132333435363738393031323334353637383930"
        + "3132333435363738393031323334353637383930"
        + "3132333435363738393031323334353637383930"
        + "31323334";
        long T0 = 0;
    }
```

--------------------------------

### Example Cardholder Data

Source: https://partner.getpliant.com/docs/cardholder-entity

Provides a concrete example of a cardholder object with sample values for all defined fields.

```json
{
  "cardholderId": "6e545ed3-a303-4da4-b419-757916ce15cd",
 	"saluation": "MR",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "[email protected]",
  "phoneNumber": "+491234567890",
  "language": "en",
  "isOwner": true,
  "status": "INVITED"
}
```

--------------------------------

### Initialize MeaPushProvisioning

Source: https://partner.getpliant.com/docs/google-android-implementation

Initialize the SDK instance before performing any provisioning operations.

```java
if (!MeaPushProvisioning.isInitialized()) {
    MeaPushProvisioning.initialize(this);
}
```

--------------------------------

### Example Cardholder Data

Source: https://partner.getpliant.com/docs/cardholder-entity

Provides an example JSON object representing cardholder data.

```APIDOC
### Example Data

#### Request Body Example
```json
{
  "cardholderId": "6e545ed3-a303-4da4-b419-757916ce15cd",
  "salutation": "MR",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@gmail.com",
  "phoneNumber": "+491234567890",
  "language": "en",
  "isOwner": true,
  "status": "ACTIVE"
}
```
```

--------------------------------

### Basic Authentication Example

Source: https://partner.getpliant.com/docs/existing-pliant-customer-starts-integration

Explains how Basic authentication works by sending username and password in the Authorization header, base64 encoded.

```text
Your username and password are being sent in the [header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) of the request.
```

--------------------------------

### Configure WebView Component

Source: https://partner.getpliant.com/docs/react-native-mobile-widget

Basic setup for the WebView component with required properties like baseUrl and originWhitelist.

```jsx
<WebView
  style={style}
  source={{
    baseUrl: 'https://localhost',
    html,
  }}
  originWhitelist={['*']}
  javaScriptEnabled
  scrollEnabled={false}
  onMessage={onMessage}
/>
```

--------------------------------

### Example Receipt Data

Source: https://partner.getpliant.com/docs/receipt-entity

This JSON structure represents an example of receipt data that can be attached to a transaction. It includes identifiers, timestamps, and file details.

```json
[
  {
    "receiptId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2022-04-01T07:28:00.092Z",
    "filename": "string",
    "mimeType": "PNG"
  }
]
```

--------------------------------

### Get Onboarding Submission Details

Source: https://partner.getpliant.com/reference/get-onboarding-submission-document

Retrieves the current onboarding submission details, including the full payload. Use this to get the complete form state.

```APIDOC
## GET /llmstxt/partner_getpliant_llms_txt

### Description
Returns the current onboarding submission details including the full payload. Use this to retrieve the full form state.

### Method
GET

### Endpoint
/llmstxt/partner_getpliant_llms_txt

### Parameters

### Request Body
None

### Response
#### Success Response (200)
- **submissionDetails** (object) - The full onboarding submission details.

#### Response Example
```json
{
  "submissionDetails": {
    "field1": "value1",
    "field2": "value2"
  }
}
```
```

--------------------------------

### POST /easylaunch

Source: https://partner.getpliant.com/docs/web-widget-meawallet

This endpoint is used to launch a card with specific details. It requires authentication and card identification parameters.

```APIDOC
## POST /easylaunch

### Description
This endpoint is used to launch a card with specific details. It requires authentication and card identification parameters.

### Method
POST

### Endpoint
`https://public.test.meawallet.com/easylaunch` (Test)
`https://mcd.meawallet.com/easylaunch` (Production)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **cardId** (string) - Required - The `token` value from the card details endpoint for the specific card you want to show.
- **uniqueToken** (string) - Required - A TOTP token valid for this one call. It consists of a 3-digit Key ID, a 1-symbol separator, and an 8-digit TOTP.
- **apiKeyId** (string) - Required - The public key fingerprint.
- **apiKey** (string) - Required - The public key.
- **fieldNames** (string) - Optional - This string-escaped JSON allows to customize card value field names. Empty by default.
- **loader** (string) - Optional - The style of the loader. Available values - `bars`, `dots`, `spinner`. `dots` by default.
- **styleUrl** (string) - Optional - A URL to custom style CSS.

### Request Example
```json
{
  "cardId": "example_card_id",
  "uniqueToken": "123-12345678",
  "apiKeyId": "example_api_key_id",
  "apiKey": "example_api_key",
  "fieldNames": "{\"name\": \"Full Name\", \"email\": \"Email Address\"}",
  "loader": "spinner",
  "styleUrl": "https://example.com/custom.css"
}
```

### Response
#### Success Response (200)
This endpoint does not explicitly define a success response body in the provided documentation. It is assumed to return a success status code upon successful execution, potentially with a redirect or a minimal confirmation.

#### Response Example
(No specific example provided in the documentation. Typically, a successful launch might result in a redirect or a simple success indicator.)
```

--------------------------------

### Configure Bundle Identifiers for Wallet Extensions

Source: https://partner.getpliant.com/docs/apple-ios-implementation

Example of the required bundle identifier structure for the main app and its associated extensions.

```text
A1B2C3D4E5.com.bank.app
A1B2C3D4E5.com.bank.app.IssuerNonUIExtension
A1B2C3D4E5.com.bank.app.IssuerUIExtension
```

--------------------------------

### Configuration Parameters

Source: https://partner.getpliant.com/docs/pci-widget-web

List of parameters used in the configuration object.

```text
token
```

```text
string
```

```text
cardId
```

```text
uuid
```

```text
title
```

```text
string
```

```text
styleUrl
```

```text
string
```

```text
{fieldName}.label
```

```text
string
```

```text
pan
```

--------------------------------

### Configure WebView for PCI Widget in Java

Source: https://partner.getpliant.com/docs/android-specific-mobile-widget

Set up a WebView with transparent background and enabled JavaScript. Load the generated HTML content using `loadDataWithBaseURL`, ensuring the base URL is set to 'https://localhost'.

```java
WebView wvContent = this.findViewById(R.id.pci_widget_web_view);
wvContent.setBackgroundColor(Color.TRANSPARENT);
wvContent.getSettings().setJavaScriptEnabled(true);

URL baseUrl = new URL("https://localhost");

wvContent.loadDataWithBaseURL(
    baseUrl.toString(),
    getHtml(),
    "text/html",
    "UTF-8",
    null
);
```

--------------------------------

### Partner Get Pliant LLMs TXT API

Source: https://partner.getpliant.com/reference/get-accounting-category

This section details the Partner Get Pliant LLMs TXT API, including its available methods, parameters, and response structures.

```APIDOC
## GET /llmstxt/partner_getpliant_llms_txt

### Description
Retrieves a list of pliant LLMs text data for partners.

### Method
GET

### Endpoint
/llmstxt/partner_getpliant_llms_txt

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return.
- **offset** (integer) - Optional - The number of results to skip before starting to collect the result set.

### Request Example
```json
{
  "example": "GET /llmstxt/partner_getpliant_llms_txt?limit=10&offset=0"
}
```

### Response
#### Success Response (200)
- **data** (array) - A list of pliant LLMs text objects.
  - **id** (string) - The unique identifier for the LLM text.
  - **text** (string) - The content of the LLM text.
  - **created_at** (string) - The timestamp when the LLM text was created.
  - **updated_at** (string) - The timestamp when the LLM text was last updated.

#### Response Example
```json
{
  "example": {
    "data": [
      {
        "id": "llm_txt_123",
        "text": "This is an example LLM text.",
        "created_at": "2023-10-27T10:00:00Z",
        "updated_at": "2023-10-27T10:00:00Z"
      }
    ]
  }
}
```

### Error Handling
#### Error Response (400)
- **code** (string) - The error code.
- **message** (string) - A description of the error.

#### Error Response (401)
- **code** (string) - The error code.
- **message** (string) - A description of the error.

#### Error Response (403)
- **code** (string) - The error code.
- **message** (string) - A description of the error.

#### Error Response (404)
- **code** (string) - The error code.
- **message** (string) - A description of the error.

#### Error Response (500)
- **code** (string) - The error code.
- **message** (string) - A description of the error.
```

--------------------------------

### Configure WebView Transparency

Source: https://partner.getpliant.com/docs/ios-specific-mobile-widget

Sets up a WKWebView with a transparent background and loads the HTML string.

```swift
let webView = WKWebView();

// to make it transparent
webView.backgroundColor = .clear
webView.isOpaque = false

let baseUrl = URL(string: "https://localhost");
webView.loadHTMLString(html, baseURL: baseUrl);
```

--------------------------------

### Partner Get Pliant LLMs API

Source: https://partner.getpliant.com/reference/get-receipt-detail

This section details the Partner Get Pliant LLMs API, focusing on its responses and error handling mechanisms. It outlines potential HTTP status codes and their corresponding error descriptions.

```APIDOC
## GET /llmstxt/partner_getpliant_llms_txt

### Description
Retrieves information about Pliant LLMs for partners.

### Method
GET

### Endpoint
/llmstxt/partner_getpliant_llms_txt

### Responses
#### Success Response (200)
- **(Type)** - Description of the successful response body.

#### Error Responses
- **400 Bad Request**: The API consumer sent a malformed request which could not be processed.
- **401 Unauthorized**: The API consumer is not authorized to access the requested resource.
- **403 Forbidden**: The API consumer is not allowed to access the requested resource.
- **404 Not Found**: The requested resource could not be found.
- **500 Internal Server Error**: The request was not completed due to an internal error.

#### Error Response Schema (Common for 4xx/5xx errors)
```json
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "An error code that can be used for programmatic error handling."
    },
    "message": {
      "type": "string",
      "description": "The cause of the error or further explanations on the error."
    }
  }
}
```

### Security
- **bearerAuth**: Requires a Bearer token for authentication.
```

--------------------------------

### Initialize Apple Pay In-App Provisioning

Source: https://partner.getpliant.com/docs/apple-ios-implementation

Start Apple Pay In-App provisioning using MeaPushProvisioning.initializeOemTokenization with MppCardDataParameters. Check primaryAccountIdentifier for card eligibility and caching.

```swift
let isPassLibraryAvailable = PKPassLibrary.isPassLibraryAvailable()
let canAddPaymentPass = PKAddPaymentPassViewController.canAddPaymentPass()

if (isPassLibraryAvailable && canAddPaymentPass) {
    MeaPushProvisioning.initializeOemTokenization(mppCardParameters) { (responseData, error) in
        if (responseData?.isValid())! {
            // Field primaryAccountIdentifier is always empty for the very first tokenization of the card.
            var canAddPaymentPassWithPAI = true
            if let primaryAccountIdentifier = responseData?.primaryAccountIdentifier, !primaryAccountIdentifier.isEmpty {
                if #available(iOS 13.4, *) {
                    canAddPaymentPassWithPAI = MeaPushProvisioning.canAddSecureElementPass(primaryAccountIdentifier: primaryAccountIdentifier)
                } else {
                    canAddPaymentPassWithPAI = MeaPushProvisioning.canAddPaymentPass(withPrimaryAccountIdentifier: primaryAccountIdentifier)
                }
            }

            if (canAddPaymentPassWithPAI) {
                self.tokenizationResponseData = responseData;

                // Show "Add to Apple Wallet" button.
                // ...
            }
        }
    }
}
```

--------------------------------

### GET /llmstxt/partner_getpliant_llms_txt

Source: https://partner.getpliant.com/reference/get-team

Retrieves details for a single team.

```APIDOC
## GET /llmstxt/partner_getpliant_llms_txt

### Description
Returns details on a single team.

### Method
GET

### Endpoint
/llmstxt/partner_getpliant_llms_txt

### Parameters
#### Query Parameters
- **team_id** (string) - Required - The unique identifier for the team.

### Response
#### Success Response (200)
- **team_name** (string) - The name of the team.
- **member_count** (integer) - The number of members in the team.
- **creation_date** (string) - The date the team was created (ISO 8601 format).

#### Response Example
```json
{
  "team_name": "Alpha Squad",
  "member_count": 5,
  "creation_date": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### POST /partner/onboarding-submissions/subscription

Source: https://partner.getpliant.com/reference/create-onboarding-submission-subscription

Subscribe to callbacks for onboarding submission events to receive updates on submission status changes.

```APIDOC
## POST /partner/onboarding-submissions/subscription

### Description
Subscribe to callbacks for onboarding submission events. Callbacks will be sent to the provided callbackUrl when the specified events occur.

### Method
POST

### Endpoint
/partner/onboarding-submissions/subscription

### Parameters
#### Request Body
- **callbackUrl** (string) - Required - The URL to send the callback to. Must be a valid and reachable HTTPS URL.
- **eventTypes** (array) - Required - The event types to subscribe to (e.g., SUBMISSION_SUBMITTED, SUBMISSION_APPROVED, SUBMISSION_REJECTED).

### Request Example
{
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventTypes": ["SUBMISSION_SUBMITTED", "SUBMISSION_APPROVED"]
}

### Response
#### Success Response (201)
- **message** (string) - Subscription created or updated successfully

#### Response Example
{
  "message": "Subscription created or updated successfully"
}
```

--------------------------------

### GET /get-cashback-amounts

Source: https://partner.getpliant.com/llms.txt

Retrieves cashback amounts for an organization.

```APIDOC
## GET /get-cashback-amounts

### Description
Get the cashback amounts for a specific organization.

### Method
GET

### Endpoint
/get-cashback-amounts
```

--------------------------------

### GET /beneficiaries

Source: https://partner.getpliant.com/llms.txt

Query beneficiaries for a specific organization.

```APIDOC
## GET /beneficiaries

### Description
Query beneficiaries for a specific organization. Beneficiaries are entities that can receive external transfers from your organization.

### Method
GET

### Endpoint
/beneficiaries
```

--------------------------------

### API Pagination Example

Source: https://partner.getpliant.com/docs/pagination

Use 'limit' to specify the number of objects per page and 'page' to select the desired page. Defaults to 50 objects per page.

```http
GET /transactions?limit=10

GET /transactions?limit=10&page=2

GET /transactions?limit=10&page=3
```

--------------------------------

### Initialize PKAddPaymentPassViewController

Source: https://partner.getpliant.com/docs/apple-ios-implementation

Present the system view controller to prompt the user to add a payment pass to their library.

```swift
let addPaymentPassRequestConfiguration = self.tokenizationResponseData?.addPaymentPassRequestConfiguration
addPaymentPassRequestConfiguration?.cardholderName = "Cardholder Name"

let paymentPassController =
    PKAddPaymentPassViewController.init(requestConfiguration: addPaymentPassRequestConfiguration!, delegate: self)

self.present(paymentPassController!, animated: true, completion: nil)
```

--------------------------------

### Card ID Parameter

Source: https://partner.getpliant.com/docs/api-pliant-pci-dss-certified

Example data for the cardId parameter.

```text
cardId
```

```text
9b5959d4-cb3b-4f4b-b53f-52cfefb652d5
```

--------------------------------

### Initialize Card Data Parameters

Source: https://partner.getpliant.com/docs/google-android-implementation

Configure card parameters using either CardId/Secret or EncryptedCardData to prepare for the push provisioning flow.

```java
String cardId = "<value>";
String cardSecret = "<value>";

MppCardDataParameters cardParams = MppCardDataParameters.withCardSecret(cardId, cardSecret);
```

```java
String encryptedCardData = "<value>";
String publicKeyFingerprint = "<value>";
String encryptedKey = "<value>";
String initialVector = "<value>";

MppCardDataParameters cardParams = MppCardDataParameters.withEncryptedPan(encryptedCardData,
                                                                          publicKeyFingerprint,
                                                                          encryptedKey,
                                                                          initialVector);
```

--------------------------------

### Get Statement Details

Source: https://partner.getpliant.com/reference/get-statement-detail

Retrieves the details of a single statement.

```APIDOC
## GET /statements/{statement_id}

### Description
Returns the details of a single statement.

### Method
GET

### Endpoint
/statements/{statement_id}

### Parameters
#### Path Parameters
- **statement_id** (string) - Required - The unique identifier of the statement.

### Response
#### Success Response (200)
- **statement_id** (string) - The unique identifier of the statement.
- **content** (string) - The content of the statement.
- **created_at** (string) - The timestamp when the statement was created.
- **updated_at** (string) - The timestamp when the statement was last updated.
```

--------------------------------

### GET /llmstxt/partner_getpliant_llms_txt

Source: https://partner.getpliant.com/reference/get-cards

Retrieves the Pliant card configuration details.

```APIDOC
## GET /llmstxt/partner_getpliant_llms_txt

### Description
Retrieves the Pliant card configuration of a card. This configuration describes all features of the card, including its type and design. It replaces the deprecated card `type`. Refer to the [guide section](/docs/card-entity) for possible values.

### Method
GET

### Endpoint
/llmstxt/partner_getpliant_llms_txt

### Parameters
#### Query Parameters
- **cardId** (string) - Required - The unique identifier of the card.

### Response
#### Success Response (200)
- **cardConfiguration** (object) - The Pliant card configuration.
  - **platformFee** (boolean) - Whether the card is used for the internal Pliant platform fee or not.
  - **cardDesignId** (string) - The unique identifier of the card design used for this specific card.
  - **cardDesignLogoName** (string) - The name of the card design used for this specific card.
  - **createdAt** (string) - The date-time when card was created.
  - **updatedAt** (string) - The date-time when card was updated.

#### Error Response (400, 401, 403, 429, 500)
- **errorCode** (string) - The error code.
- **exceptionId** (string) - The id of the exception that was thrown.
- **message** (string) - The cause of the error or further explanations on the error.

#### Response Example (200 OK)
```json
{
  "cardConfiguration": {
    "platformFee": false,
    "cardDesignId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "cardDesignLogoName": "DefaultLogo",
    "createdAt": "2023-10-27T10:00:00Z",
    "updatedAt": "2023-10-27T10:00:00Z"
  }
}
```

#### Response Example (400 Bad Request)
```json
{
  "errorCode": "INVALID_CARD_ID",
  "exceptionId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
  "message": "The provided card ID is invalid."
}
```

#### Response Example (429 Too Many Requests)
```json
{
  "error": "Rate limit exceeded. Please try again later."
}
```
```

--------------------------------

### Using Bearer Token Authentication

Source: https://partner.getpliant.com/docs/api-pliant-pci-dss-certified

This example demonstrates how to send an API key as a Bearer token in the Authorization header for POST requests. Ensure you replace 'BEARER_TOKEN' with your actual token.

```bash
curl --request POST \
 --url https://httpbin.org/anything/bearer \
 --header 'Authorization: Bearer BEARER_TOKEN'
```

--------------------------------

### GET /organizations/{organizationId}

Source: https://partner.getpliant.com/docs/endpoint-permissions

Retrieve details for a specific organization.

```APIDOC
## GET /organizations/{organizationId}

### Description
Retrieve details for a specific organization.

### Method
GET

### Endpoint
/organizations/{organizationId}

### Parameters
#### Path Parameters
- **organizationId** (string) - Required - The unique identifier of the organization.
```

--------------------------------

### POST /onboarding-submissions

Source: https://partner.getpliant.com/llms.txt

Creates a new onboarding submission for an organization.

```APIDOC
## POST /onboarding-submissions

### Description
Create a new onboarding submission for an organization. The organization must be in an onboarding state. Only one active submission per organization is allowed.

### Method
POST

### Endpoint
/onboarding-submissions
```

--------------------------------

### GET /organizations

Source: https://partner.getpliant.com/docs/endpoint-permissions

Retrieve a list of organizations associated with the partner.

```APIDOC
## GET /organizations

### Description
Retrieve a list of organizations associated with the partner.

### Method
GET

### Endpoint
/organizations
```

--------------------------------

### GET /statements

Source: https://partner.getpliant.com/reference/get-statements

Retrieves a list of statements with optional sorting parameters.

```APIDOC
## GET /statements

### Description
Retrieves a list of statements. Supports sorting by organizationId or createdAt in ascending or descending order.

### Method
GET

### Endpoint
/statements

### Parameters
#### Query Parameters
- **sortBy** (string) - Optional - The field to sort by. Enum: [organizationId, createdAt]
- **sortDirection** (string) - Optional - The direction to sort by. Enum: [ASC, DESC]

### Response
#### Success Response (200)
- **data** (array) - List of Statement objects
- **hasNextPage** (boolean) - Indicates whether there is a next page available.

#### Response Example
{
  "data": [
    {
      "statementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "statementCreatedAt": "2023-10-27T10:00:00Z",
      "isClosed": true
    }
  ],
  "hasNextPage": false
}
```

--------------------------------

### POST /partner/onboarding-submissions

Source: https://partner.getpliant.com/reference/create-onboarding-submission

Creates a new onboarding submission for an organization. The organization must be in a valid onboarding state, and only one active submission is permitted per organization.

```APIDOC
## POST /partner/onboarding-submissions

### Description
Create a new onboarding submission for an organization. The organization must be in an onboarding state (ONBOARDING_STARTED, ONBOARDING_RISK_AND_COMPLIANCE, ONBOARDING_MANDATES_AND_TERMS, DEACTIVATED, CANCELLED). Only one active submission per organization is allowed.

### Method
POST

### Endpoint
/partner/onboarding-submissions

### Request Body
- **organizationId** (string, uuid) - Required - The unique identifier of the organization.
- **partnerOrganizationId** (string) - Optional - The partner-specific organization identifier.

### Request Example
{
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "partnerOrganizationId": "partner-org-123"
}

### Response
#### Success Response (201)
- **submissionId** (string, uuid) - The unique identifier of the created submission.
- **status** (string) - The current lifecycle state of the submission.
- **organizationId** (string, uuid) - The organization identifier.
- **partnerOrganizationId** (string) - The partner-specific organization identifier.
- **decisionResult** (object) - The result of the submission decision.

#### Response Example
{
  "submissionId": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
  "status": "IN_PROGRESS",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000"
}
```

--------------------------------

### GET /payments

Source: https://partner.getpliant.com/reference/get-payments

Retrieves a list of payments with options for pagination and sorting.

```APIDOC
## GET /payments

### Description
Retrieves a list of payments. Supports pagination and sorting.

### Method
GET

### Endpoint
/payments

### Query Parameters
- **page** (integer) - Optional - The page number to return, starting with 0. The total number of pages is determined by the total number of records divided by the limit.
- **sortBy** (string) - Optional - The field to sort by. Allowed values: organizationId, status, type, cutoffDate, collectionDate, paymentDate, createdAt.
- **sortDirection** (string) - Optional - The direction to sort by. Allowed values: ASC, DESC.

### Responses
#### Success Response (200)
- **data** (array) - An array of Payment objects.
- **hasNextPage** (boolean) - Indicates whether there is a next page available.

#### Response Example
```json
{
  "data": [
    {
      "paymentId": "string (uuid)",
      "organizationId": "string (uuid)",
      "cardAccountId": "string (uuid)",
      "publicPaymentId": "string | null",
      "type": "string (enum: BILL, TOPUP, DIRECT_DEBIT_REVERSAL, BILL_PAYMENT_REVERSAL, PAYOUT, OTHER)",
      "method": "string (enum: DIRECT_DEBIT_CORE, DIRECT_DEBIT_B2B, WIRE_TRANSFER)",
      "amount": {
        "value": "integer",
        "currency": "string"
      },
      "status": "string",
      "cutoffDate": "string (date-time)",
      "collectionDate": "string (date-time)",
      "paymentDate": "string (date-time)",
      "createdAt": "string (date-time)",
      "updatedAt": "string (date-time)"
    }
  ],
  "hasNextPage": true
}
```

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **429** - Too Many Requests
- **500** - Internal Server Error
```

--------------------------------

### Load Custom Configuration for MeaPushProvisioning

Source: https://partner.getpliant.com/docs/apple-ios-implementation

Load a custom configuration file for the MPP SDK by calling MeaPushProvisioning.loadConfig with the custom filename. Ensure the configuration file is placed in your application bundle.

```swift
import MeaPushProvisioning

...

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

    MeaPushProvisioning.loadConfig("custom_config_name")

    ...

    return true
}
```

--------------------------------

### Configure Gradle for MPP SDK

Source: https://partner.getpliant.com/docs/google-android-installation

Add the MPP SDK to your project by configuring the build.gradle file with the private Maven repository URL and credentials. Use debugImplementation for development and releaseImplementation for production builds.

```gradle
repositories {
    maven {
        url 'https://nexus.ext.meawallet.com/repository/mpp-android-group/'
        credentials {
            username '<user>'
            password '<password>'
        }
    }
}
dependencies {
    debugImplementation 'com.meawallet:mpp-<environment>:<version>-debug'
    releaseImplementation 'com.meawallet:mpp-<environment>:<version>'
}
```

--------------------------------

### GET /projects

Source: https://partner.getpliant.com/reference/get-projects

Retrieves a list of projects with support for filtering and sorting.

```APIDOC
## GET /projects

### Description
Returns a list of projects. Projects act as a cost unit for accounting purposes.

### Method
GET

### Endpoint
/projects

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return.
- **page** (integer) - Optional - The page number to retrieve.
- **sortBy** (string) - Optional - The field to sort the results by.
- **sortDirection** (string) - Optional - The direction of the sort (e.g., asc, desc).

### Response
#### Success Response (200)
- **projects** (array) - A list of project objects.
```

--------------------------------

### GET /llmstxt/partner_getpliant_llms_txt

Source: https://partner.getpliant.com/reference/get-mobile-wallet-tokenization-details

Retrieves the details for a single Mobile Wallet Token.

```APIDOC
## GET /llmstxt/partner_getpliant_llms_txt

### Description
Retrieves the details for a single Mobile Wallet Token.

### Method
GET

### Endpoint
/llmstxt/partner_getpliant_llms_txt

### Parameters
#### Query Parameters
- **token_id** (string) - Required - The unique identifier for the Mobile Wallet Token.

### Response
#### Success Response (200)
- **token_details** (object) - Contains the detailed information about the token.
  - **token_type** (string) - The type of the token.
  - **creation_date** (string) - The date when the token was created.
  - **expiry_date** (string) - The date when the token expires.
  - **status** (string) - The current status of the token (e.g., active, inactive, revoked).

#### Response Example
```json
{
  "token_details": {
    "token_type": "payment",
    "creation_date": "2023-10-27T10:00:00Z",
    "expiry_date": "2024-10-27T10:00:00Z",
    "status": "active"
  }
}
```
```

--------------------------------

### Bearer Token Authentication Example

Source: https://partner.getpliant.com/docs/existing-pliant-customer-starts-integration

Demonstrates how to use Bearer token authentication with curl. The token is sent in the Authorization header.

```bash
curl --request POST \
 --url https://httpbin.org/anything/bearer
 --header 'Authorization: Bearer BEARER_TOKEN'
```

--------------------------------

### POST /onboarding/submissions

Source: https://partner.getpliant.com/reference/create-onboarding-submission

Creates a new onboarding submission for an organization. Ensures the organization is in a valid onboarding state and that no other active submission exists.

```APIDOC
## POST /onboarding/submissions

### Description
Create a new onboarding submission for an organization. The organization must be in an onboarding state (ONBOARDING_STARTED, ONBOARDING_RISK_AND_COMPLIANCE, ONBOARDING_MANDATES_AND_TERMS, DEACTIVATED, CANCELLED). Only one active submission per organization is allowed.

### Method
POST

### Endpoint
/onboarding/submissions
```

--------------------------------

### GET /custom-field-options

Source: https://partner.getpliant.com/reference/get-custom-field-options

Retrieves a paginated list of custom field options.

```APIDOC
## GET /custom-field-options

### Description
Retrieves a list of custom field options available in the system.

### Method
GET

### Endpoint
/custom-field-options

### Response
#### Success Response (200)
- **data** (array) - List of custom field option objects.
  - **id** (string, uuid) - The id of the custom field option.
  - **customFieldId** (string, uuid) - The id of the custom field this option belongs to.
  - **name** (string) - The name of the custom field option.
  - **value** (string) - The internal value of the custom field option.
  - **status** (string) - The status of the option (ACTIVE or INACTIVE).
  - **isDefault** (boolean) - Whether this is the default option.
  - **createdAt** (string, date-time) - Creation timestamp.
  - **updatedAt** (string, date-time) - Last update timestamp.
- **hasNextPage** (boolean) - Indicates whether there is a next page available.
```