PayPal

📘
PayPal Integration
You can talk to our support team about integrating PayPal Checkout and activating your account. You can also refer to our integration guideline document for further information:
https://docs.fatzebra.com/docs/paypal-overview

In this document, PayPal endpoints are described including:

Orders
Authorizations
Captures
Refunds
Billing Agreements

Response objects

Order

Field	Type	Description
`id`	String	ID of the order
`amount`	Integer	Amount of the order in the smallest unit for the currency e.g. cents
`decimal_amount`	Float	Amount of the order as a decimal
`captured_amount`	Integer	Captured amount if the order is captured
`authorized_amount`	Integer	Authorization amount if the order is authorized
`refunded_amount`	Integer	Refunded amount if the order is refunded
`message`	String	`Approved`, `Declined`
`transaction_id`	String	ID of the refund
`currency`	String	Currency of the refund
`successful`	Boolean	If the operation was successful or not
`transaction_date`	String / Date	Date of the refund
`intent`	String	`Capture`, `Authorize`
`paypal_reference`	String	Reference number assigned by PayPal
`invoice_id`	String	Invoice ID of the order
`billing_agreement_id`	String	ID of the billing agreement if paid by a billing agreement
`status`	String	`Created`, `Saved`, `Approved`, `Voided`, `Completed`
`payment_source`	String	`BILLING_AGREEMENT`
`authorizations`	Array	List of authorizations
`captures`	Array	List of captures
`refunds`	Array	List of refunds
`payer`	Object	Buyer's PayPal information
`payee`	Object	Merchant's PayPal information

Authorization

Field	Type	Description
`id`	String	ID of the authorization
`amount`	Integer	Amount of the authorization in the smallest unit for the currency e.g. cents
`decimal_amount`	Float	Amount of the authorization as a decimal
`captured_amount`	Integer	Captured amount if the authorization is captured
`refunded_amount`	Integer	Refunded amount if the capture is refunded
`message`	String	`Approved`, `Declined`
`transaction_id`	String	ID of the refund
`currency`	String	Currency of the refund
`successful`	Boolean	If the operation was successful or not
`transaction_date`	String / Date	Date of the refund
`status`	String	`Created`, `Requested`, `Voided`, `Captured`, `Partially Captured`, `Expired`, `Denied`
`balance_available_for_capture`	Integer	Available balance for capture
`order`	String	ID of the parent order
`reference`	String	The order reference

Capture

Field	Type	Description
`id`	String	ID of the refund
`amount`	Integer	Amount of the refund in the smallest unit for the currency e.g. cents
`decimal_amount`	Float	Amount of the refund as a decimal
`captured_amount`	Integer	Captured amount
`message`	String	`Approved`, `Declined`
`transaction_id`	String	ID of the refund
`currency`	String	Currency of the refund
`successful`	Boolean	If the operation was successful or not
`transaction_date`	String / Date	Date of the refund
`status`	String	`Completed`, `Requested`, `Declined`, `Refunded`, `Partially Refunded
`note_to_payer`	String	Note to the buyer
`invoice_id`	String	Invoice ID of the refund
`paypal_fee`	Integer	PayPal fee
`seller_receivable_net_amount`	Integer	Seller receivable net amount
`balance_available_for_refund`	Integer	Available balance for refund
`balance_available_for_capture`	Integer	Available balance for capture
`authorization`	String	ID of the parent authorization
`order`	String	ID of the parent order
`refunded_amount`	Integer	Refunded amount
`is_final_capture`	Boolean	If this is the final capture of the order
`captured`	Boolean	If it is captured, refunded or partially refunded
`reference`	String	The order reference

Refund

Field	Type	Description
`id`	String	ID of the refund
`amount`	Integer	Amount of the refund in the smallest unit for the currency e.g. cents
`decimal_amount`	Float	Amount of the refund as a decimal
`refunded`	String	`Approved`, `Declined`
`message`	String	`Approved`, `Declined`
`transaction_id`	String	ID of the refund
`currency`	String	Currency of the refund
`successful`	Boolean	If the operation was successful or not
`transaction_date`	String / Date	Date of the refund
`status`	String	`Completed`, `Requested`
`note_to_payer`	String	Note to the buyer
`invoice_id`	String	Invoice ID of the refund
`paypal_fee`	Integer	PayPal fee
`seller_payable_net_amount`	Integer	Seller payable net amount
`balance_available_for_refund`	Float	Available balance for refund
`capture`	String	ID of the parent capture
`order`	String	ID of the parent order

Billing Agreement

Field	Type	Description
`id`	String	ID of the billing agreement
`name`	String	Name of the billing agreement assigned by merchant
`description`	String	Description of the billing agreement assigned by merchant
`state`	String	State of the billing agreement: `Active`, `Inactive`
`payer`	Object	Buyer's information including: `email`, `first_name`, `last_name`
`shipping_address`	Object	Buyer's shipping address
`merchant_custom_data`	String	Merchant generated data Refer to PayPalPaymentObject
`created_at`	String / Date	Creation date of the billing agreement