PayDo

https://docs.paydo.com/
Admin
PayDo is a secure and scalable unified financial platform that allows businesses to manage global...
Tokens:100,327
Snippets:1,645
Trust Score:9
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET Get FX configuration

Source: https://docs.paydo.com/merchant-account-new/merchant-balance-management/currency-conversion-fx/get-fx-configuration

Retrieves the FX configuration settings for the merchant account.

```APIDOC
## GET Get FX configuration

### Description
Retrieves the FX configuration settings for the merchant account.

### Method
GET

### Endpoint
/merchant-account/balance-management/currency-conversion/fx-configuration
```

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

### GET /Get FX configuration

Source: https://docs.paydo.com/merchant-account-new/merchant-balance-management/balance-api

Retrieves the configuration settings for currency exchange.

```APIDOC
## GET /Get FX configuration

### Description
Retrieves the configuration settings for currency exchange.

### Method
GET

### Endpoint
/Get FX configuration
```

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

### GET /Get conversion preview

Source: https://docs.paydo.com/merchant-account-new/merchant-balance-management/balance-api

Provides a preview of a currency conversion result.

```APIDOC
## GET /Get conversion preview

### Description
Provides a preview of a currency conversion result.

### Method
GET

### Endpoint
/Get conversion preview
```

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

### Get Withdrawal Currencies Response

Source: https://docs.paydo.com/merchant-account-new/merchant-balance-management/withdrawal-api/get-withdrawal-currencies

Example JSON response for a successful withdrawal currency retrieval.

```json
{
  "status": 1,
  "data": {
    "currencies": [
      "USD",
      "EUR",
      "GBP"
    ]
  }
}
```

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

### Initialize Google Pay

Source: https://docs.paydo.com/merchant-account-new/checkout-api/create-checkout

Sends an empty additionalInfo object as Google Pay does not require extra input during initialization.

```bash
curl -X POST 'https://paydo.com/v1/checkout/external-token/initialize' \

-H 'Content-Type: application/json' \

-H 'Accept: application/json' \

-d '{

"invoiceIdentifier": "11111111-1111-1111-1111-111111111111",

"paymentMethodIdentifier": 800,

"additionalInfo": {}

}'
```

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

### GET Get invoice

Source: https://docs.paydo.com/merchant-account-new/invoice-api/get-invoice

Retrieves the details of a specific invoice.

```APIDOC
## GET Get invoice

### Description
Retrieves the details of a specific invoice from the Merchant Account system.

### Method
GET

### Endpoint
/invoice
```

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

### POST /v1/checkout/external-token/initialize

Source: https://docs.paydo.com/merchant-account-new/checkout-api/external-token-initialize/apple-and-google-pay-scenarios

Initializes the wallet payment process by returning configuration data for Google Pay or a merchant session for Apple Pay.

```APIDOC
## POST /v1/checkout/external-token/initialize

### Description
Returns provider-specific data required by the frontend to initialize Apple Pay or Google Pay for a selected invoice and wallet payment method.

### Method
POST

### Endpoint
/v1/checkout/external-token/initialize

### Parameters
#### Request Body
- **invoiceIdentifier** (string UUID) - Required - Invoice UUID.
- **paymentMethodIdentifier** (integer) - Required - Numeric Apple Pay or Google Pay payment method ID.
- **additionalInfo** (object) - Provider-specific - Empty object for Google Pay. Required for Apple Pay.
- **additionalInfo.validationUrl** (string) - Apple Pay only - Validation URL received during the Apple Pay merchant-validation event.
- **additionalInfo.domainName** (string) - Apple Pay only - Merchant domain used for Apple Pay merchant validation.

### Request Example
{
  "invoiceIdentifier": "11111111-1111-1111-1111-111111111111",
  "paymentMethodIdentifier": 800,
  "additionalInfo": {}
}
```

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

### GET Get transaction details

Source: https://docs.paydo.com/merchant-account-new/overview

Retrieves detailed information about a specific transaction.

```APIDOC
## GET /transaction

### Description
Retrieves detailed information about a specific transaction.

### Method
GET

### Endpoint
/transaction
```

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

### Conversion Preview Response Example

Source: https://docs.paydo.com/merchant-account-new/merchant-balance-management/fx-ipn-instant-payment-notification/get-conversion-preview

The JSON response structure returned by the conversion preview endpoint.

```json
{
  "value": null
}
```

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

### Retrieve Conversion Preview via cURL

Source: https://docs.paydo.com/merchant-account-new/merchant-balance-management/fx-ipn-instant-payment-notification/get-conversion-preview

Use this cURL command to request an indicative conversion preview by specifying the source currency, amount, and target currency.

```bash
curl --location 'https://api.paydo.com/v1/currencies/convert-info/EUR/500/USD' \
--header 'token: Bearer YOUR_JWT_TOKEN' \
--header 'Content-Type: application/json'
```

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

### GET Get available payment methods

Source: https://docs.paydo.com/merchant-account-new/overview

Retrieves a list of payment methods available for the merchant.

```APIDOC
## GET /payment-methods

### Description
Retrieves a list of payment methods available for the merchant.

### Method
GET

### Endpoint
/payment-methods
```

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

### GET /v1/checkout/check-invoice-status/{invoiceId}

Source: https://docs.paydo.com/merchant-account-new/authentication-token-creation

Retrieves the status of an invoice.

```APIDOC
## GET /v1/checkout/check-invoice-status/{invoiceId}

### Description
Tracks the result of a checkout by polling the invoice status.

### Method
GET

### Endpoint
/v1/checkout/check-invoice-status/{invoiceId}

### Parameters
#### Path Parameters
- **invoiceId** (string) - Required - The UUID of the invoice.

### Errors
- **404** - Invoice not found.
```

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

### POST /v2/fx/execute/{reserveIdentifier}

Source: https://docs.paydo.com/merchant-account-new/merchant-balance-management/currency-conversion-fx/execute-fx-conversion

Executes a currency conversion at the rate reserved by a prior call to the rate reservation endpoint. The conversion is debited from the source currency balance and credited to the target currency balance of the specified wallet.

```APIDOC
## POST /v2/fx/execute/{reserveIdentifier}

### Description
Executes a currency conversion at the rate reserved by a prior call to the rate reservation endpoint. The conversion is debited from the source currency balance and credited to the target currency balance of the specified wallet.

### Method
POST

### Endpoint
/v2/fx/execute/{reserveIdentifier}

### Parameters
#### Header Parameters
- **token** (string) - Required - JWT Bearer token. Format: `Bearer YOUR_JWT_TOKEN`.
- **Content-Type** (string) - Required - Must be application/json.
- **Idempotency-Key** (string) - Required - A unique value generated by your system for this execution request.

#### Path Parameters
- **reserveIdentifier** (string) - Required - The reservation identifier returned by GET /v2/fx/rate/reserve/....

#### Request Body
- **walletIdentifier** (integer) - Required - The wallet against which the conversion will be executed.

### Request Example
```json
{
  "walletIdentifier": 1234
}
```

### Response
#### Success Response (200)
- **data** (object) - Currency conversion execution details.
- **errors** (array) - Array of error objects. Empty on success.

#### Response Example
```json
{
  "data": {
    "identifier": 98765,
    "fromAmount": "500.00",
    "fromCurrency": "EUR",
    "toAmount": "541.05",
    "toCurrency": "USD",
    "rate": "1.0821",
    "operationType": 4
  },
  "errors": []
}
```
```

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

### POST /fx/execute

Source: https://docs.paydo.com/merchant-account-new/payment-lifecycle

Executes a currency conversion.

```APIDOC
## POST /fx/execute

### Description
Performs a currency conversion based on a previously reserved rate.

### Method
POST
```

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

### GET /balance

Source: https://docs.paydo.com/jwt-bank-balance

Retrieves the current balance for the account.

```APIDOC
## GET /balance

### Description
Retrieves the current balance information for the authenticated account.

### Method
GET

### Endpoint
/balance
```

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

### GET /v1/refunds/filters

Source: https://docs.paydo.com/merchant-account-new/invoice-api/get-invoice

Retrieves a list of refunds based on filters.

```APIDOC
## GET /v1/refunds/filters

### Description
Retrieves a list of refunds based on applied filters.

### Method
GET

### Endpoint
/v1/refunds/filters
```

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

### GET /v2/fx/rate/reserve/{fromCurrency}/{toCurrency}/wallets/{walletIdentifier}

Source: https://docs.paydo.com/merchant-account-new/merchant-balance-management/currency-conversion-fx/execute-fx-conversion

Requests a real-time rate quote for a currency pair and reserves it for execution.

```APIDOC
## GET /v2/fx/rate/reserve/{fromCurrency}/{toCurrency}/wallets/{walletIdentifier}

### Description
Requests a real-time rate quote for a currency pair and reserves it for execution. The reserved rate is guaranteed for approximately 25 seconds.

### Method
GET

### Endpoint
/v2/fx/rate/reserve/{fromCurrency}/{toCurrency}/wallets/{walletIdentifier}

### Parameters
#### Path Parameters
- **fromCurrency** (string) - Required - ISO 4217 code of the currency to sell.
- **toCurrency** (string) - Required - ISO 4217 code of the currency to buy.
- **walletIdentifier** (integer) - Required - The wallet from which funds will be converted.

#### Query Parameters
- **fromAmount** (string) - Optional - The exact amount to sell in fromCurrency. Either fromAmount or toAmount must be provided.
- **toAmount** (string) - Optional - The exact amount to receive in toCurrency. Either fromAmount or toAmount must be provided.

### Response
#### Success Response (200)
- **data** (object) - Rate reservation details including rate, buy/sell amounts, and reservation identifier.
- **errors** (array) - Array of error objects.

#### Response Example
{
  "data": {
    "rate": "1.0821",
    "buy": {
      "amount": "541.05",
      "currency": "USD"
    },
    "sell": {
      "amount": "500.00",
      "currency": "EUR"
    },
    "reserve": {
      "identifier": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
      "expireAt": 1711756800,
      "expireAtISO8601": "2024-03-29T20:00:00+00:00"
    }
  },
  "errors": []
}
```

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

### GET /v1/refunds/filters

Source: https://docs.paydo.com/merchant-account-new/authentication-token-creation

Retrieves available filters for querying refunds.

```APIDOC
## GET /v1/refunds/filters

### Description
Retrieves the available filters that can be used when querying refund records.

### Method
GET

### Endpoint
/v1/refunds/filters
```
Tokens:
Raw