Sign in

v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Cancel or Refund a Payment with transaction

post/payments/{payment_id}/transactions/{transaction_id}/cancel-or-refund

Path parameters

payment_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 cancellation or refund. (MAX 255; MIN 3).

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

Indicating the reason for the cancellation or 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

Identification of the payment transaction defined by the merchant. If no merchant_reference is defined, the merchant_order_id of the payment will be associated to the transaction. (MAX 255; MIN 3).

simplified_modeboolean

Indicates if we should try to refund a payment after an error/declined on the first try. It is false by default. For more information, access the guide.

Example request

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

Response

201

OR
OR

Example response

{
  "id": "7fd485f3-bd72-45eb-a3fb-774daa3d79b6",
  "type": "REFUND",
  "status": "REFUNDED",
  "category": "CARD",
  "amount": {
    "currency": "COP",
    "value": 30000
  },
  "merchant_reference": "0000023",
  "created_at": "2024-06-06T14:06:06.284443Z",
  "updated_at": "2024-06-06T14:06:37.984065Z",
  "provider_data": {
    "id": "YUNO_TEST_PAYMENT_GW",
    "account_id": "493e9374-510a-4201-9e09-de669d75f256",
    "response_code": "SUCCEEDED",
    "iso8583_response_code": "00",
    "iso8583_response_message": "Approved or completed successfully"
  },
  "response_code": "SUCCEEDED",
  "response_message": "Transaction successful",
  "payment": {
    "id": "c3583c27-0478-4e02-8827-4d8f2121c670",
    "description": "Test",
    "country": "CO",
    "status": "REFUNDED",
    "sub_status": "REFUNDED",
    "merchant_order_id": "0000023",
    "created_at": "2024-06-06T14:06:06.284443Z",
    "updated_at": "2024-06-06T14:06:06.284443Z",
    "amount": {
      "currency": "COP",
      "refunded": 30000,
      "value": 30000
    },
    "additional_data": {
      "airline": {
        "pnr": "1P-2UUGJW",
        "legs": [
          {
            "departure_airport": "EZE",
            "departure_datetime": "2014-05-12 13:05:00",
            "departure_airport_timezone": "-03:00",
            "arrival_airport": "AMS",
            "arrival_airport_timezone": "+00:00",
            "carrier_code": "KL",
            "flight_number": "842",
            "fare_basis_code": "HL7LNR",
            "fare_class_code": "FR",
            "base_fare": 200,
            "base_fare_currency": "BRL",
            "stopover_code": "s"
          }
        ],
        "passengers": [
          {
            "first_name": "string",
            "last_name": "string",
            "middle_name": "string",
            "type": "s",
            "date_of_birth": "stringstri",
            "nationality": "st",
            "document": {
              "document_type": "CPF",
              "document_number": "351.040.753-97"
            },
            "country": "st",
            "loyalty_number": "string",
            "loyalty_tier": "strin"
          }
        ],
        "tickets": [
          {
            "ticket_number": "123456",
            "total_fare_amount": 80,
            "total_tax_amount": 22,
            "total_fee_amount": 14
          }
        ]
      },
      "order": {
        "fee_amount": 100,
        "shipping_amount": 100,
        "items": [
          {
            "id": "123AD",
            "name": "Skirt",
            "quantity": 1,
            "unit_amount": 29800,
            "category": "Clothes",
            "brand": "XYZ",
            "sku_code": "8765432109",
            "manufacture_part_number": "XYZ123456"
          }
        ]
      }
    }
  }
}