Papaya Global

https://docs.papayaglobal.com/
Admin
Papaya Global is a workforce payments API platform providing secure payment processing, beneficiary...
Tokens:101,347
Snippets:480
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Query Documentation Dynamically

Source: https://docs.papayaglobal.com/real-life-scenarios

Perform an HTTP GET request on a documentation URL with an 'ask' query parameter to get dynamic answers to specific questions.

```HTTP
GET https://docs.papayaglobal.com/real-life-scenarios.md?ask=<question>
```

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

### Example API Endpoint

Source: https://docs.papayaglobal.com/api-test

This section details a sample GET endpoint with various parameter types and response examples.

```APIDOC
## GET https://example.com/example

### Description
This endpoint demonstrates the structure for API requests, including path, query, header, cookie, and request body parameters.

### Method
GET

### Endpoint
https://example.com/example

### Parameters
#### Path Parameters
- **id** (String) - Required - Description

#### Query Parameters
- **id** (String) - Required - Description

#### Headers
- **id** (String) - Description

#### Cookies
- **id** (String) - Description

#### Request Body
- **id** (String) - Description

### Response
#### Success Response (200)
- **example** (object) - good Response

#### Response Example
```json
{
    "example": "request body"
}
```

#### Error Response (404)
- **example** (object) - not found Response

#### Error Response (500)
- **example** (object) - error Response
```

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

### Invite Beneficiary Request Example

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/invite-beneficiary-by-email

This example demonstrates the structure of a POST request to invite a beneficiary by email. It includes essential and optional fields for the beneficiary's details.

```json
POST /beneficiaries/invite
{
  "firstName": "John",
  "middleName": "",
  "lastName": "Doe",
  "email": "johndoe1234@gmail.com",
  "beneficiaryId": "ab799704-26ed-4076-87fb-e1a88955a4d22", //optional 
  "payGroupId": "c5747ec7-a310-4be4-8648-a0ac26d3c5b5",//optional
  "invoiceCurrency": "EUR", //optional
  "user_tags": {} //optional
}
```

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

### Get Wallets List Response (200 OK)

Source: https://docs.papayaglobal.com/api-reference/wallets-management/get-wallets-list

Example JSON response for a successful request to retrieve the list of wallets.

```json
{
   "items": [
      {
         "id": "1b15bd2e-2ccb-453e-a873-33eb1230a225",
         "currency": "USD",
         "name": "Demo USD Wallet",
         "type": "wallet",
         "owner": "entity://business/customer/demo:standalone:1708959835/legal/7ed4e296-3b8f-43f1-9e33-9de88cadc35a",
         "funding": {
            "name": "RONKIֹ LTD CMA - EUR",
            "country": "GB",
            "account_number": "UKNWBK60161529100039",
            "bic": "CHASGB2L",
            "iban": "UKNWBK60161529100039"
         },
         "balance": 120000,
         "user_tags": {
            "department": "sales"
         },
         "state": "ACTIVE"
      },
      {
         "id": "1fd071bc-df1e-4947-a162-d50c39629204",
         "currency": "GBP",
         "name": "Demo GBP Wallet",
         "type": "wallet",
         "owner": "entity://business/customer/demo:standalone:1708959835/legal/7ed4e296-3b8f-43f1-9e33-9de88cadc35a",
         "funding": {
            "country": "GB",
            "account_number": "GBAB1236bb7f",
            "iban": "GBAB1236bb7f",
            "coffee": "ES",
            "name": "RAUL LTD CMA - EUR",
            "bic": "CHASGB2L"
         },
         "balance": 120000,
         "user_tags": {},
         "state": "ACTIVE"
      },
      {
         "id": "bcc045d6-ea6f-4830-939e-a0e8b5e17f08",
         "currency": "EUR",
         "name": "Demo EUR Wallet",

```

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

### Query Documentation via HTTP GET

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/get-schema-information

Perform an HTTP GET request to the current page URL with the `ask` query parameter to get dynamic information. The question should be specific and in natural language.

```http
GET https://docs.papayaglobal.com/api-reference/beneficiaries-management/get-schema-information.md?ask=<question>
```

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

### Create Beneficiary Request Example

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/create-a-beneficiary

This example demonstrates the structure of a POST request to create a new beneficiary. It includes details for both the entity and bank information.

```json
POST /payments/beneficiaries
{
   "entity_type": "INDIVIDUAL",
   "country": "US",
   "currency": "USD",
   "user_tags": {
      "department": "R&D",
      "cost_center": "US"
   },
   "entity": {
      "individual_first_name": "Smith",
      "individual_last_name": "Johny",
      "date_of_birth": "1970-01-01",
      "address_line_1": "944 Fairfield Street",
      "address_city": "Los Angeles",
      "address_country": "US",
      "address_country_subdivision": "CA",
      "address_postal_code": "90210"
   },
   "bank_details": {
      "account_name": "John Smith",
      "account_number": "1234567",
      "bank_code": "123456789",
      "bank_name": "Bank of America ",
      "bank_identifier_code": "BOFAUS22XXX"
   }
}
```

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

### Invite Beneficiary Response Example (200 OK)

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/invite-beneficiary-by-email

This example shows a successful response when a beneficiary invitation is sent. It includes details about the invited user, invitation status, and expiration, along with confirmation of update and create operations.

```json
{
  "invite": {
    "user_id": "demo-user-1234",
    "user_psa_status": "INVITED",
    "invite_expires_at": "2025-07-09T21:42:14"
  },
  "update": true,
  "create": true,
  "name": {
    "firstName": "Alice",
    "middleName": "",
    "lastName": "Smith",
    "email": "alice.smith@example.com",
    "beneficiaryId": "demo-beneficiary-5678",
    "payGroupId": "demo-paygroup-001",
    "invoiceCurrency": "USD",
    "user_tags": {
      "department": "Finance",
      "region": "North America"
    },
    "org_id": "demo-org-1001",
    "user_id": "internal-user-9999",
    "payGroup": {
      "type": "group",
      "id": "demo-paygroup-001",
      "description": "Demo Pay Group for Testing",
      "name": "Demo USD Group",
      "locked": false
```

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

### Query Documentation via HTTP GET

Source: https://docs.papayaglobal.com/api-reference/groups-management/get-payment-groups-list

Perform an HTTP GET request to the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and self-contained.

```http
GET https://docs.papayaglobal.com/api-reference/groups-management/get-payment-groups-list.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/validate-beneficiary

Perform an HTTP GET request on a documentation URL, including the `ask` query parameter with your question. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.papayaglobal.com/api-reference/beneficiaries-management/validate-beneficiary.md?ask=<question>
```

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

### POST /payments/payments/import Request Example

Source: https://docs.papayaglobal.com/api-reference/payment-management/bulk-import-payment-instructions

This example demonstrates the structure of a JSON request body for the bulk import of payment instructions. It includes an array of items, each specifying target, source, amount, execution date, and finality.

```json
POST /payments/payments/import
{
   "items": [
      {
         "target": {
            "id": "20"
         },
         "source": {
            "id": "ba1acd2e-2133-442f-acc4-a74b1b760a04"
         },
         "amount": {
            "type": "LAND",
            "amount": 5000
         },
         "execution": {
            "date": "2024-03-05T09:09:51.509545358Z"
         },
         "final": {
            "is_final": true
         }
      },
      {
         "target": {
            "id": "16"
         },
         "source": {
            "id": "ba1acd2e-2133-442f-acc4-a74b1b760a04"
         },
         "amount": {
            "type": "LAND",
            "amount": 5000
         },
         "execution": {
            "date": "2024-03-02T09:09:51.509426624Z"
         },
         "final": {
            "is_final": true
         }
      }
   ]
}
```

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

### Query Documentation via HTTP GET

Source: https://docs.papayaglobal.com/api-reference/payment-status

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and in natural language.

```http
GET https://docs.papayaglobal.com/api-reference/payment-status.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.papayaglobal.com/api-reference/api-essentials

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, requires clarification, or you want to retrieve related documentation sections.

```http
GET https://docs.papayaglobal.com/api-reference/api-essentials.md?ask=<question>
```

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

### POST /beneficiaries/bulkimport/invite Request Example

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/bulk-invite-beneficiary-via-email

This example demonstrates the structure of a POST request to invite multiple beneficiaries via email. It includes an array of user objects, each with necessary details like name, email, and optional fields such as beneficiary ID, pay group ID, and invoice currency.

```json
POST /beneficiaries/bulkimport/invite
{
  "items": [
    {
      "firstName": "John",
      "middleName": "",
      "lastName": "Doe",
      "email": "johndoe1234@gmail.com",
      "inviteMessage": "Custom text messages for invites are currently not supported, but this feature will be available in a future update. Stay tuned!",
      "beneficiaryId": "ab799704-26ed-4076-87fb-e1a88955a4d22",
      "payGroupId": "c5747ec7-a310-4be4-8648-a0ac26d3c5b5",
      "invoiceCurrency": "EUR",
      "user_tags": {}
    },
    {
      "firstName": "Sahil",
      "middleName": "",
      "lastName": "Sid",
      "email": "sahilsid@gmail.com",
      "inviteMessage": "Custom text messages for invites are currently not supported, but this feature will be available in a future update. Stay tuned!",
      "beneficiaryId": "ab799704-26ed-4076-87fb-e1a8895d22",
      "payGroupId": "c5747ec7-a310-4be4-8648-a0ac2c5b5",
      "invoiceCurrency": "EUR",
      "user_tags": {}
    }
  ]
}
```

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

### Query Documentation via HTTP GET

Source: https://docs.papayaglobal.com/api-reference/groups-management/delete-payment-group

Perform an HTTP GET request to the current page URL with the `ask` query parameter to ask a question. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.papayaglobal.com/api-reference/groups-management/delete-payment-group.md?ask=<question>
```

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

### Error Response Example

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/validate-beneficiary

This example shows the structure of an error response when a job cannot be found.

```json
{
   "error": "not_found",
   "description": "Status standalone.api.job_202000_OqIr2anOSien3wF4RbVN could not be found",
   "error_code": 404
}
}
```

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

### Query Documentation Dynamically

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management

To get additional information not present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.papayaglobal.com/api-reference/beneficiaries-management.md?ask=<question>
```

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

### Perform HTTP GET Request to Query Documentation

Source: https://docs.papayaglobal.com/api-reference/groups-management/get-payment-group-details

To query the documentation dynamically, perform an HTTP GET request on the current page URL and include the `ask` query parameter with your question. The question should be specific and self-contained.

```http
GET https://docs.papayaglobal.com/api-reference/groups-management/get-payment-group-details.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/update-beneficiary-details

Perform an HTTP GET request to the current page URL with the `ask` query parameter to retrieve specific information. The question should be clear and self-contained.

```http
GET https://docs.papayaglobal.com/api-reference/beneficiaries-management/update-beneficiary-details.md?ask=<question>
```

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

### Querying Documentation Dynamically

Source: https://docs.papayaglobal.com/api-reference/collect-information/collect-beneficiary-bank-details

To get additional information not explicitly present on the page, perform an HTTP GET request with the 'ask' query parameter to the documentation URL.

```http
GET https://docs.papayaglobal.com/api-reference/collect-information/collect-beneficiary-bank-details.md?ask=<question>
```

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

### Querying Documentation Dynamically

Source: https://docs.papayaglobal.com/api-reference/groups-management/update-a-payment-group

To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.papayaglobal.com/api-reference/groups-management/update-a-payment-group.md?ask=<question>
```

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

### Query Documentation

Source: https://docs.papayaglobal.com/api-reference/authentication-api

To get more information not explicitly present on the page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.papayaglobal.com/api-reference/authentication-api.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/create-a-beneficiary

Perform an HTTP GET request on a documentation URL with the `ask` query parameter to retrieve specific information. The question should be natural language, specific, and self-contained.

```http
GET https://docs.papayaglobal.com/api-reference/beneficiaries-management/create-a-beneficiary.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.papayaglobal.com/api-reference/payment-management

To get additional information not directly present on a page, make an HTTP GET request to the page URL with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.papayaglobal.com/api-reference/payment-management.md?ask=<question>
```

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

### Query Documentation with `ask` Parameter

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/bulk-import-beneficiary-status

Perform an HTTP GET request to the current page URL, appending the `ask` query parameter with your question. This is useful for retrieving specific information not explicitly stated on the page or for getting clarification.

```http
GET https://docs.papayaglobal.com/api-reference/beneficiaries-management/bulk-import-beneficiary-status.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.papayaglobal.com/api-reference/payment-management/approve-payment-instructions

To get additional information not directly present on the page, perform an HTTP GET request to the page URL with the `ask` query parameter. The question should be specific and in natural language.

```http
GET https://docs.papayaglobal.com/api-reference/payment-management/approve-payment-instructions.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.papayaglobal.com/api-reference/wallets-management/open-a-wallet

To get additional information not directly present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.papayaglobal.com/api-reference/wallets-management/open-a-wallet.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.papayaglobal.com/api-reference/payment-management/update-payment-instructions

Perform an HTTP GET request on the current page URL with the `ask` query parameter to ask questions about the documentation. The question should be specific, self-contained, and written in natural language. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.papayaglobal.com/api-reference/payment-management/update-payment-instructions.md?ask=<question>
```

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

### Get Payments List - Error Response

Source: https://docs.papayaglobal.com/api-reference/payment-management/get-payments-list

This snippet shows an example of a 400 Bad Request response when fetching the payments list.

```APIDOC
## GET /payments

### Description
Retrieves a list of payments. This endpoint is used to fetch payment records.

### Method
GET

### Endpoint
/payments

### Response
#### Error Response (400 - Bad Request)
- **error** (string) - Indicates the type of error, e.g., "bad_request".
- **description** (string) - Provides details about the validation errors.
- **error_code** (integer) - The HTTP status code for the error.

#### Response Example (400)
```json
{
  "error": "bad_request",
  "description": "Validation errors: {\"type\": \"INDIVIDUAL\", \"id\": \"5SYjAkHqXHW0Z2cqBRW4JAAA\", \"cou... at root failed with \"Missing property org_id\"",
  "error_code": 400
}
```
```

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

### Querying Documentation Dynamically

Source: https://docs.papayaglobal.com/api-reference/payment-management/unapprove-payment-instructions

You can ask questions about the documentation by making a GET request to the page URL with an 'ask' query parameter. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.papayaglobal.com/api-reference/payment-management/unapprove-payment-instructions.md?ask=<question>
```

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

### Get Wallet Details Request Example

Source: https://docs.papayaglobal.com/api-reference/wallets-management/get-wallet-details

Use this endpoint to retrieve details for a specific wallet by providing its unique ID in the URL path. Ensure the ID is correctly formatted.

```http
GET /payments/wallets/?id=f6b2776d-53f4-404e-a690-c3766a91d43a
```

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

### Query Documentation via HTTP GET

Source: https://docs.papayaglobal.com/api-test

To get additional information not directly present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.papayaglobal.com/api-test.md?ask=<question>
```

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

### Perform HTTP GET Request with 'ask' Parameter

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/get-beneficiary-details

Use this method to query documentation dynamically. The question should be specific and self-contained. The response includes a direct answer and relevant excerpts.

```http
GET https://docs.papayaglobal.com/api-reference/beneficiaries-management/get-beneficiary-details.md?ask=<question>
```

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

### Create Beneficiary Error Example

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/create-a-beneficiary

This snippet shows an example of a validation error response when creating a beneficiary.

```APIDOC
## Create A Beneficiary

### Description
This endpoint is used to create a new beneficiary. The example below shows a common validation error.

### Error Handling

#### Response Example (400 Bad Request)
```json
{
  "description": "Validation errors: {\"type\":\"INDIVIDUAL\",\"id\":\"5SYjAkHqXHW0Z2cqBRW4JAAA\",\"cou... at root failed with \"Missing property org_id\"",
  "error_code": 400
}
```
```

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

### 400 Bad Request Response Example

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/bulk-invite-beneficiary-via-email

This example shows a 'bad_request' error response, typically indicating an issue with the format or content of the request payload.

```json
{
    "error": "bad_request",
}
```

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

### Querying Groups Management Documentation

Source: https://docs.papayaglobal.com/api-reference/groups-management

Perform an HTTP GET request on the current page URL with the `ask` query parameter to query the documentation dynamically. 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.

```http
GET https://docs.papayaglobal.com/api-reference/groups-management.md?ask=<question>
```

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

### POST /payments/beneficiaries/validate Request Example

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/validate-beneficiary

This example demonstrates the structure of a request to the bulk beneficiary validation endpoint. It includes a list of items, each with an ID, entity type, and bank details.

```json
POST /payments/beneficiaries/validate
{
   "items": [
      {
         "id": "1",
         "entity_type": "INDIVIDUAL",
         "bank_details": {
            "account_number": "789456123012",
            "bank_code": "111000025",
            "account_country": "US",

```

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

### Dynamic Documentation Querying

Source: https://docs.papayaglobal.com/api-test

Instructions on how to query the API documentation dynamically using a GET request with an 'ask' parameter.

```APIDOC
## Querying Documentation

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

```
GET https://docs.papayaglobal.com/api-test.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.
```

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

### Query Documentation via HTTP GET

Source: https://docs.papayaglobal.com/api-reference/beneficiaries-management/invite-beneficiary-by-email

Use this method to ask questions about the documentation when the answer is not directly available. The question should be specific and in natural language.

```http
GET https://docs.papayaglobal.com/api-reference/beneficiaries-management/invite-beneficiary-by-email.md?ask=<question>
```
Tokens:
Raw