lxbfYeaa/PayPal-PHP-Server-SDK
Template
1
0
Fork 0
forked from LiveCarta/PayPal-PHP-Server-SDK
Code Pull Requests Activity

repo initialized with test cases

Browse Source
This commit is contained in:
moizgillani
2024-09-06 15:38:17 +05:00
parent c9cb1ad04a
commit b20aa829db
754 changed files with 76684 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

114
doc/models/payment-collection.md Normal file
View File

@@ -0,0 +1,114 @@
# Payment Collection
The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds.
## Structure
`PaymentCollection`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `authorizations` | [`?(AuthorizationWithAdditionalData[])`](../../doc/models/authorization-with-additional-data.md) | Optional | An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments. | getAuthorizations(): ?array | setAuthorizations(?array authorizations): void |
| `captures` | [`?(Capture[])`](../../doc/models/capture.md) | Optional | An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments. | getCaptures(): ?array | setCaptures(?array captures): void |
| `refunds` | [`?(Refund[])`](../../doc/models/refund.md) | Optional | An array of refunds for a purchase unit. A purchase unit can have zero or more refunds. | getRefunds(): ?array | setRefunds(?array refunds): void |
## Example (as JSON)
```json
{
"authorizations": [
{
"status": "DENIED",
"status_details": {
"reason": "PENDING_REVIEW"
},
"id": "id2",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
},
"invoice_id": "invoice_id2"
},
{
"status": "DENIED",
"status_details": {
"reason": "PENDING_REVIEW"
},
"id": "id2",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
},
"invoice_id": "invoice_id2"
},
{
"status": "DENIED",
"status_details": {
"reason": "PENDING_REVIEW"
},
"id": "id2",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
},
"invoice_id": "invoice_id2"
}
],
"captures": [
{
"status": "REFUNDED",
"status_details": {
"reason": "VERIFICATION_REQUIRED"
},
"id": "id4",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
},
"invoice_id": "invoice_id4"
},
{
"status": "REFUNDED",
"status_details": {
"reason": "VERIFICATION_REQUIRED"
},
"id": "id4",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
},
"invoice_id": "invoice_id4"
}
],
"refunds": [
{
"status": "CANCELLED",
"status_details": {
"reason": "ECHECK"
},
"id": "id8",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
},
"invoice_id": "invoice_id8"
},
{
"status": "CANCELLED",
"status_details": {
"reason": "ECHECK"
},
"id": "id8",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
},
"invoice_id": "invoice_id8"
}
]
}
```