Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
External Cards

Create External Card Transfer Reversal

Create an External Card Transfer Reversal

post/external_cards/transfers/{transfer_id}/reversals

Path parameters

transfer_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The unique identifier of a transfer

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

amountinteger required

Amount of the refund in cents (Amount can be up to the original amount)

currencystring required

ISO 4217 Alpha-3 currency code

Example request

{
  "currency": "USD"
}

Response

External Card Transfer Reversal created

OR

Example response

{
  "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "country_code": "US",
  "created_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "external_card_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_modified_time": "2010-05-06T12:23:34.321Z",
  "merchant": {
    "address": {
      "address_line_1": "100 Main St.",
      "address_line_2": "Suite 99",
      "city": "New York",
      "country_code": "US",
      "postal_code": "49633",
      "state": "NY"
    },
    "email": "alice@example.com",
    "phone_number": "+14374570680"
  },
  "type": "PULL",
  "three_ds_id": "40e2de9e-4375-4fa1-9393-92da972a9338"
}