Ir al contenido

API

En esta página

Listar

Lista retiros con filtros estrictos y paginación por cursor hacia delante, revisa las redes de destino y concilia el historial de transferencias con fiabilidad.

GET/v1/withdrawals

Clave de API: Payout

Devuelve únicamente los retiros del comercio autenticado creados en el entorno de la clave. El orden es created_at DESC y, a igualdad, withdrawal_id DESC.

Parámetros de consulta

Parámetro Tipo Por defecto Descripción
limit integer 20 Tamaño de página, de 1 a 100.
cursor string El next_cursor opaco de la respuesta anterior.
status string Estado exacto en snake_case. Repite el parámetro para casar con varios estados; no envíes un valor separado por comas.
external_order_id string Identificador externo de pedido exacto, de hasta 200 caracteres.
created_from Unix seconds Límite inferior de created_at, inclusive.
created_to Unix seconds Límite superior de created_at, exclusivo. Debe ser posterior a created_from.

Los parámetros desconocidos, los parámetros escalares repetidos, los estados duplicados y las mayúsculas incorrectas en un enum se rechazan en lugar de ignorarse en silencio.

Ejemplo

GET /v1/withdrawals?limit=20&status=created&status=pending_review HTTP/1.1
Host: api.paymos.io
Authorization: HMAC-SHA256 rk_live_…:…
X-Request-Timestamp: 1767225660

Ejemplos de código

Cada pestaña usa el SDK oficial de ese lenguaje. La firma, la serialización, los reintentos seguros y los errores tipados los resuelve el SDK.

API_KEY_ID="rk_live_xxxxxxxxxxxx"
API_SECRET="sk_live_xxxxxxxxxxxx"
QUERY="?status=created&limit=20"

TS=$(date +%s)
# No body: the hash slot is the EMPTY STRING, not sha256("").
SIGNATURE=$(printf '%s\n%s\n%s\n%s\n%s' "$TS" GET /v1/withdrawals "$QUERY" '' \
  | openssl dgst -sha256 -hmac "$API_SECRET" -binary | base64)

curl -sS "https://api.paymos.io/v1/withdrawals$QUERY" \
  -H "Authorization: HMAC-SHA256 $API_KEY_ID:$SIGNATURE" \
  -H "X-Request-Timestamp: $TS"
import { Paymos } from '@paymos/sdk';

const paymos = new Paymos({
  apiKey: process.env.PAYMOS_PAYOUT_KEY,
  apiSecret: process.env.PAYMOS_API_SECRET,
});

const page = await paymos.withdrawals.list({ status: ['created', 'pending_review'], limit: 20 });

for await (const withdrawal of paymos.withdrawals.iterate({ status: ['completed'] }, 10)) {
  console.log(withdrawal.withdrawalId);
}
import os

from paymos import Paymos

paymos = Paymos(
    api_key=os.environ["PAYMOS_PAYOUT_KEY"],
    api_secret=os.environ["PAYMOS_API_SECRET"],
)

page = paymos.withdrawals.list(status=["created", "pending_review"], limit=20)

for withdrawal in paymos.withdrawals.iterate(10, status=["completed"]):
    print(withdrawal["withdrawal_id"])
<?php
use Paymos\Client;
use Paymos\ClientConfig;

$paymos = new Client(new ClientConfig(
    getenv('PAYMOS_PAYOUT_KEY'),
    getenv('PAYMOS_API_SECRET')
));

$page = $paymos->withdrawals()->listPage(array(
    'status' => array('created', 'pending_review'),
    'limit' => 20,
));

foreach ($paymos->withdrawals()->iterate(array('status' => array('completed')), 10) as $withdrawal) {
    echo $withdrawal['withdrawal_id'] . PHP_EOL;
}
package main

import (
	"context"
	"fmt"
	"os"

	paymos "github.com/Paymos-labs/go-sdk/v2"
)

func main() {
	client, err := paymos.NewClient(os.Getenv("PAYMOS_PAYOUT_KEY"), os.Getenv("PAYMOS_API_SECRET"))
	if err != nil {
		panic(err)
	}

	page, err := client.Withdrawals.List(context.Background(), paymos.WithdrawalListParams{
		Status: []paymos.WithdrawalStatus{paymos.WithdrawalCreated, paymos.WithdrawalPendingReview},
		Limit:  20,
	})
	if err != nil {
		panic(err)
	}
	fmt.Println(len(page.Items), page.NextCursor)

	iter := paymos.NewWithdrawalIterator(client.Withdrawals, paymos.WithdrawalListParams{
		Status: []paymos.WithdrawalStatus{paymos.WithdrawalCompleted},
	}, 10)
	for {
		withdrawal, ok, err := iter.Next(context.Background())
		if err != nil {
			panic(err)
		}
		if !ok {
			break
		}
		fmt.Println(withdrawal.WithdrawalID)
	}
}
using Paymos;

using var paymos = new PaymosClient(
    Environment.GetEnvironmentVariable("PAYMOS_PAYOUT_KEY")!,
    Environment.GetEnvironmentVariable("PAYMOS_API_SECRET")!);

var page = await paymos.Withdrawals.ListAsync(new WithdrawalListOptions(
    Status: [WithdrawalStatus.Created, WithdrawalStatus.PendingReview],
    Limit: 20));

await foreach (var withdrawal in paymos.Withdrawals.IterateAsync(
    new WithdrawalListOptions(Status: [WithdrawalStatus.Completed]), maxPages: 10))
{
    Console.WriteLine(withdrawal.WithdrawalId);
}
import io.paymos.Page;
import io.paymos.PaymosClient;
import io.paymos.Withdrawal;
import io.paymos.WithdrawalListOptions;
import io.paymos.WithdrawalStatus;

import java.util.List;

PaymosClient paymos = new PaymosClient(
    System.getenv("PAYMOS_PAYOUT_KEY"),
    System.getenv("PAYMOS_API_SECRET"));

Page<Withdrawal> page = paymos.withdrawals.list(WithdrawalListOptions.builder()
    .status(List.of(WithdrawalStatus.CREATED, WithdrawalStatus.PENDING_REVIEW))
    .limit(20)
    .build());

for (Withdrawal withdrawal : paymos.withdrawals.iterate(
        WithdrawalListOptions.builder().status(List.of(WithdrawalStatus.COMPLETED)).build(), 10)) {
    System.out.println(withdrawal.withdrawalId());
}
require 'paymos'

paymos = Paymos::Client.new(
  api_key: ENV.fetch('PAYMOS_PAYOUT_KEY'),
  api_secret: ENV.fetch('PAYMOS_API_SECRET')
)

page = paymos.withdrawals.list(status: ['created', 'pending_review'], limit: 20)

paymos.withdrawals.each(max_pages: 10, status: ['completed']) do |withdrawal|
  puts withdrawal.withdrawal_id
end
use paymos::{PaymosClient, WithdrawalListParams, WithdrawalStatus};

let paymos = PaymosClient::new(
    std::env::var("PAYMOS_PAYOUT_KEY")?,
    std::env::var("PAYMOS_API_SECRET")?,
)?;

let page = paymos
    .withdrawals()
    .list(&WithdrawalListParams {
        status: Some(vec![WithdrawalStatus::Created, WithdrawalStatus::PendingReview]),
        limit: Some(20),
        ..Default::default()
    })
    .await?;
println!("{} items, next_cursor={:?}", page.items.len(), page.next_cursor);

let mut pager = paymos.withdrawals().pager(
    WithdrawalListParams { status: Some(vec![WithdrawalStatus::Completed]), ..Default::default() },
    Some(10),
)?;
while let Some(withdrawal) = pager.next().await? {
    println!("{}", withdrawal.withdrawal_id);
}

Respuesta (200 OK)

{
  "items": [
    {
      "withdrawal_id": "wdr_6Qm2fK8xR4vN7cT1bY9dL5",
      "external_order_id": "payout-1042",
      "status": "completed",
      "is_final": true,
      "is_test": false,
      "amount": "100.00",
      "fee": "1.00",
      "currency": "USDT",
      "network": "TRC20",
      "destination_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
      "created_at": 1767225600,
      "completed_at": 1767226120
    }
  ],
  "next_cursor": null
}

El elemento de la lista es deliberadamente compacto y no expone hashes de transacción ni detalles internos de la ejecución. Para el recurso completo, usa Obtener retiro. La respuesta lleva Cache-Control: private, no-store.

Reglas de paginación

  • No hay número de página ni total_count: sigue next_cursor hasta que valga null.
  • El cursor es opaco, está protegido contra manipulación y vence a las 24 horas.
  • Está ligado al recurso de retiros y al conjunto exacto de filtros. Mantén los filtros sin cambios entre páginas; limit sí puede variar.
  • Un cursor ausente o final se representa con next_cursor: null.
  • Si el cursor no es válido, ha vencido, se usa en otro recurso o se combina con filtros distintos, empieza de nuevo sin cursor.

Errores

Una clave Payment (pk_) se rechaza con 403 payout_key_required. Los filtros no válidos devuelven un 400 por campo; un cursor no válido devuelve 400 pagination_cursor_invalid. Consulta Códigos de error.