Cancel a payment

Cancels a pending payment. A payment that has already succeeded or failed can’t be canceled.

POST/payments/{paymentId}/cancel

Authorization

AuthorizationBearer token · headerrequired

Your Apipay secret API key.

Path parameters

paymentIdstringrequired

Responses

200

The canceled payment.

idstringrequired

amountintegerrequired

Amount in the smallest unit of the currency (e.g. Rupiah has no sub-unit, so this is whole Rupiah).

currencystringrequired

methodPaymentMethodrequired

Allowed:qrisvirtual_accountcardewallet

statusPaymentStatusrequired

Allowed:pendingsucceededfailedcanceled

customer_idstring | null

descriptionstring | null

created_atstring<date-time>required

401

The API key is missing, invalid, or revoked.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

404

No resource exists with that identifier.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

409

The payment can't be canceled from its current status.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

paymentIdpath*

Request

curl -X POST 'https://api.apipay.id/v1/payments/pay_6b2f9d4e/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.apipay.id/v1/payments/pay_6b2f9d4e/cancel", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.post(
    "https://api.apipay.id/v1/payments/pay_6b2f9d4e/cancel",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "id": "pay_6b2f9d4e",
  "amount": 150000,
  "currency": "IDR",
  "method": "qris",
  "status": "pending",
  "customer_id": "cus_8f3a2b1c",
  "description": "Order",
  "created_at": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "amount must be a positive integer"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "amount must be a positive integer"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "amount must be a positive integer"
  }
}