Docs
English
English
  • SimpleFi
    • On-site payments
    • Online payments
    • Available tokens
  • Merchant management
    • Authentication
    • Merchant settings
    • Payment requests
    • Status notifications
    • Static QR
  • API Reference
    • Authentication
    • Errors
    • Creating a payment request
    • Querying the status of a payment
    • Canceling a payment request
    • Refunding a payment
    • Notification Webhook
    • Linking Business to Network
  • Implementation details by method
    • Checkout Redirect
    • Dynamic QR
Powered by GitBook
On this page
  1. API Reference

Canceling a payment request

PreviousQuerying the status of a paymentNextRefunding a payment

Last updated 7 months ago

To cancel a payment request

Cancel Payment Request

put
Authorizations
Path parameters
payment_request_idanyRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
put
PUT /payment_requests/{payment_request_id}/cancel HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "id": "text",
  "order_id": 1,
  "ars_amount": 1,
  "ars_paid": 1,
  "amount": 1,
  "amount_paid": 1,
  "currency": "ARS",
  "items": [
    {
      "id": "text",
      "quantity": 1,
      "name": "text",
      "price": 1,
      "currency": "ARS"
    }
  ],
  "usd_amount": 1,
  "reference": {},
  "memo": "text",
  "notification_url": "text",
  "status": "pending",
  "status_detail": "not_paid",
  "approved_at": "2025-06-17T09:24:14.457Z",
  "expiration_time": "2025-06-17T09:24:14.457Z",
  "delivered": true,
  "transactions": [
    {
      "id": "text",
      "price_details": {
        "currency": "ARS",
        "currency_amount": 1,
        "currency_final_amount": 1,
        "base_amount": 1,
        "final_amount": 1,
        "paid_amount": 1,
        "discount_rate": 1,
        "rate": 1
      },
      "coin": "BTC",
      "chain_id": 1,
      "address": "text",
      "status": "not_paid",
      "payment_request_id": "text",
      "memo": "text",
      "additional_info": {},
      "payments": [
        {
          "hash": "text",
          "from": "text",
          "chain_id": 1,
          "block": 1,
          "amount": 1,
          "paid_by": "text",
          "paid_at": "2025-06-17T09:24:14.457Z",
          "linked_at": "2025-06-17T09:24:14.457Z"
        }
      ],
      "date_created": "2025-06-17T09:24:14.457Z",
      "last_modified": "2025-06-17T09:24:14.457Z"
    }
  ],
  "card_payment": {
    "provider": "stripe",
    "session_url": "text",
    "price_details": {
      "currency": "ARS",
      "amount": 1,
      "final_amount": 1,
      "usd_final_amount": 1,
      "paid_amount": 1,
      "discount_rate": 1,
      "rate": 1
    },
    "status": "not_paid",
    "date_created": "2025-06-17T09:24:14.457Z",
    "last_modified": "2025-06-17T09:24:14.457Z"
  },
  "payments": [
    {
      "hash": "text",
      "from": "text",
      "chain_id": 1,
      "block": 1,
      "amount": 1,
      "paid_by": "text",
      "paid_at": "2025-06-17T09:24:14.457Z",
      "linked_at": "2025-06-17T09:24:14.457Z",
      "coin": "BTC"
    }
  ],
  "merchant_id": "text",
  "date_created": "2025-06-17T09:24:14.457Z",
  "last_modified": "2025-06-17T09:24:14.457Z",
  "checkout_url": "text",
  "conflict": true
}