VOvopay
Digital Wallet Endpoints

apple-pay/refund

This endpoint allows you to refund a settled Apple Pay transaction, in full or in part. A transaction whose funds are still on hold has not settled yet and must be voided instead.

post/apple-pay/refund

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/apple-pay/refund
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionIDinteger required

The unique ID for the Apple Pay transaction you want to refund

Amountstring

The amount to refund. Defaults to the full amount of the original transaction, and cannot exceed it

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

TransactionIDinteger required

The unique ID for the refund transaction

Example response

{
  "Success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.