📘
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
Field Type Description idString ID of the order amountInteger Amount of the order in the smallest unit for the currency e.g. cents decimal_amountFloat Amount of the order as a decimal captured_amountInteger Captured amount if the order is captured authorized_amountInteger Authorization amount if the order is authorized refunded_amountInteger Refunded amount if the order is refunded messageString Approved, Declinedtransaction_idString ID of the refund currencyString Currency of the refund successfulBoolean If the operation was successful or not transaction_dateString / Date Date of the refund intentString Capture, Authorizepaypal_referenceString Reference number assigned by PayPal invoice_idString Invoice ID of the order billing_agreement_idString ID of the billing agreement if paid by a billing agreement statusString Created, Saved, Approved, Voided, Completedpayment_sourceString BILLING_AGREEMENTauthorizationsArray List of authorizations capturesArray List of captures refundsArray List of refunds payerObject Buyer's PayPal information payeeObject Merchant's PayPal information
Field Type Description idString ID of the authorization amountInteger Amount of the authorization in the smallest unit for the currency e.g. cents decimal_amountFloat Amount of the authorization as a decimal captured_amountInteger Captured amount if the authorization is captured refunded_amountInteger Refunded amount if the capture is refunded messageString Approved, Declinedtransaction_idString ID of the refund currencyString Currency of the refund successfulBoolean If the operation was successful or not transaction_dateString / Date Date of the refund statusString Created, Requested, Voided, Captured, Partially Captured, Expired, Deniedbalance_available_for_captureInteger Available balance for capture orderString ID of the parent order referenceString The order reference
Field Type Description idString ID of the refund amountInteger Amount of the refund in the smallest unit for the currency e.g. cents decimal_amountFloat Amount of the refund as a decimal captured_amountInteger Captured amount messageString Approved, Declinedtransaction_idString ID of the refund currencyString Currency of the refund successfulBoolean If the operation was successful or not transaction_dateString / Date Date of the refund statusString Completed, Requested, Declined, Refunded, `Partially Refundednote_to_payerString Note to the buyer invoice_idString Invoice ID of the refund paypal_feeInteger PayPal fee seller_receivable_net_amountInteger Seller receivable net amount balance_available_for_refundInteger Available balance for refund balance_available_for_captureInteger Available balance for capture authorizationString ID of the parent authorization orderString ID of the parent order refunded_amountInteger Refunded amount is_final_captureBoolean If this is the final capture of the order capturedBoolean If it is captured, refunded or partially refunded referenceString The order reference
Field Type Description idString ID of the refund amountInteger Amount of the refund in the smallest unit for the currency e.g. cents decimal_amountFloat Amount of the refund as a decimal refundedString Approved, DeclinedmessageString Approved, Declinedtransaction_idString ID of the refund currencyString Currency of the refund successfulBoolean If the operation was successful or not transaction_dateString / Date Date of the refund statusString Completed, Requestednote_to_payerString Note to the buyer invoice_idString Invoice ID of the refund paypal_feeInteger PayPal fee seller_payable_net_amountInteger Seller payable net amount balance_available_for_refundFloat Available balance for refund captureString ID of the parent capture orderString ID of the parent order
Field Type Description idString ID of the billing agreement nameString Name of the billing agreement assigned by merchant descriptionString Description of the billing agreement assigned by merchant stateString State of the billing agreement: Active, Inactive payerObject Buyer's information including: email, first_name, last_name shipping_addressObject Buyer's shipping address merchant_custom_dataString Merchant generated dataPayPalPaymentObject created_atString / Date Creation date of the billing agreement
