API
本页内容
列表
使用游标分页查询账单退款列表,支持按账单 ID、状态或创建时间范围筛选。
GET/v1/refunds
API 密钥: Payment
返回当前 Payment 密钥可见项目下的账单退款记录,按 created_at DESC、再按 withdrawal_id DESC 排序。通过 POST /v1/withdrawals 创建的普通商户转出不会出现在此列表中。
查询参数
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
limit |
integer | 20 |
每页条数,范围 1 到 100 |
cursor |
string | — | 上一页响应返回的透明游标 next_cursor |
invoice_id |
string | — | 按带前缀的账单 ID(inv_...)筛选 |
status |
string | — | 精确匹配 snake_case 状态(created、signed、pending_review、cancelling、completed、failed、cancelled)。可重复传参以匹配多个状态 |
created_from |
RFC 3339 | — | 包含边界的 created_at 起始时间,需带时区偏移(如 2026-08-23T00:00:00Z) |
created_to |
RFC 3339 | — | 不包含边界的 created_at 结束时间,需带时区偏移且晚于 created_from |
未知查询参数、重复状态值和无效时间戳均会返回 400。
代码示例
每个标签页均使用对应语言的官方 SDK 并配置 Payment 密钥(pk_)。
API_KEY_ID="pk_live_xxxxxxxxxxxx"
API_SECRET="sk_live_xxxxxxxxxxxx"
QUERY="?invoice_id=inv_7K2M9P4Q8R1X5Z3A0bC2dE&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/refunds "$QUERY" '' \
| openssl dgst -sha256 -hmac "$API_SECRET" -binary | base64)
curl -sS "https://api.paymos.io/v1/refunds$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_API_KEY,
apiSecret: process.env.PAYMOS_API_SECRET,
});
const page = await paymos.refunds.list({
invoiceId: 'inv_7K2M9P4Q8R1X5Z3A0bC2dE',
limit: 20,
});
for await (const refund of paymos.refunds.iterate({ status: ['completed'] }, 10)) {
console.log(refund.withdrawalId);
}
import os
from paymos import Paymos
paymos = Paymos(
api_key=os.environ["PAYMOS_API_KEY"],
api_secret=os.environ["PAYMOS_API_SECRET"],
)
page = paymos.refunds.list(invoice_id="inv_7K2M9P4Q8R1X5Z3A0bC2dE", limit=20)
for refund in paymos.refunds.iterate(10, status=["completed"]):
print(refund["withdrawal_id"])
<?php
use Paymos\Client;
use Paymos\ClientConfig;
$paymos = new Client(new ClientConfig(
getenv('PAYMOS_API_KEY'),
getenv('PAYMOS_API_SECRET')
));
$page = $paymos->refunds()->listPage(array(
'invoice_id' => 'inv_7K2M9P4Q8R1X5Z3A0bC2dE',
'limit' => 20,
));
foreach ($paymos->refunds()->iterate(array('status' => array('completed')), 10) as $refund) {
echo $refund['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_API_KEY"), os.Getenv("PAYMOS_API_SECRET"))
if err != nil {
panic(err)
}
page, err := client.Refunds.List(context.Background(), paymos.RefundListParams{
InvoiceID: "inv_7K2M9P4Q8R1X5Z3A0bC2dE",
Limit: 20,
})
if err != nil {
panic(err)
}
fmt.Println(len(page.Items), page.NextCursor)
iter := paymos.NewRefundIterator(client.Refunds, paymos.RefundListParams{
Status: []paymos.WithdrawalStatus{paymos.WithdrawalCompleted},
}, 10)
for {
refund, ok, err := iter.Next(context.Background())
if err != nil {
panic(err)
}
if !ok {
break
}
fmt.Println(refund.WithdrawalID)
}
}
using Paymos;
using var paymos = new PaymosClient(
Environment.GetEnvironmentVariable("PAYMOS_API_KEY")!,
Environment.GetEnvironmentVariable("PAYMOS_API_SECRET")!);
var page = await paymos.Refunds.ListAsync(new RefundListOptions(
InvoiceId: "inv_7K2M9P4Q8R1X5Z3A0bC2dE",
Limit: 20));
await foreach (var refund in paymos.Refunds.IterateAsync(
new RefundListOptions(Status: [WithdrawalStatus.Completed]), maxPages: 10))
{
Console.WriteLine(refund.WithdrawalId);
}
import io.paymos.Page;
import io.paymos.PaymosClient;
import io.paymos.Refund;
import io.paymos.RefundListOptions;
import io.paymos.WithdrawalStatus;
import java.util.List;
PaymosClient paymos = new PaymosClient(
System.getenv("PAYMOS_API_KEY"),
System.getenv("PAYMOS_API_SECRET"));
Page<Refund> page = paymos.refunds.list(RefundListOptions.builder()
.invoiceId("inv_7K2M9P4Q8R1X5Z3A0bC2dE")
.limit(20)
.build());
for (Refund refund : paymos.refunds.iterate(
RefundListOptions.builder().status(List.of(WithdrawalStatus.COMPLETED)).build(), 10)) {
System.out.println(refund.withdrawalId());
}
require 'paymos'
paymos = Paymos::Client.new(
api_key: ENV.fetch('PAYMOS_API_KEY'),
api_secret: ENV.fetch('PAYMOS_API_SECRET')
)
page = paymos.refunds.list(invoice_id: 'inv_7K2M9P4Q8R1X5Z3A0bC2dE', limit: 20)
paymos.refunds.each(max_pages: 10, status: ['completed']) do |refund|
puts refund.withdrawal_id
end
use paymos::{PaymosClient, RefundListParams, WithdrawalStatus};
let paymos = PaymosClient::new(
std::env::var("PAYMOS_API_KEY")?,
std::env::var("PAYMOS_API_SECRET")?,
)?;
let page = paymos
.refunds()
.list(&RefundListParams {
invoice_id: Some("inv_7K2M9P4Q8R1X5Z3A0bC2dE".to_owned()),
limit: Some(20),
..Default::default()
})
.await?;
println!("{} items, next_cursor={:?}", page.items.len(), page.next_cursor);
let mut pager = paymos.refunds().pager(
RefundListParams { status: Some(vec![WithdrawalStatus::Completed]), ..Default::default() },
Some(10),
)?;
while let Some(refund) = pager.next().await? {
println!("{}", refund.withdrawal_id);
}
响应(200 OK)
{
"items": [
{
"withdrawal_id": "wdr_6Qm2fK8xR4vN7cT1bY9dL5",
"invoice_id": "inv_7K2M9P4Q8R1X5Z3A0bC2dE",
"mode": "full",
"external_order_id": "refund-1042-full",
"status": "completed",
"is_final": true,
"is_test": false,
"amount": "100.00",
"fee": "1.00",
"currency": "USDT",
"network": "TRC20",
"destination_address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
"first_sender": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
"tx_hash": "9f3b8c2a1d0e4f6789abc123def4567890abc123def4567890abc123def45678",
"explorer_url": "https://tronscan.org/#/transaction/9f3b8c2a1d0e4f6789abc123def4567890abc123def4567890abc123def45678",
"created_at": 1767225600,
"completed_at": 1767225932,
"type": "refund",
"project_id": "prj_3F9xL2mN8pQ4rT6vW1yZ5b"
}
],
"next_cursor": null
}
items 中的每一项都包含完整的退款资源,结构与获取退款一致。
分页规则
- 持续跟随
next_cursor翻页,直到其返回null。 - 游标与
/v1/refunds端点及筛选参数(invoice_id、status、created_from、created_to)严格绑定。翻页期间请保持筛选条件不变,limit可以调整。 - 游标自签发后 24 小时过期。
- 传入不在当前密钥项目范围内的
invoice_id会返回空列表而非404。
错误码
使用 Payout(rk_)密钥会返回 403 payment_key_required。无效筛选参数返回 400,过期或筛选条件不匹配的游标返回 400 pagination_cursor_invalid。详见错误码。