Skip to main content
POST
/
v1
/
smart-support
/
external
/
payments
Recover abandoned payments
curl --request POST \
  --url https://api-sandbox.y.uno/v1/smart-support/external/payments \
  --header 'Content-Type: application/json' \
  --header 'account-code: <api-key>' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "checkout_session": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "channel": "SMS",
  "language": "pt-BR"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "QUEUED",
  "channel": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}
This endpint allows merchants to notify Yuno’s Recovery Agent when a user abandons their purchase flow, such as during product selection or after initiating checkout, before completing a payment. The submitted data enables Yuno to follow up with the user via call or WhatsApp to encourage completion of the transaction.

​
Security and compliance

  • Authentication: API access requires a valid API key provided in the request headers.
  • Data Protection: All data must be transmitted over HTTPS. Yuno adheres to relevant data protection regulations, including GDPR and LGPD.
  • Data Usage: Submitted data will be used solely for the purpose of customer engagement and will not be stored beyond the necessary duration.
Use Case ExampleA user named Jane Doe adds a pair of wireless headphones to her cart on a merchant’s website but abandons the checkout process. The merchant’s system detects this and sends the relevant payload to Yuno’s Recovery Agent API. Yuno then initiates a WhatsApp message to Jane, reminding her of the items left in her cart and offering assistance to complete the purchase.
The submitted data enables Yuno to follow up with the user via call or WhatsApp to encourage completion of the transaction.

​
Security and compliance

  • Authentication: API access requires a valid API key provided in the request headers.
  • Data Protection: All data must be transmitted over HTTPS. Yuno adheres to relevant data protection regulations, including GDPR and LGPD.
  • Data Usage: Submitted data will be used solely for the purpose of customer engagement and will not be stored beyond the necessary duration.

​
Use Case Example

A user named Jane Doe adds a pair of wireless headphones to her cart on a merchant’s website but abandons the checkout process. The merchant’s system detects this and sends the relevant payload to Yuno’s Recovery Agent API. Yuno then initiates a WhatsApp message to Jane, reminding her of the items left in her cart and offering assistance to complete the purchase.

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
​
checkout_session
string<uuid>
required

The abandoned checkout session

​
channel
enum<string>

Outreach channel

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

Language code

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>