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:
In this document, PayPal endpoints are described including:
- Orders
- Authorizations
- Captures
- Refunds
- Billing Agreements
Response objects
Order
Field | Type | Description |
---|---|---|
| String | ID of the order |
| Integer | Amount of the order in the smallest unit for the currency e.g. cents |
| Float | Amount of the order as a decimal |
| Integer | Captured amount if the order is captured |
| Integer | Authorization amount if the order is authorized |
| Integer | Refunded amount if the order is refunded |
| String |
|
| String | ID of the refund |
| String | Currency of the refund |
| Boolean | If the operation was successful or not |
| String / Date | Date of the refund |
| String |
|
| String | Reference number assigned by PayPal |
| String | Invoice ID of the order |
| String | ID of the billing agreement if paid by a billing agreement |
| String |
|
| String |
|
| Array | List of authorizations |
| Array | List of captures |
| Array | List of refunds |
| Object | Buyer's PayPal information |
| Object | Merchant's PayPal information |
Authorization
Field | Type | Description |
---|---|---|
| String | ID of the authorization |
| Integer | Amount of the authorization in the smallest unit for the currency e.g. cents |
| Float | Amount of the authorization as a decimal |
| Integer | Captured amount if the authorization is captured |
| Integer | Refunded amount if the capture is refunded |
| String |
|
| String | ID of the refund |
| String | Currency of the refund |
| Boolean | If the operation was successful or not |
| String / Date | Date of the refund |
| String |
|
| Integer | Available balance for capture |
| String | ID of the parent order |
| String | The order reference |
Capture
Field | Type | Description |
---|---|---|
| String | ID of the refund |
| Integer | Amount of the refund in the smallest unit for the currency e.g. cents |
| Float | Amount of the refund as a decimal |
| Integer | Captured amount |
| String |
|
| String | ID of the refund |
| String | Currency of the refund |
| Boolean | If the operation was successful or not |
| String / Date | Date of the refund |
| String |
|
| String | Note to the buyer |
| String | Invoice ID of the refund |
| Integer | PayPal fee |
| Integer | Seller receivable net amount |
| Integer | Available balance for refund |
| Integer | Available balance for capture |
| String | ID of the parent authorization |
| String | ID of the parent order |
| Integer | Refunded amount |
| Boolean | If this is the final capture of the order |
| Boolean | If it is captured, refunded or partially refunded |
| String | The order reference |
Refund
Field | Type | Description |
---|---|---|
| String | ID of the refund |
| Integer | Amount of the refund in the smallest unit for the currency e.g. cents |
| Float | Amount of the refund as a decimal |
| String |
|
| String |
|
| String | ID of the refund |
| String | Currency of the refund |
| Boolean | If the operation was successful or not |
| String / Date | Date of the refund |
| String |
|
| String | Note to the buyer |
| String | Invoice ID of the refund |
| Integer | PayPal fee |
| Integer | Seller payable net amount |
| Float | Available balance for refund |
| String | ID of the parent capture |
| String | ID of the parent order |
Billing Agreement
Field | Type | Description |
---|---|---|
| String | ID of the billing agreement |
| String | Name of the billing agreement assigned by merchant |
| String | Description of the billing agreement assigned by merchant |
| String | State of the billing agreement: |
| Object | Buyer's information including: |
| Object | Buyer's shipping address |
| String | Merchant generated data |
| String / Date | Creation date of the billing agreement |