Create Dispute

POST

payments

{payment_id}

disputes

Create dispute

curl --request POST \
  --url https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "reason": "Customer claims item not received",
  "amount": {
    "currency": "BRL",
    "value": 150
  }
}
'

import requests

url = "https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes"

payload = {
    "reason": "Customer claims item not received",
    "amount": {
        "currency": "BRL",
        "value": 150
    }
}
headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    reason: 'Customer claims item not received',
    amount: {currency: 'BRL', value: 150}
  })
};

fetch('https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'Customer claims item not received',
    'amount' => [
        'currency' => 'BRL',
        'value' => 150
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes"

	payload := strings.NewReader("{\n  \"reason\": \"Customer claims item not received\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 150\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Customer claims item not received\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 150\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Customer claims item not received\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 150\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": {
    "currency": "BRL",
    "value": 100
  },
  "reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

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)

Path Parameters

payment_id

string<uuid>

required

The unique identifier of the payment

Body

application/json

reason

string

required

Reason for the dispute

Example:

"Customer claims item not received"

amount

object

required

Show child attributes

Example:

{ "currency": "BRL", "value": 100 }

evidence

object

Show child attributes

Response

Dispute created successfully

string<uuid>

payment_id

string<uuid>

status

enum<string>

Available options:

OPEN,

EVIDENCE_SUBMITTED,

WON,

LOST,

ACCEPTED

amount

object

Show child attributes

Example:

{ "currency": "BRL", "value": 100 }

reason

string

created_at

string<date-time>

updated_at

string<date-time>

Create dispute

curl --request POST \
  --url https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "reason": "Customer claims item not received",
  "amount": {
    "currency": "BRL",
    "value": 150
  }
}
'

import requests

url = "https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes"

payload = {
    "reason": "Customer claims item not received",
    "amount": {
        "currency": "BRL",
        "value": 150
    }
}
headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    reason: 'Customer claims item not received',
    amount: {currency: 'BRL', value: 150}
  })
};

fetch('https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'Customer claims item not received',
    'amount' => [
        'currency' => 'BRL',
        'value' => 150
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes"

	payload := strings.NewReader("{\n  \"reason\": \"Customer claims item not received\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 150\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Customer claims item not received\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 150\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/payments/{payment_id}/disputes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Customer claims item not received\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 150\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": {
    "currency": "BRL",
    "value": 100
  },
  "reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

Getting started

Conventions

Core

Recurring

Hosted

Marketplace

Embedded finance

Operations

Recovery

Reference data

Authorizations

Path Parameters

Body

Response