- Authorization
- Orders
- Payments
- Invoices
- Invoices
- Templates
- Subscriptions
- Catalog Products
- Plans
- Subscriptions
- Payouts
- Webhooks
- Shipment Tracking
- Transaction Search
- Disputes
- List disputes
- Show dispute details
- Accept claim
- Appeal dispute
- Settle dispute
- Update dispute status
- Make offer to resolve dispute
- Provide evidence
- Acknowledge returned item
- Provide supporting information for dispute
- Escalate dispute to claim
- Accept offer to resolve dispute
- Send message about dispute to other party
- Deny offer to resolve dispute
- Partially update dispute
- Onboarding (Limited Release)
Show payout batch details
GET
/v1/payments/payouts/{payout_batch_id}
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Path 参数
payout_batch_id
string
必需
示例值:
{{payout_batch_id}}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api-m.sandbox.paypal.com/v1/payments/payouts/{{payout_batch_id}}' \
--header 'Authorization: Basic Og=='
返回响应
🟢200200 - Show Payout Batch Details
application/json
Body
batch_header
object
必需
payout_batch_id
string
必需
batch_status
string
必需
time_created
string
必需
time_completed
string
必需
sender_batch_header
object
必需
funding_source
string
必需
amount
object
必需
fees
object
必需
items
array [object {10}]
必需
payout_item_id
string
必需
transaction_id
string
必需
activity_id
string
必需
transaction_status
string
必需
payout_item_fee
object
必需
payout_batch_id
string
必需
payout_item
object
必需
time_processed
string
必需
errors
object
必需
links
array [object {4}]
必需
links
array [object {4}]
必需
href
string
可选
rel
string
可选
method
string
可选
encType
string
可选
示例
{
"batch_header": {
"payout_batch_id": "MJ77GF8MQ2TF6",
"batch_status": "SUCCESS",
"time_created": "2023-04-10T20:16:44Z",
"time_completed": "2023-04-10T20:16:45Z",
"sender_batch_header": {
"sender_batch_id": "Payouts_1681157804",
"email_subject": "You have a payout!",
"email_message": "You have received a payout! Thanks for using our service!"
},
"funding_source": "BALANCE",
"amount": {
"currency": "USD",
"value": "60.00"
},
"fees": {
"currency": "USD",
"value": "0.50"
}
},
"items": [
{
"payout_item_id": "CX64X3KPCVYLC",
"transaction_id": "4XH44110EC095525K",
"activity_id": "0KJ317812H109105P",
"transaction_status": "UNCLAIMED",
"payout_item_fee": {
"currency": "USD",
"value": "0.25"
},
"payout_batch_id": "MJ77GF8MQ2TF6",
"payout_item": {
"recipient_type": "EMAIL",
"amount": {
"currency": "USD",
"value": "10.00"
},
"note": "Thanks for your patronage!",
"receiver": "Coleman_Mohr@hotmail.com",
"sender_item_id": "201403140001",
"recipient_wallet": "PAYPAL"
},
"time_processed": "2023-04-10T20:16:45Z",
"errors": {
"name": "RECEIVER_UNREGISTERED",
"message": "The recipient for this payout does not have an account. A link to sign up for an account was sent to the recipient. However, if the recipient does not claim this payout within 30 days, the funds will be returned to your account.",
"information_link": "https://developer.paypal.com/docs/api/payments.payouts-batch/#errors",
"details": [],
"links": []
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/CX64X3KPCVYLC",
"rel": "item",
"method": "GET",
"encType": "application/json"
}
]
},
{
"payout_item_id": "S697W7QJMAEX4",
"transaction_id": "0FY48488BY887313U",
"activity_id": "53C6543893640342P",
"transaction_status": "UNCLAIMED",
"payout_item_fee": {
"currency": "USD",
"value": "0.25"
},
"payout_batch_id": "MJ77GF8MQ2TF6",
"payout_item": {
"recipient_type": "PHONE",
"amount": {
"currency": "USD",
"value": "20.00"
},
"note": "Thanks for your support!",
"receiver": "15562941698",
"sender_item_id": "201403140002",
"recipient_wallet": "PAYPAL"
},
"time_processed": "2023-04-10T20:16:45Z",
"errors": {
"name": "RECEIVER_UNREGISTERED",
"message": "The recipient for this payout does not have an account. A link to sign up for an account was sent to the recipient. However, if the recipient does not claim this payout within 30 days, the funds will be returned to your account.",
"information_link": "https://developer.paypal.com/docs/api/payments.payouts-batch/#errors",
"details": [],
"links": []
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/S697W7QJMAEX4",
"rel": "item",
"method": "GET",
"encType": "application/json"
}
]
},
{
"payout_item_id": "J64P4FHTAY7UN",
"transaction_status": "FAILED",
"payout_item_fee": {
"currency": "USD",
"value": "0.00"
},
"payout_batch_id": "MJ77GF8MQ2TF6",
"payout_item": {
"recipient_type": "PAYPAL_ID",
"amount": {
"currency": "USD",
"value": "30.00"
},
"note": "Thanks for your patronage!",
"receiver": "G83KXTJ5EHCQ2",
"sender_item_id": "201403140003",
"recipient_wallet": "PAYPAL"
},
"errors": {
"name": "RECEIVER_ACCOUNT_INVALID",
"message": "Receiver's account is invalid.",
"information_link": "https://developer.paypal.com/docs/api/payments.payouts-batch/#errors",
"details": [],
"links": []
},
"links": [
{
"href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/J64P4FHTAY7UN",
"rel": "item",
"method": "GET",
"encType": "application/json"
}
]
}
],
"links": [
{
"href": "https://api.sandbox.paypal.com/v1/payments/payouts/MJ77GF8MQ2TF6?page_size=1000&page=1",
"rel": "self",
"method": "GET",
"encType": "application/json"
}
]
}
🟠401401 Unauthorized - Invalid Token
🟠404404 Not Found - Payout Batch Not Found
修改于 2023-08-16 07:18:59