Skip to content

PayPal Wallet

Introduction

PayPal Wallet is a digital wallet that simplifies managing and making transactions online or in-app. Available every day, offering a secure platform for sending money, making payments, and receiving funds.

Getting Started

Generate Orders

Creating a Paypal Wallet REDIRECT order:

POST /api/v1/checkout/form
Host: latamgateway.com
Content-Type: application/json
ACCOUNT_TOKEN: "<token>"

{
  "order": {
    "code": "123",
    "notification_url": "https://yoursystem.com/postback/",
    "redirect_url": "https://yoursystem.com/finish_checkout?auto_redirect=true",
    "value": 50.00,
    "additional_info": "A description of your order, as a string",
    "payment_method": "paypal_wallet"
  }
}

Params descriptions

Field Description Value Type Requirement
order.code Order reference in your system String Required
order.notification_url URL to notify when status changes String Required
order.redirect_url URL for automatic redirection after checkout ends String Optional
order.value Total order value Number (Decimal) Required
order.additional_info Additional description of the order String Required
order.payment_method Payment method String Required

On a successful request HTTP 200 status code, the response will include the following parameters:

{
  "form_id": "dbcedec8-f587-4203-8aa4-a74da83fb32a", 
  "url": "https://latamgateway.com/checkout/payment/dbcedec8-f587-4203-8aa4-a74da83fb32a" 
}

Business errors due to incorrect or missing parameters are returned with an HTTP 400 status code. The response will indicate which parameter is invalid or missing.

{
    "message": "Payment method not supported"
}

Reverse Order

To reverse an order:

POST /api/v1/order/{order_id}/reverse
Host: latamgateway.com
Content-Type: "application/json"
ACCOUNT_TOKEN: "<token>"

On a successful request HTTP 200 status code, the response will include the following parameters:

{
  "message": "message": "Refund requested. Waiting for confirmation from the bank."
}

Business errors are returned with a 400 status code. The response will be:

{
  "message": "No order found with the provided ID."
}