Sign in

v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB
Payments

Payments - Update Metadata

post/payments/{payment_id}/update_metadata

Path parameters

payment_idstring required

The identifier for payment

Request body

metadataobject required

Metadata is useful for storing additional, unstructured information on an object.

Example request

{
  "feature_metadata": {
    "apple_pay_recurring_details": {
      "regular_billing": {
        "recurring_payment_start_date": "2023-09-10T23:59:59Z",
        "recurring_payment_end_date": "2023-09-10T23:59:59Z"
      },
      "management_url": "https://hyperswitch.io"
    },
    "pix_additional_details": {
      "scheduled": {
        "date": "2026-07-08",
        "validity_after_expiration": 10
      }
    },
    "boleto_additional_details": {
      "due_date": "2026-12-31",
      "covenant_code": "3568253",
      "discount_rules": {
        "tiers": [
          {
            "amount": "5.50",
            "end_date": "2027-12-31"
          }
        ]
      },
      "penalties": {
        "fixed_penalty": {
          "value": "2.00",
          "grace_period_days": 1
        },
        "interest": {
          "interest_percentage": "5.00",
          "iof_percentage": "32.45325"
        }
      },
      "collection_actions": {
        "legal_protest": {
          "days_after_due_date": 30
        },
        "auto_write_off_days": 60
      },
      "payment_constraints": {
        "details": {
          "min_value": "38.02",
          "max_value": "38.02"
        }
      },
      "beneficiary": {
        "name": "João da Silva",
        "document_number": "9615865832"
      }
    },
    "pix_automatico_additional_details": {
      "time": 3600,
      "retry_policy": true,
      "mandate_details": {
        "fixed_recurring_amount": 6540,
        "min_recurring_amount": 6540,
        "start_date": "2026-12-31",
        "end_date": "2026-12-31"
      }
    },
    "finix_additional_details": {
      "fraud_session_id": "1234567890abcdef"
    }
  }
}

Response

Metadata updated successfully

payment_idstring required

The identifier for the payment

metadataobject nullable

Metadata is useful for storing additional, unstructured information on an object.

status'succeeded' | 'failed' | 'cancelled' | 'cancelled_post_capture' | 'processing' | 'requires_customer_action' | 'requires_merchant_action' | 'requires_payment_method' | 'requires_confirmation' | 'requires_capture' | 'partially_captured' | 'partially_captured_and_capturable' | 'partially_authorized_and_requires_capture' | 'partially_captured_and_processing' | 'conflicted' | 'expired' | 'review'

Represents the overall status of a payment intent. The status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).

Example response

{
  "feature_metadata": {
    "apple_pay_recurring_details": {
      "regular_billing": {
        "recurring_payment_start_date": "2023-09-10T23:59:59Z",
        "recurring_payment_end_date": "2023-09-10T23:59:59Z"
      },
      "management_url": "https://hyperswitch.io"
    },
    "pix_additional_details": {
      "scheduled": {
        "date": "2026-07-08",
        "validity_after_expiration": 10
      }
    },
    "boleto_additional_details": {
      "due_date": "2026-12-31",
      "covenant_code": "3568253",
      "discount_rules": {
        "tiers": [
          {
            "amount": "5.50",
            "end_date": "2027-12-31"
          }
        ]
      },
      "penalties": {
        "fixed_penalty": {
          "value": "2.00",
          "grace_period_days": 1
        },
        "interest": {
          "interest_percentage": "5.00",
          "iof_percentage": "32.45325"
        }
      },
      "collection_actions": {
        "legal_protest": {
          "days_after_due_date": 30
        },
        "auto_write_off_days": 60
      },
      "payment_constraints": {
        "details": {
          "min_value": "38.02",
          "max_value": "38.02"
        }
      },
      "beneficiary": {
        "name": "João da Silva",
        "document_number": "9615865832"
      }
    },
    "pix_automatico_additional_details": {
      "time": 3600,
      "retry_policy": true,
      "mandate_details": {
        "fixed_recurring_amount": 6540,
        "min_recurring_amount": 6540,
        "start_date": "2026-12-31",
        "end_date": "2026-12-31"
      }
    },
    "finix_additional_details": {
      "fraud_session_id": "1234567890abcdef"
    }
  }
}