Sign in

v3

latestOpenAPI 3.0.3UNLICENSED2026-07-2796235396.3 KB
transactions-onramp
transactions-onboardapi

Customer cancels onramp transaction

post/transactions/onramp/customer-cancel

Request body

customerIdstring uuid required
transactionIdstring uuid required
txHashstring

Deposit transaction hash for deposit related transaction

permitSignaturestring

Permit data signature for permit related approval

flagstring
paymentReceiptUploadIdstring

Upload ID for receipt uploaded on storage bucket

Response

Success

idstring uuid required
referencestring required
customerIdstring uuid required
customerNamestring
escrowAddressstring

Escrow address

paymentChannelIdstring
paymentMethodobject
buyerPaymentMethodobject
tokenAddressstring
status'INITIATED' | 'DEPOSITED' | 'CONFIRMED' | 'COMPLETED' | 'PENDING' | 'CANCELLED' | 'IN_DISPUTE' | 'AWAITING_ACCEPTANCE' required

Order transaction status

createdAtstring date-time
initiatedAtstring date-time
depositedAtstring date-time
confirmedAtstring date-time
completedAtstring date-time
cancelledAtstring date-time
cancellationReasonstring
disputeIdstring
lockHashstring
confirmationHashstring
cancellationHashstring
isPartnerAcknowledgedboolean
defaultingParty'CUSTOMER' | 'PARTNER'

Type of user/role of user in transaction

ratingnumber
isCexOrderboolean
instantPayProcessingStatus'PENDING_IP_REPORT' | 'IN_PROGRESS' | 'FAILURE' | 'SUCCESS'
tradeValuenumber

Actual token amount that is to be traded

merchantTokenValuenumber

Actual token value that is to be traded by merchant less any fees

customerTokenValuenumber

Actual token value that is to be traded by customer less any fees

payableAmountnumber

Actual fiat amount that is to be paid.

isNoKycboolean

Flag showing if order is a no kyc order

paymentReceiptUploadIdstring

Upload ID for receipt uploaded on storage bucket

suppressCustomerNotificationsboolean

Flag to indicate if notifications should be sent to the customer or not during the lifetime of this transaction

chatUnavailableboolean

Flag to indicate if chat is unavailable for this transaction

tradeContext'STANDARD_TRADE' | 'INTERNAL_RAIL'

Example response

{
  "reference": "0165359005113074501885",
  "customerName": "John Doe",
  "offer": {
    "rate": 0.32,
    "networkId": "TRC20",
    "fiatSymbol": "NGN",
    "fiatAmount": 120.5,
    "token": "USDT",
    "tokenAmount": 120.5,
    "usdAmount": 120.5,
    "partnerDisplayName": "John Doe",
    "adNote": "Guaranteed fast payment"
  },
  "paymentChannelId": "BANK_TRANSFER_NIGERIA",
  "customerWallet": {
    "networkId": "bsc_testnet",
    "walletName": "My Trust Wallet"
  },
  "rating": 3,
  "fee": {
    "asToken": "1000.0"
  }
}