Sign in

v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Refund Payment

post/payments/{id}/transactions/{transaction_id}/refund

Path parameters

idstring required

The unique identifier of the payment (UUID, 36 chars).

transaction_idstring required

The unique identifier of the transaction (UUID, 36 chars).

Request body

descriptionstring

Description of the refund. (MAX 255; MIN 3).

reason'DUPLICATE' | 'FRAUDULENT' | 'REQUESTED_BY_CUSTOMER' | 'REVERSE'

Indicating the reason for the refund. If set, possible values are DUPLICATE, FRAUDULENT, REQUESTED_BY_CUSTOMER, and REVERSE. Use REVERSE to request an automatic reverse of the recipient funds when a recipient is involved in the transaction.

merchant_referencestring required

Identification of the payment transaction defined by the merchant (MAX 255; MIN 3).

simplified_modeboolean

Determines whether Yuno should automatically attempt to refund a payment after an initial error or decline. When set to true, Yuno will retry the process if the first attempt fails. By default, this is set to false. Access Transaction Retries for more details.

Example request

{
  "split_marketplace": [
    {
      "recipient_type": "MEAL"
    }
  ]
}

Response

200

OR

Example response

{
  "id": "f2d6884a-f737-4565-ae32-ff60b19089e3",
  "description": "Duplicate",
  "country": "US",
  "status": "REFUNDED",
  "sub_status": "REFUNDED",
  "merchant_order_id": "AAB01-432245",
  "created_at": "2025-04-14T17:51:45.179645Z",
  "updated_at": "2025-04-14T17:52:07.908698Z",
  "amount": {
    "currency": "USD",
    "refunded": 30000,
    "value": 30000
  },
  "payment_method": {
    "type": "CARD",
    "payment_method_detail": {
      "card": {
        "installments": 1,
        "authorization_code": "216303",
        "card_data": {
          "holder_name": "John Doe",
          "iin": "41111111",
          "lfd": "1111",
          "number_length": 16,
          "security_code_length": 3,
          "brand": "VISA",
          "issuer_name": "CHASE BANK USA",
          "country_code": "US",
          "category": "CLASSIC",
          "type": "DEBIT",
          "fingerprint": "d244e20d-43a1-43f7-9b48-0a76423be35e",
          "expiration_month": 3,
          "expiration_year": 26
        }
      }
    }
  },
  "customer_payer": {
    "merchant_customer_id": "1744653105",
    "first_name": "John",
    "last_name": "Doe",
    "gender": "M",
    "date_of_birth": "1990-02-28",
    "email": "john.doe@example.com",
    "nationality": "US",
    "ip_address": "192.168.1.1",
    "document": {
      "document_type": "SSN",
      "document_number": "123-45-6789"
    },
    "phone": {
      "number": "5551234567",
      "country_code": "1"
    },
    "billing_address": {
      "address_line_1": "1234 Elm Street",
      "address_line_2": "Apt 5B",
      "country": "US",
      "state": "California",
      "city": "Los Angeles",
      "zip_code": "90001"
    },
    "shipping_address": {
      "address_line_1": "1234 Elm Street",
      "address_line_2": "Apt 5B",
      "country": "US",
      "state": "California",
      "city": "Los Angeles",
      "zip_code": "90001"
    }
  },
  "transactions": {
    "id": "5414f862-51e6-433f-a54c-b46b176e87a0",
    "type": "REFUND",
    "status": "SUCCEEDED",
    "category": "CARD",
    "amount": 30000,
    "provider_id": "YUNO_TEST_PAYMENT_GW",
    "payment_method": {
      "type": "CARD",
      "detail": {
        "card": {
          "installments": 1,
          "authorization_code": "216303",
          "card_data": {
            "holder_name": "John Doe",
            "iin": "41111111",
            "lfd": "1111",
            "number_length": 16,
            "security_code_length": 3,
            "brand": "VISA",
            "issuer_name": "CHASE BANK USA",
            "country_code": "US",
            "category": "CLASSIC",
            "type": "DEBIT",
            "fingerprint": "d244e20d-43a1-43f7-9b48-0a76423be35e",
            "expiration_month": 3,
            "expiration_year": 26
          }
        }
      }
    },
    "response_code": "SUCCEEDED",
    "response_message": "Transaction successful",
    "reason": "REQUESTED_BY_CUSTOMER",
    "description": "Test refund",
    "merchant_reference": "REFUND_001",
    "provider_data": {
      "id": "YUNO_TEST_PAYMENT_GW",
      "transaction_id": "2e5c04d5-4cf7-4d2a-b57a-dd5eb9a687bc",
      "response_code": "SUCCEEDED",
      "raw_response": {
        "message": "provider response"
      }
    },
    "created_at": "2025-04-14T17:52:07.768528Z",
    "updated_at": "2025-04-14T17:52:07.862912Z"
  }
}