PayPal-PHP-Server-SDK/doc/models/refund.md

Refund

The refund information.

Structure

Refund

Fields

Name	Type	Tags	Description	Getter	Setter
status	?string(RefundStatus)	Optional	The status of the refund.	getStatus(): ?string	setStatus(?string status): void
statusDetails	?RefundStatusDetails	Optional	The details of the refund status.	getStatusDetails(): ?RefundStatusDetails	setStatusDetails(?RefundStatusDetails statusDetails): void
id	?string	Optional	The PayPal-generated ID for the refund.	getId(): ?string	setId(?string id): void
amount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getAmount(): ?Money	setAmount(?Money amount): void
invoiceId	?string	Optional	The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.	getInvoiceId(): ?string	setInvoiceId(?string invoiceId): void
customId	?string	Optional	The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Za-z0-9-_.,]*$	getCustomId(): ?string	setCustomId(?string customId): void
acquirerReferenceNumber	?string	Optional	Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks. Constraints: Minimum Length: 1, Maximum Length: 36, Pattern: ^[a-zA-Z0-9]+$	getAcquirerReferenceNumber(): ?string	setAcquirerReferenceNumber(?string acquirerReferenceNumber): void
noteToPayer	?string	Optional	The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.	getNoteToPayer(): ?string	setNoteToPayer(?string noteToPayer): void
sellerPayableBreakdown	?SellerPayableBreakdown	Optional	The breakdown of the refund.	getSellerPayableBreakdown(): ?SellerPayableBreakdown	setSellerPayableBreakdown(?SellerPayableBreakdown sellerPayableBreakdown): void
payer	?PayeeBase	Optional	The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.	getPayer(): ?PayeeBase	setPayer(?PayeeBase payer): void
links	?(LinkDescription[])	Optional	An array of related HATEOAS links.	getLinks(): ?array	setLinks(?array links): void
createTime	?string	Optional	The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$	getCreateTime(): ?string	setCreateTime(?string createTime): void
updateTime	?string	Optional	The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$	getUpdateTime(): ?string	setUpdateTime(?string updateTime): void

Example (as JSON)

{
  "status": "CANCELLED",
  "status_details": {
    "reason": "ECHECK"
  },
  "id": "id6",
  "amount": {
    "currency_code": "currency_code6",
    "value": "value0"
  },
  "invoice_id": "invoice_id6"
}