> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dollarpe.xyz/llms.txt
> Use this file to discover all available pages before exploring further.
# Fetch Rate
> Current payout rate on your prefunded wallet network.
Integrate the Zapyd prefunded payout Fetch Rate endpoint into my application.
Endpoint: GET /pos/api/v1/prefunded/payout/fetch-rate
Base URL: [https://sandbox.zapyd.com](https://sandbox.zapyd.com) (sandbox) | [https://api.zapyd.com](https://api.zapyd.com) (production)
Full URL (sandbox): GET [https://sandbox.zapyd.com/pos/api/v1/prefunded/payout/fetch-rate](https://sandbox.zapyd.com/pos/api/v1/prefunded/payout/fetch-rate)
Auth headers required on every request:
* X-API-KEY: your API key
* X-TIMESTAMP: current Unix time in seconds
* X-SIGNATURE: Base64(HMAC-SHA256(key=apiSecret, data=X-API-KEY + "|" + X-TIMESTAMP + "|" + canonicalBody))
canonicalBody = request JSON with keys sorted at every nesting level, no whitespace (separators "," and ":"), non-ASCII escaped as lowercase \uXXXX. GET requests always sign "{}" (query params are not signed). Send the exact canonicalBody string as the request body. Timestamp must be within 300s of server time.
Task: Write a typed function that:
1. Accepts asset, fiat, payment\_method and, for dynamically priced fiats, exactly one of sending\_amount or receiving\_amount
2. Builds the signed auth headers (GET signs "{}"; query params are not signed)
3. Calls GET /pos/api/v1/prefunded/payout/fetch-rate with query parameters
4. Returns rate, network and fees
5. Handles 400 and 500 errors
Language: TypeScript
Prefunded payouts are available only to organizations with a prefunded wallet. Check your balance with [Fetch Balance](/api-reference-exchange/endpoint/remittance-payout/balance).
## OpenAPI
````yaml GET /pos/api/v1/prefunded/payout/fetch-rate
openapi: 3.1.0
info:
title: Zapyd API
description: API for Zapyd - Customer, Payout, and Webhook services
license:
name: MIT
version: 1.0.0
servers:
- url: https://sandbox.zapyd.com/pos/api/v1
description: Payout API Base URL
variables:
base_url:
default: https://sandbox.zapyd.com
- url: https://sandbox.zapyd.com/cms/api/v1
description: Customer API Base URL
variables:
base_url:
default: https://sandbox.zapyd.com
security:
- ApiKeyAuth: []
TimestampAuth: []
SignatureAuth: []
tags:
- name: Customer
description: Customer related operations
x-displayName: Customer
x-traitTag: true
- name: Payout
description: Payout related operations
- name: Webhooks
description: Webhook related operations
- name: Widget
description: Hosted buy/sell widget session initialization
paths:
/pos/api/v1/prefunded/payout/fetch-rate:
get:
tags:
- Prefunded Payout
description: >-
Current payout rate on your prefunded wallet network. The network is
always your prefunded wallet network; a `network` parameter is ignored.
Available only to organizations with a prefunded wallet; others get
`This endpoint is not available for your organization.`
parameters:
- name: asset
in: query
required: true
description: Crypto asset code, e.g. USDT or USDC
schema:
type: string
example: USDT
- name: fiat
in: query
required: true
description: Fiat currency code, e.g. INR
schema:
type: string
example: INR
- name: payment_method
in: query
required: true
description: Payout payment method, valid for the fiat (see Fetch Configuration)
schema:
type: string
example: IMPS
- name: sending_amount
in: query
required: false
description: >-
Crypto amount to send. For dynamically priced fiats (OwlPay
corridors) send exactly one of sending_amount or receiving_amount;
other fiats ignore both.
schema:
type: string
example: '100'
- name: receiving_amount
in: query
required: false
description: Fiat amount the beneficiary should receive. See sending_amount.
schema:
type: string
example: '8500'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: Success
data:
type: object
properties:
asset:
type: string
example: USDT
fiat:
type: string
example: INR
rate:
type: number
format: decimal
example: 87.2
network:
type: string
description: Network, uppercase.
example: TRON
fees:
type: object
description: >-
Banking fee disclosure per payment method, from the
active provider. Informational only; it is not applied
to `rate`.
additionalProperties:
type: object
properties:
type:
type: string
description: Fee type
example: banking_fee
value:
type: number
example: 0.9
unit:
type: string
description: '`flat` or `percentage`'
example: flat
enum:
- flat
- percentage
example:
wire:
type: banking_fee
value: 0.9
unit: flat
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Bad Request
data:
type: 'null'
err_code:
type: string
example: REQ_FIELD_MISSING
errors:
type: object
additionalProperties:
type: array
items:
type: string
example:
asset:
- This field is required.
amount:
- This field is required.
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Internal Server Error
data:
type: 'null'
err_code:
type: string
example: SYS_INTERNAL_ERROR
errors:
type: string
example: Unexpected error occurred. Please try again later.
servers:
- url: https://sandbox.zapyd.com
description: Payout API Base URL
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
description: API Key for authentication
TimestampAuth:
type: apiKey
in: header
name: X-TIMESTAMP
description: Current timestamp in seconds since epoch
SignatureAuth:
type: apiKey
in: header
name: X-SIGNATURE
description: HMAC SHA256 signature of the request encoded in Base64
````