Sale

Perform a PayPal sale request.

Methods

POST

Perform a sale request.

Request

Copied!
{
 "type": "object",
 "properties": {
  "instruction": {
   "type": "object",
   "properties": {
    "paymentInstrument": {
     "type": "object",
     "properties": {
      "shippingAddress": {
       "type": "object",
       "properties": {
        "firstName": {
         "type": "string"
        },
        "lastName": {
         "type": "string"
        },
        "street": {
         "type": "string"
        },
        "postalCode": {
         "type": "string"
        },
        "city": {
         "type": "string"
        },
        "state": {
         "type": "string"
        },
        "countryCode": {
         "type": "string"
        },
        "required": [
         "street",
         "postalCode",
         "countryCode"
        ]
       }
      },
      "billingAddress": {
       "type": "object",
       "properties": {
        "firstName": {
         "type": "string"
        },
        "lastName": {
         "type": "string"
        },
        "shopperEmailAddress": {
         "type": "string"
        },
        "address1": {
         "type": "string"
        },
        "address2": {
         "type": "string"
        },
        "address3": {
         "type": "string"
        },
        "postalCode": {
         "type": "string"
        },
        "city": {
         "type": "string"
        },
        "state": {
         "type": "string"
        },
        "countryCode": {
         "type": "string"
        }
       },
       "required": [
        "address1",
        "city",
        "countryCode",
        "postalCode"
       ]
      }
     },
     "required": [
      "billingAddress"
     ]
    },
    "value": {
     "type": "object",
     "properties": {
      "amount": {
       "type": "integer"
      },
      "currency": {
       "type": "string"
      }
     },
     "required": [
      "amount",
      "currency"
     ]
    }
   },
   "required": [
    "paymentInstrument",
    "value"
   ]
  },
  "merchant": {
   "type": "object",
   "properties": {
    "entity": {
     "type": "string"
    }
   },
   "required": [
    "entity"
   ]
  },
  "transactionReference": {
   "type": "string"
  }
 },
 "required": [
  "instruction",
  "merchant",
  "transactionReference"
 ]
}

Responses

Examples

POST
 PayPal Sale with an outcome of 'Sent for Settlement'
View

Link relationship

post
 PayPal Sale with an outcome of 'Sent for Settlement' 
POST
Copied!
{
  "Authorization": "Basic Auth",
  "Content-Type": "application/vnd.worldpay.paypal-v1+json",
  "Accept": "application/vnd.worldpay.paypal-v1+json"
}
Copied!
{"transactionReference":"reference","merchant":{"entity":"entity"},"instruction":{{"paymentInstrument":{"ShippingAddress":{"firstName":"firstName","lastName":"lastName","street":"street","postalCode":"45249","city":"city","state":"OH"}},{"billingAddress":{"firstName":"firstName","lastName":"lastName","shopperMailAddress":"shopperMailAddress","address1":"address1","address2":"address2","address3":"address3","postalCode":"45249","city":"city","state":"OH","countryCode":"US"}},"value":{"currency":"USD","amount":250}}}

201

Copied!
{
  "orderId": "paypalorderId",
  "outcome": "pendingSale",
  "_links": {
    "paypal:events": {
      "href": "https://try.access.worldpay.com/payments/alternative/action/paypal/events/{encryptedParams}"
    },
    "curies": [
      {
        "name": "paypal",
        "href": "https://try.access.worldpay.com/rels/payments/alternative/action/paypal/dummyDoc/{rel}",
        "templated": true
      }
    ]
  }
}