---
title: "Copy of Declined Payment Calls"
method: POST
path: "/smart-support/external/payments/recover"
tags: ["AI Caller"]
---

# Copy of Declined Payment Calls

`POST /smart-support/external/payments/recover`

## Request

- Base URL: `https://api-sandbox.y.uno/v1`
- URL: `https://api-sandbox.y.uno/v1/smart-support/external/payments/recover`
- Auth: API key in header `PUBLIC-API-KEY` and API key in header `PRIVATE-SECRET-KEY`
- TypeScript: <https://skmtc.dev/y/apis/ai-caller/docs/smart-support/external/payments/recover/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- object
  - `settings` object, required: AI agent configuration
    - `contact_details` object, required: Object with the contact details
      - `channel` 'PHONE_CALL' | 'WHATSAPP_MESSAGE', required: The list of possible contact channels.
      - `initial_template_message` object: Required if `channel = WHATSAPP_MESSAGE`. Initial template message configuration for `WHATSAPP_MESSAGE`.
        - `id` string: Yuno template ID
        - `variables` object: Object with template's variables
      - `pdf_template` object: PDF template configuration for WHATSAPP_MESSAGE.
        - `id` string: Yuno PDF template ID
        - `variables` object: Object with pdf template's variables
      - `payment_methods` object: Available payment methods to offer the customer payer
        - `available` string[], required: The list of available payment methods to be offered to the user as alternatives to complete the payment.
  - `additional_information` object: All relevant information to feed to the AI to improve context.
    - `seller_details` object: Object containing the merchant's contact information to be used if the agent is unable to answer the inquiry.
      - `name` string: The merchant's name, used by the AI to introduce itself.
      - `fallback_instructions` string: Instruction to be provided to the user on how to contact customer support in case the AI cannot solve the issue.
      - `redirection_url` string: URL to redirect the customer for additional support.
    - `payment` object: Declined payment information
      - `account_id` string: The unique identifier of the account.
      - `id` string: The unique identifier of the payment.
      - `merchant_order_id` string: Identification of the Order.
      - `country` string: Country where the payment was processed (ISO 3166-1).
      - `description` string: The description of product or service the user tried to purchase.
      - `created_at` string, date-time: The timestamp of when the payment was made (ISO 8601).
      - `declined_reason` string: The declined reason for the payment provided by the payment provider.
      - `payment_method` object
        - `type` string: The type of payment method selected by the customer.
        - `detail` object
          - `card_data` object
            - `expiration_month` number: Card's expiration month - MM
            - `expiration_year` number: Card's expiration year - YYYY
            - `iin` string: The Institution identification number (IIN) refers to the first few digits of a payment card number issued by a financial institution.
            - `lfd` string: Last four digits of the card.
            - `issuer` string: Card issuer.
            - `type` 'CREDIT' | 'DEBIT' | 'PREPAID': Card's issuer type.
      - `amount` object
        - `value` number: The amount of the payment that was declined.
        - `currency` string: The currency of the payment that was declined (ISO 4217).
      - `customer_payer` object
        - `first_name` string: The customer's first name.
        - `last_name` string: The customer's last name.
        - `phone` object
          - `country_code` string: Customer payer cell phone area code.
          - `number` string: Customer payer cell phone number.

## Response `200`

Success

- object
  - `id` string
  - `message` string

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/y/apis/ai-caller.md) - [All operations](https://skmtc.dev/y/apis/ai-caller/llms.txt) - [OpenAPI document](https://skmtc.dev/y/apis/ai-caller/revisions/05b629819b49?raw)