Cancel pending payment

📘
API Refs

Production: Cancel pending payment

Staging: Cancel pending payment

URI Parameters

Name	Type	Description	Required
paymentId	string	Pending payment id	yes

Example

Get list of insured’s pending payments Request with userId = 1;

Get list of insured’s pending payments Response:

[
  {
    "id": 1,
    "transactionId": "a444aa44-aaa4-4a4a-aaaa-a44a44444a44",
    "amount": 10.23,
    "createdAt": "2023-08-09T15:42:26.683Z",
    "customerId": 1,
    "customerName": "John Smith",
    "merchantName": "Jake Merchant",
    "fee": "0.00",
    "feeDeductFrom": null,
    "status": "Awaiting-cash-out",
    "type": "--",
    "memo": ""
  }
]

Cancel pending payment Request with paymentId = 1;
Get list of insured’s pending payments Request with userId = 1;

Get list of insured’s pending payments Response:

[
  {
    "id": 1,
    "transactionId": "a444aa44-aaa4-4a4a-aaaa-a44a44444a44",
    "amount": 10.23,
    "createdAt": "2023-08-09T15:42:26.683Z",
    "customerId": 1,
    "customerName": "John Smith",
    "merchantName": "Jake Merchant",
    "fee": "0.00",
    "feeDeductFrom": null,
    "status": "Canceled",
    "type": "--",
    "memo": ""
  }
]

Description

❗️
You can cancel only those transactions that are in the Awaiting-cash-out status.

📘
Where to get payment id?
You can get all existing payments for yourself or your insured. Go to Get list of self payments for more information about your payments, or go to Get list of insured’s pending payments.

If a pending payment you sent was to the wrong address, or if the payment is no longer relevant, you can cancel it.
If you cancel a pending payment, you will have the option to retry it.
Canceled payment status is canceled.