Create a PayPal Order

POST 
/api/paypal_orders

Creates a new PayPal order and returns its ID.

Request

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

Body

required

referenceId stringrequired
description stringrequired
amount objectrequired
currencyCode string
value number
returnUrl urirequired
cancelUrl urirequired

Responses

201

Created - The request was processed successfully.

application/json

Schema

Schema

id string

Example (from schema)

{
  "id": "6MR709191W4328148"
}

400

Bad Request -- Your request is invalid.

401

Unauthorised -- Your access token is wrong.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

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

403

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

422

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

Loading...