Anexa comprovante de pagamento manual

POST

payouts

{payoutId}

receipt

curl --request POST \
  --url https://api.userepass.com/payouts/{payoutId}/receipt \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userepass.com/payouts/{payoutId}/receipt', 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.userepass.com/payouts/{payoutId}/receipt",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.userepass.com/payouts/{payoutId}/receipt"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.userepass.com/payouts/{payoutId}/receipt")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "pay_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "organizationId": "org_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "affiliateId": "aff_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "batchId": "cyc_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "fundingId": "fund_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "status": "scheduled",
  "method": "pix",
  "amountCents": 25000,
  "currency": "BRL",
  "commissionCount": 4,
  "destination": {
    "method": "pix",
    "pixKey": "[email protected]",
    "pixKeyType": "email"
  },
  "failureReason": "Chave PIX inválida",
  "providerTransactionId": "txn_8f3c1a2b9d4e",
  "providerReceiptUrl": "https://provedor.exemplo.com/receipts/txn_8f3c1a2b9d4e",
  "settlementSource": "manual",
  "manualReceiptFileKey": "org/org_…/payouts/pay_…/receipt_….pdf",
  "markedPaidByUserId": "usr_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "scheduledAt": "2026-06-13T12:00:00.000Z",
  "processedAt": "2026-06-13T12:05:00.000Z",
  "paidAt": "2026-06-13T12:10:00.000Z",
  "failedAt": "2026-06-13T12:10:00.000Z",
  "canceledAt": "2026-06-13T12:10:00.000Z",
  "createdAt": "2026-06-13T12:00:00.000Z",
  "updatedAt": "2026-06-13T12:00:00.000Z"
}

Authorizations

Authorization

string

header

required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

payoutId

string

required

Identificador do payout (prefixo pay_ + ULID).

Pattern: ^pay_[0-9A-HJKMNP-TV-Z]{26}$

Example:

"pay_01J9Z3K8N2QF4T7B9XP0WMD5RC"

Response

200 - application/json

Default Response

string

required

Identificador único do payout (prefixo pay_ + ULID).

Example:

"pay_01J9Z3K8N2QF4T7B9XP0WMD5RC"

organizationId

string

required

Organização (tenant) dona do payout.

Example:

"org_01J9Z3K8N2QF4T7B9XP0WMD5RC"

affiliateId

string

required

Afiliado beneficiário do payout.

Example:

"aff_01J9Z3K8N2QF4T7B9XP0WMD5RC"

batchId

string | null

required

Lote de fechamento (ciclo) ao qual o payout pertence. null em payouts anteriores aos lotes.

Example:

"cyc_01J9Z3K8N2QF4T7B9XP0WMD5RC"

fundingId

string | null

required

Aporte (cobrança PIX) que cobre este payout, carimbado na autorização do lote. null enquanto o payout não entrou em nenhuma cobrança — sem cobertura ele não é distribuído.

Example:

"fund_01J9Z3K8N2QF4T7B9XP0WMD5RC"

status

enum<string>

required

Status atual do payout.

Available options:

scheduled,

processing,

completed,

failed,

canceled

Example:

"scheduled"

method

enum<string>

required

Método de pagamento registrado na criação do payout. Fica fixo a partir desse momento, mesmo que o afiliado altere o método depois.

Available options:

pix

Example:

"pix"

amountCents

integer

required

Valor total do payout em centavos (ex.: 1990 = R$19,90).

Required range: -9007199254740991 <= x <= 9007199254740991

Example:

25000

currency

string

required

Moeda do payout (código ISO 4217).

Example:

"BRL"

commissionCount

integer

required

Quantidade de comissões agregadas neste payout.

Required range: -9007199254740991 <= x <= 9007199254740991

Example:

4

destination

object

required

Destino do pagamento registrado na criação do payout. Fica fixo a partir desse momento, mesmo que o afiliado altere os dados depois.

Show child attributes

failureReason

string | null

required

Motivo da falha quando status é failed. null caso contrário.

Example:

"Chave PIX inválida"

providerTransactionId

string | null

required

ID da transação no provedor de pagamento. null enquanto não processado.

Example:

"txn_8f3c1a2b9d4e"

providerReceiptUrl

string | null

required

URL do comprovante de pagamento no provedor. null enquanto não pago.

Example:

"https://provedor.exemplo.com/receipts/txn_8f3c1a2b9d4e"

settlementSource

enum<string> | null

required

Origem da liquidação. provider: transferência via gateway. manual: operador marcou como pago. null em payouts ainda não liquidados ou históricos.

Available options:

provider,

manual

Example:

"manual"

manualReceiptFileKey

string | null

required

Chave do comprovante anexado pelo operador (liquidação manual). Use GET /payouts/{id}/receipt para a URL assinada.

Example:

"org/org_…/payouts/pay_…/receipt_….pdf"

markedPaidByUserId

string | null

required

Usuário que marcou o payout como pago manualmente. null na liquidação via provedor.

Example:

"usr_01J9Z3K8N2QF4T7B9XP0WMD5RC"

scheduledAt

string<date-time>

required

Data de agendamento do payout (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

processedAt

string<date-time> | null

required

Data em que o payout entrou em processamento (ISO-8601). null enquanto agendado.

Example:

"2026-06-13T12:05:00.000Z"

paidAt

string<date-time> | null

required

Data do pagamento concluído (ISO-8601). null enquanto não pago.

Example:

"2026-06-13T12:10:00.000Z"

failedAt

string<date-time> | null

required

Data da falha (ISO-8601). null quando não falhou.

Example:

"2026-06-13T12:10:00.000Z"

canceledAt

string<date-time> | null

required

Data do cancelamento (ISO-8601). null quando não cancelado.

Example:

"2026-06-13T12:10:00.000Z"

createdAt

string<date-time>

required

Data de criação do payout (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

updatedAt

string<date-time>

required

Data da última atualização do payout (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

Anexa comprovante de pagamento manual

curl --request POST \
  --url https://api.userepass.com/payouts/{payoutId}/receipt \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userepass.com/payouts/{payoutId}/receipt', 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.userepass.com/payouts/{payoutId}/receipt",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.userepass.com/payouts/{payoutId}/receipt"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.userepass.com/payouts/{payoutId}/receipt")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "pay_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "organizationId": "org_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "affiliateId": "aff_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "batchId": "cyc_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "fundingId": "fund_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "status": "scheduled",
  "method": "pix",
  "amountCents": 25000,
  "currency": "BRL",
  "commissionCount": 4,
  "destination": {
    "method": "pix",
    "pixKey": "[email protected]",
    "pixKeyType": "email"
  },
  "failureReason": "Chave PIX inválida",
  "providerTransactionId": "txn_8f3c1a2b9d4e",
  "providerReceiptUrl": "https://provedor.exemplo.com/receipts/txn_8f3c1a2b9d4e",
  "settlementSource": "manual",
  "manualReceiptFileKey": "org/org_…/payouts/pay_…/receipt_….pdf",
  "markedPaidByUserId": "usr_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "scheduledAt": "2026-06-13T12:00:00.000Z",
  "processedAt": "2026-06-13T12:05:00.000Z",
  "paidAt": "2026-06-13T12:10:00.000Z",
  "failedAt": "2026-06-13T12:10:00.000Z",
  "canceledAt": "2026-06-13T12:10:00.000Z",
  "createdAt": "2026-06-13T12:00:00.000Z",
  "updatedAt": "2026-06-13T12:00:00.000Z"
}