Skip to main content

Create void

Create a Void for an eligible successful transaction before capture or settlement. Void cancels the full authorization and is separate from Refund; it never creates or automatically falls back to a refund. Unsupported payment services return CHANNEL_VOID_NOT_SUPPORTED.

POSThttps://api.efundpay.com/v4/transactions/{transaction_id}/voids
This endpoint requires the transactions.write scope.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form `Bearer <token>`.

Headers

x-merchant-account-idstringrequired

Merchant account that owns the original transaction.

Examples:""default""

Path Parameters

transaction_idstringrequired

EFundPay identifier of the original successful transaction.

Examples:"7099948d-7286-47e4-aad8-b68f7eb44591"

Body

application/json
external_identifierstringrequired

Merchant-generated unique identifier for this Void. Reuse it only for an exact retry.

Length:1 - 64
Examples:"void-20260827-001"
reasonstring

Reason for canceling the authorization.

Length:0 - 256
Examples:"Customer canceled before settlement"

Response

application/json

Successful Response

typestringrequired

Resource type.

Examples:"void"
transaction_idstringrequired

EFundPay identifier of the original transaction.

external_identifierstringrequired

Merchant Void identifier supplied in the request.

transaction_external_identifierstringrequired

Merchant external identifier of the original transaction.

channel_codestringrequired

Original payment service channel code.

statusstringrequired

Void status. Processing means the payment service accepted the request asynchronously; succeeded is terminal.

Examples:"processing""succeeded"
curl --request POST \
--url https://api.efundpay.com/v4/transactions/7099948d-7286-47e4-aad8-b68f7eb44591/voids \
--header 'Authorization: Bearer <token>' \
--header 'x-merchant-account-id: <x-merchant-account-id>' \
--header 'Content-Type: application/json' \
--data '{
"external_identifier": "void-20260827-001",
"reason": "Customer canceled before settlement"
}'
{
"type": "void",
"transaction_id": "7099948d-7286-47e4-aad8-b68f7eb44591",
"external_identifier": "void-20260827-001",
"transaction_external_identifier": "payment-12345",
"channel_code": "Adyen-icr",
"status": "processing"
}
Powered by Docusaurus