Cashramp
  • Introduction
    • Getting Started
    • API Endpoints
    • Authentication
    • Webhooks
    • Integration Guide
    • SDKs
  • Hosted payments
    • Deposits
    • Withdrawals
    • Cancel Payment
  • Onchain Payments
    • On-Off Ramp
  • Cashramp API
    • Queries
    • Customers
    • Payment Methods
    • Withdraw Onchain
Powered by GitBook
On this page
  1. Hosted payments

Cancel Payment

To cancel a previously initiated hosted payment, you should use the cancelHostedPayment mutation.

cancelHostedPayment.gql
mutation {
    cancelHostedPayment(paymentRequest: "VHlwZXM6OkNhc2hyYW1wOjpBUEk6Ok1lcmNoYW50UGF5bWVudFJlcXVlc3QtMTFlZDhkZjUtZDI4Ni00MTI3LWJjZjktMTA3NTFkZTYxN2I4")
}
  • paymentRequest: The global ID of the payment request you want to cancel.

Only payment requests with a status of created can be cancelled. Processed payments with the status of picked_up, completed or canceled cannot be cancelled with this mutation.

PreviousWithdrawalsNextOn-Off Ramp

Last updated 1 year ago