---
canonical_url: "https://docs.composio.dev/toolkits/reloadly"
markdown_url: "https://docs.composio.dev/toolkits/reloadly.md"
product: "platform"
version: null
last_updated: null
---

# Reloadly

Reloadly Gift Cards Sandbox provides a safe test environment for browsing gift card products, inspecting transactions, and testing gift card orders without using production wallet funds.

- **Category:** commerce
- **Auth:** S2S_OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `RELOADLY`
- **Version:** 00000000_00

## Tools

### Calculate Gift Card FX Rate

**Slug:** `RELOADLY_CALCULATE_FX_RATE`

Convert a recipient gift card amount into the connected Reloadly Gift Cards Sandbox wallet currency before ordering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | number | Yes | Positive amount in the recipient currency to convert. Reloadly receives this numeric value as a string query parameter. |
| `currency_code` | string | Yes | Recipient currency code for the gift card amount, such as EUR. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sandbox Account Balance

**Slug:** `RELOADLY_GET_ACCOUNT_BALANCE`

Return the connected Reloadly Gift Cards Sandbox test-wallet balance and currency. This never reads a production wallet.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Gift Card Discounts

**Slug:** `RELOADLY_GET_DISCOUNTS`

Return one page of Reloadly Gift Cards Sandbox discounts, or the current discount for a specific product when product_id is supplied.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 1-based discount-list page to request. Only valid when product_id is omitted; Reloadly reports the response page number as 0-based. |
| `size` | integer | No | Number of discounts to request on a list page. Only valid when product_id is omitted; Reloadly's maximum is not verified. |
| `product_id` | integer | No | Gift card product ID whose current discount to return. Omit this to list a page of discounts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Gift Card Product

**Slug:** `RELOADLY_GET_PRODUCT`

Get one Reloadly Gift Cards Sandbox product and its current denomination, currency, fee, status, and additional-order requirements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | integer | Yes | Gift card product ID returned by RELOADLY_LIST_PRODUCTS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Gift Card Redeem Codes

**Slug:** `RELOADLY_GET_REDEEM_CODES`

Return sensitive card numbers, PINs, and redemption URLs issued for one successful Reloadly Gift Cards Sandbox transaction. Do not log or persist the returned credentials.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transaction_id` | integer | Yes | Successful sandbox order transaction ID whose issued cards are needed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Redeem Instructions

**Slug:** `RELOADLY_GET_REDEEM_INSTRUCTIONS`

Return concise and verbose redemption instructions for one Reloadly Gift Cards Sandbox product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | integer | Yes | Gift card product ID whose redemption instructions are needed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Gift Card Transactions

**Slug:** `RELOADLY_GET_TRANSACTIONS`

Return one filtered page of Reloadly Gift Cards Sandbox transactions, or one transaction by ID when transaction_id is supplied.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 1-based transaction-list page. Only valid when transaction_id is omitted; Reloadly reports the response page number as 0-based. |
| `size` | integer | No | Transactions to request per page. Only valid when transaction_id is omitted; Reloadly's maximum is not verified. |
| `end_date` | string | No | Inclusive range end in YYYY-MM-DD HH:MM:SS format. Supply together with start_date. |
| `start_date` | string | No | Inclusive range start in YYYY-MM-DD HH:MM:SS format. Supply together with end_date. |
| `transaction_id` | integer | No | When supplied, return exactly this transaction; omit it to list or filter transactions. |
| `custom_identifier` | string | No | Filter listed transactions by the unique identifier assigned at order time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Catalog Reference Data

**Slug:** `RELOADLY_LIST_CATALOG_REFERENCE_DATA`

List either Reloadly Gift Cards Sandbox product categories or supported countries from the complete, unpaginated catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource` | string ("product_categories" | "countries") | Yes | Reference collection to return: product_categories or countries. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Gift Card Products

**Slug:** `RELOADLY_LIST_PRODUCTS`

Search the Reloadly Gift Cards Sandbox catalog by name, country, category, denomination type, or global availability, returning one caller-selected page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 1-based result page to request. Reloadly reports the corresponding response page number as 0-based. |
| `size` | integer | No | Number of products to request on this page; Reloadly's maximum is not verified. |
| `is_global` | boolean | No | Filter by whether products are globally available. |
| `country_code` | string | No | Filter by two-letter country ISO code. |
| `product_name` | string | No | Filter products by gift card product name. |
| `include_fixed` | boolean | No | Include products whose denomination type is FIXED. |
| `include_range` | boolean | No | Include products whose denomination type is RANGE. |
| `product_category_id` | string | No | Filter by an ID returned by the product-categories reference collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Order Sandbox Gift Cards

**Slug:** `RELOADLY_ORDER_GIFT_CARDS`

Create a non-reversible Reloadly Gift Cards Sandbox order using a current product denomination. This spends test-wallet funds only. The request is non-idempotent: use a new custom_identifier for every intended order. Never retry an ambiguous timeout or transport failure; first query transactions by custom_identifier to determine whether the order was created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quantity` | integer | Yes | Number of gift cards to order. |
| `pre_order` | boolean | No | Whether to pre-order; use only when the selected product supports it. |
| `product_id` | integer | Yes | Current ACTIVE product ID verified with RELOADLY_GET_PRODUCT. |
| `unit_price` | number | Yes | Price in the product's recipient currency; use a current fixed denomination or a value within the current RANGE limits. |
| `sender_name` | string | Yes | Name displayed on the gift card receipt. |
| `product_user_id` | string | No | Product-specific user ID; supply only when RELOADLY_GET_PRODUCT reports that user_id_required is true. |
| `recipient_email` | string | No | Recipient email. If omitted, Reloadly sends no recipient email. |
| `custom_identifier` | string | Yes | Caller-generated unique identifier for this intended order. Never reuse an example, fixture, prior transaction value, or an ambiguous prior attempt's identifier for a different order. |
| `recipient_phone_number` | string | No | Recipient number in E.164 format; provide together with recipient_phone_country_code. |
| `recipient_phone_country_code` | string | No | Recipient phone country ISO code; provide together with recipient_phone_number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |