Sign in

v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-011518127.5 KB

Create a refund for a transaction.

post/business/{business}/payments/{transaction_reference}/refunds

Path parameters

businessstring required

The unique identifier of the business.

transaction_referencestring required

The unique reference of the transaction to be refunded.

Request body

amountnumber float required

The monetary value to be refunded.

Example request

{
  "amount": 10.5
}

Response

Refund processed successfully

idinteger

The unique identifier of the refund transaction.

providerstring

The payment service provider for the transaction.

countrystring

The country associated with the refund.

currency_codestring

The currency code used for the transaction.

createdstring date-time

The timestamp when the refund was created.

modifiedstring date-time

The timestamp when the refund was last modified.

operation_datestring date-time

The date and time when the refund operation was performed.

transaction_referencestring

The reference identifier of the original transaction.

transaction_typestring

The type of transaction (e.g., REFUND).

statusstring

The status of the transaction.

amountstring

The amount refunded.

related_transaction_referencestring

The reference identifier of the related transaction.

reasonstring nullable

The reason for the refund, if provided.

is_refundedboolean nullable

Indicates if the transaction has been refunded.

is_disputedboolean nullable

Indicates if the transaction is disputed.

number_of_payment_attemptsinteger nullable

The number of payment attempts made for the transaction.

payment_method_oldstring nullable

The previous payment method, if applicable.

is_card_internationalboolean

Indicates if the card used is international.

card_brandstring nullable

The brand of the card used.

number_of_installmentsinteger

The number of installments for the transaction.

incoming_requeststring nullable

Details of the incoming request, if any.

metadatastring nullable

Additional metadata associated with the transaction.

tonder_intra_transaction_ratenumber float nullable

The intra-transaction rate for Tonder.

tonder_inter_transaction_ratenumber float nullable

The inter-transaction rate for Tonder.

tonder_transaction_feenumber float nullable

The transaction fee charged by Tonder.

is_fees_computedboolean

Indicates if the fees have been computed.

fee_amountnumber float nullable

The fee amount charged.

net_amountnumber float nullable

The net amount after fees.

rolling_reserve_amountnumber float nullable

The rolling reserve amount, if any.

has_balance_transactionboolean

Indicates if there is a balance transaction.

payment_methodstring nullable

The payment method used.

issuing_countrystring nullable

The issuing country of the payment method.

Example response

[
  {
    "id": 17,
    "provider": "tonder",
    "country": "N/A",
    "currency_code": "MXN",
    "created": "2024-06-28T08:15:24.600617-05:00",
    "modified": "2024-06-28T08:15:24.600654-05:00",
    "operation_date": "2024-06-28T13:15:23-05:00",
    "transaction_reference": "16566015",
    "response": {
      "card_account": {
        "issuing_country_code": "IL",
        "masked_pan": "458000...0059"
      },
      "customer": {
        "email": "test@email.com"
      },
      "payment_data": {
        "id": "16563893",
        "remaining_amount": 40
      },
      "refund_data": {
        "amount": 5,
        "auth_code": "gUuMXr",
        "created": "2024-06-28T13:15:23Z",
        "currency": "MXN",
        "id": "16566015",
        "status": "COMPLETED"
      },
      "payment_method": "BANKCARD",
      "merchant_order": {
        "description": "Requested by the client",
        "id": "TNDR-76b9de76-eeee-42e9-b4bf-255943831ee9"
      }
    },
    "transaction_type": "REFUND",
    "status": "Success",
    "amount": "5.0000",
    "related_transaction_reference": "16563893",
    "number_of_installments": 1,
    "business": {
      "id": 97,
      "created": "2024-02-13T13:34:54.796510-06:00",
      "modified": "2024-06-26T19:12:49.988659-05:00",
      "name": "Demo 7",
      "web": "www.google.com",
      "logo": "https://zplit-stage.s3.amazonaws.com/media/business_logos/Web_1920__13dsjcejd2x.png",
      "checkout_logo": "https://zplit-stage.s3.amazonaws.com/media/business_checkout_logos/Web_1920__13dsjcejd2x.png",
      "background_color": "#f2f2f2",
      "primary_color": "#1c202b",
      "textCheckoutColor": "#ffffff",
      "textDetailsColor": "#1c202b",
      "total_annual_sales": "L",
      "average_order_sale": "0.00",
      "comission": "5.00",
      "status": "A",
      "first_time_filled": true,
      "enabled_smart_routing": true,
      "enabled_finances": true,
      "risk_level": "Low",
      "timezone": "America/Mexico_City",
      "enabled_orchestration": true,
      "user": 792,
      "country": 1,
      "currency": 5,
      "categories": [
        1
      ]
    },
    "payment": {
      "id": 24943,
      "created": "2024-06-27T18:43:37.519849-05:00",
      "modified": "2024-06-27T18:43:38.523950-05:00",
      "amount": "45.0000",
      "status": "PENDING",
      "date": "2024-06-27T18:43:37.519966-05:00",
      "customer_order_reference": "TNDR-76b9de76-eeee-42e9-b4bf-255943831ee9",
      "client": 846,
      "business": 97,
      "order": 28579
    },
    "currency": {
      "id": 5,
      "name": "Mexican Peso",
      "code": "MXN",
      "symbol": "$"
    }
  }
]