Devolver PIX recebido
curl --request POST \
--url https://api.oripaysolutions.com.br/v1/pix/received/{id}/refunds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"amount": 15000,
"external_id": "pedido-8812",
"reason": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({amount: 15000, external_id: 'pedido-8812', reason: '<string>'})
};
fetch('https://api.oripaysolutions.com.br/v1/pix/received/{id}/refunds', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.oripaysolutions.com.br/v1/pix/received/{id}/refunds"
payload = {
"amount": 15000,
"external_id": "pedido-8812",
"reason": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.oripaysolutions.com.br/v1/pix/received/{id}/refunds",
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([
'amount' => 15000,
'external_id' => 'pedido-8812',
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"received_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"amount": 123,
"end_to_end_id": "<string>",
"failure_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "insufficient_balance",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
],
"existing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_balance",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
],
"existing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_balance",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
],
"existing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_balance",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
],
"existing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_balance",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
],
"existing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Devoluções
Devolver PIX recebido
Scope: refunds:write (chave aprovada pela OriPay). Passa pelo antifraude: pode responder 403 { "error": "risk_score_exceeded" } ou, com o antifraude fora do ar e valor acima de R$ 1.000,00, 401 { "code": "step_up_required_risk_unavailable" }.
POST
/
pix
/
received
/
{id}
/
refunds
Devolver PIX recebido
curl --request POST \
--url https://api.oripaysolutions.com.br/v1/pix/received/{id}/refunds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"amount": 15000,
"external_id": "pedido-8812",
"reason": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({amount: 15000, external_id: 'pedido-8812', reason: '<string>'})
};
fetch('https://api.oripaysolutions.com.br/v1/pix/received/{id}/refunds', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.oripaysolutions.com.br/v1/pix/received/{id}/refunds"
payload = {
"amount": 15000,
"external_id": "pedido-8812",
"reason": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.oripaysolutions.com.br/v1/pix/received/{id}/refunds",
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([
'amount' => 15000,
'external_id' => 'pedido-8812',
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"received_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"amount": 123,
"end_to_end_id": "<string>",
"failure_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "insufficient_balance",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
],
"existing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_balance",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
],
"existing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_balance",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
],
"existing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_balance",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
],
"existing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_balance",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
],
"existing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
Chave oripay_live_.... Só funciona dos IPs cadastrados para ela.
Headers
Uma chave por intenção. Repita a mesma chave em retry. Fica presa ao external_id do recurso. Replay responde com o header Idempotency-Replayed igual a true.
Required string length:
8 - 128Pattern:
^[\x21-\x7e]{8,128}$Path Parameters
Body
application/json