Skip to main content
POST
/
v1
/
smart-support
/
external
/
payments
/
recover
Recover declined payments
curl --request POST \
  --url https://api-sandbox.y.uno/v1/smart-support/external/payments/recover \
  --header 'Content-Type: application/json' \
  --header 'account-code: <api-key>' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "payment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "channel": "PHONE",
  "language": "pt-BR"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "QUEUED",
  "channel": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}
This endpoint allows you to initiate large-scale processing of calls and WhatsApp messages related to declined payments. To use the endpoint, you have to provide an object containing detailed information about the declined payment.

Authorizations

​
public-api-key
string
header
required

Your public API key from the Yuno Dashboard

​
private-secret-key
string
header
required

Your private secret key (server-side only)

​
account-code
string
header
required

Your account identifier. The alias X-Account-Code is also accepted.

Body

application/json
​
payment_id
string<uuid>
required

The declined payment to recover

​
channel
enum<string>

Outreach channel

Available options:
PHONE,
SMS,
EMAIL,
WHATSAPP
​
language
string

Language code (e.g., pt-BR, es-MX)

Example:

"pt-BR"

Response

Recovery process initiated

​
id
string<uuid>
​
status
enum<string>
Available options:
QUEUED,
IN_PROGRESS,
COMPLETED,
FAILED
​
channel
string
​
created_at
string<date-time>