Refresh Off-Ramp Session

Extend an expired or expiring off-ramp session.

Refreshes an off-ramp transaction session, extending the expiry time so the user has more time to send crypto.

Endpoint

GET /v1/offramp/refresh/:reference

Authentication

Header
Value

x-api-key

Your API key

Path parameters

Parameter
Type
Description

reference

string

Your unique transaction reference

Example request

curl -X GET https://ramp-api.ivorypay.io/api/v1/offramp/refresh/660e8400-e29b-41d4-a716-446655440001 \
  -H "x-api-key: your_api_key"

Example response

{
  "statusCode": 200,
  "success": true,
  "message": "Session refreshed",
  "data": {
    "reference": "660e8400-e29b-41d4-a716-446655440001",
    "status": "PENDING",
    "address": "0xIvoryPayDepositAddress...",
    "chain": "BSC_MAINNET",
    "token": "USDT",
    "amount": 62.5,
    "expiresAt": "2026-03-26T14:00:00.000Z",
    "sessionId": "session_refreshed_abc",
    "duration": 3600
  }
}
circle-info

The crypto amount may be recalculated based on current exchange rates when the session is refreshed.

Last updated