Void payment

curl --request POST \
  --url https://app.tagadapay.com/api/public/v1/payments/void \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentId": "pay_123xyz"
}
'

{
  "id": "pay_123xyz",
  "status": "failed",
  "subStatus": "voided",
  "amount": 2999,
  "currency": "USD",
  "voidedAt": "2024-03-20T10:30:00Z"
}

payments

Void payment

Void an authorized payment transaction. This cancels a previously authorized payment before it has been captured.

Important notes:

Only works for payments with ‘authorized’ status
Must be performed before the payment is captured
Once voided, the authorization is released and funds are no longer held
Cannot be undone once voided

Common error codes:

PAYMENT_NOT_FOUND: The specified payment does not exist
TRANSACTION_NOT_AUTHORIZE: The payment is not in authorized status
TRANSACTION_NO_PROCESSOR: No processor found for the transaction
TRANSACTION_VOID_FAILED: The void operation failed at the processor level

POST

api

public

payments

void

Void payment

curl --request POST \
  --url https://app.tagadapay.com/api/public/v1/payments/void \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentId": "pay_123xyz"
}
'

{
  "id": "pay_123xyz",
  "status": "failed",
  "subStatus": "voided",
  "amount": 2999,
  "currency": "USD",
  "voidedAt": "2024-03-20T10:30:00Z"
}

Authorizations

Authorization

string

header

required

Enter your API key as: Bearer your-api-key

Body

application/json

paymentId

string

required

Response

Successful response

Process payment List block rules

⌘I

API documentation

API endpoints

Void payment

Authorizations

Body

Response