Create a PayPal Order

Creates a new PayPal order and returns its ID.

Header Parameters

• Unique-Request-Id string

  Possible values: <= 50 characters

  An optional unique identifier for the request, limited to 50 characters. Used to track requests and prevent duplication.

application/json

Request Body required

• referenceId string required
• description string required
• amount object required

  currencyCode string

  value number
• returnUrl uri required
• cancelUrl uri required

Responses

• 201
• 400
• 401
• 403
• 422

---

Created - The request was processed successfully.

application/json

• Schema
• Example (from schema)

---

Schema

• id string

{
  "id": "6MR709191W4328148"
}

Bad Request -- Your request is invalid.

Unauthorised -- Your access token is wrong.

application/json

• Schema
• Example (from schema)

---

Schema

• type string
• title string
• detail string

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

Forbidden -- Access to the requested resource or action is forbidden.

application/json

• Schema
• Example (from schema)

---

Schema

• type string
• title string
• detail string

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

Unprocessable Content -- We could not process your request due to invalid data provided.

Loading...