Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

Card Present Referenced Refund

Below are the different scenarios that outline whether a user needs to swipe their card for a refund.

No swipe needed: Included in the open batch or not, the payment type was credit, and the transaction is within 45 days.

No swipe needed: If the payment type was debit and the transaction is in the current open batch.

Swipe needed: If the payment type is debit and the transaction is no longer in the batch.

Swipe needed: If the payment type is credit and the transaction is no longer in the batch and older than 45 days.

attention

This API is available for Finix Core customers only. If you have additional questions, contact Support.

Copy

Copied

curl https://finix.sandbox-payments-api.com/transfers/TRn9pzzn1NVLdwwBwVrqSwAX/reversals \
    -H "Content-Type: application/json" \
    -H 'Finix-Version: 2022-02-01' \
    -u  USjHFGYvecE4LBitYG8KDE2g:b698f403-d9b7-4157-82d8-162cea8c8cc3 \
    -d  '
        {
          "device": "DVtk6E4eWHsMzgZXvFaaUigM",
          "refund_amount" : 150
        }'

HTTP Request

POST https://finix.sandbox-payments-api.com/transfers/:TRANSFER_ID/reversals

URL Parameters

Field	Type	Description
:TRANSFER_ID	string, required	ID of the original Transfer

Request Arguments

Field	Type	Description
`device`	string, required	The ID of the activated device
`refund_amount`	integer, required	The amount of the refund in cents (Must be equal to or less than the amount of the original `Transfer`)

Copy

Copied

{
  "id" : "TRpc9StVytskqYnWoF2Ho8pK",
  "created_at" : "2022-10-10T03:17:34.57Z",
  "updated_at" : "2022-10-10T03:17:35.83Z",
  "additional_buyer_charges" : null,
  "additional_healthcare_data" : null,
  "address_verification" : null,
  "amount" : 150,
  "amount_requested" : 150,
  "application" : "APeUbTUjvYb1CdPXvNcwW1wP",
  "card_present_details" : {
    "emv_data" : null,
    "masked_account_number" : null,
    "name" : null,
    "brand" : null,
    "entry_mode" : null,
    "payment_type" : "NONE",
    "approval_code" : null
  },
  "currency" : "USD",
  "destination" : "PInUwPXf1MYj7xJ8jfmdksa5",
  "device" : "DVtk6E4eWHsMzgZXvFaaUigM",
  "externally_funded" : "UNKNOWN",
  "failure_code" : null,
  "failure_message" : null,
  "fee" : 0,
  "idempotency_id" : null,
  "merchant_identity" : "IDsbTBawhnLBAVeinRb84vFR",
  "messages" : null,
  "raw" : null,
  "ready_to_settle_at" : null,
  "security_code_verification" : null,
  "source" : null,
  "state" : "SUCCEEDED",
  "statement_descriptor" : "FIN*FLOWERS",
  "subtype" : "API",
  "tags" : { },
  "trace_id" : "FNXkYuDrPQxzpNk5xtGhXSyU8",
  "type" : "REVERSAL",
  "_links" : {
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APeUbTUjvYb1CdPXvNcwW1wP"
    },
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRpc9StVytskqYnWoF2Ho8pK"
    },
    "parent" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRn9pzzn1NVLdwwBwVrqSwAX"
    },
    "destination" : {
      "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PInUwPXf1MYj7xJ8jfmdksa5"
    },
    "merchant_identity" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDsbTBawhnLBAVeinRb84vFR"
    },
    "payment_instruments" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRpc9StVytskqYnWoF2Ho8pK/payment_instruments"
    },
    "fee_profile" : {
      "href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPrATYzpomaTRtdo2BssRoGx"
    }
  }
}