PayPal

Get the details of a PayPal Order.

Changed on
get/paypal/orders/{orderId}

Request

  • Base URL
    https://sandbox.comcarde.com/v1
  • Auth
    HTTP bearer

Path parameters

orderIdstring required

The unique identifier for the Order.

This can be sourced from the orderId field in the response we sent to you when creating the Order.

Response

OK

orderIdstring

The ID for the order.

intent'authorize' | 'capture'

Intent of the Order.

statusstring

The status of the order.

creationTimestampstring

The date and time that the order was created.

paymentIdstring

The ID of the payment associated with this Order.

Example response

{
  "orderId": "1000",
  "intent": "capture",
  "status": "CAPTURED",
  "creationTimestamp": "2022-01-30T10:10:10Z",
  "paymentSource": {
    "name": "John Smith",
    "email": "john.smith@example.com",
    "accountId": "QYR5Z8XDVJNXQ",
    "vaultId": "0tb28273r6584005e"
  },
  "purchaseUnits": [
    {
      "referenceId": "1000",
      "description": "1000",
      "customId": "123456789",
      "invoiceId": "987654321",
      "currencyCode": "GBP",
      "unitAmount": 1000,
      "unitTax": 100
    }
  ],
  "psp": {
    "name": "Checkout.com",
    "transactionId": "6418da68-0b3d-4409-ab14-1ceb752b0b1f",
    "switchAccountId": "switch-account-123",
    "provisionedUserId": "Vx0H4pdAtPCz",
    "additionalInfo": {
      "customerFirstName": "John",
      "customerLastName": "Smith",
      "customerDateOfBirth": "2000-01-01",
      "customerIpAddress": "123.100.100.200",
      "customerId": "de5d7b4a-9410-40e1-85fd-8ceee23c9fd0",
      "paysafecardCustomerId": "151743187547"
    },
    "rawPspResponses": [
      {
        "httpStatusCode": 200,
        "pspName": "Checkout.com",
        "headers": {
          "content-type": [
            "application/json"
          ]
        }
      }
    ]
  },
  "paymentId": "57f7f444-29ce-4230-8c7f-1c1fd85c8bc9"
}

Changes

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the ////// response's property format changed from ipv4 to no format for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      added the optional property ///////// to the response with the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the ////// response's property pattern was changed from ^$|^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$ to ^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|::(ffff(:0{1,4})?:)?((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))$ for the status