Upload payment request attachment

POST 
/api/payment_requests/:id/documents/upload

Requires the PAYPAL OAuth scope. Upload an attachment for an existing payment request draft.

Request

Path Parameters

id stringrequired

PaymentRequest identifier

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.

multipart/form-data

Body

file binaryrequired

Allowed file types: PDF, JPG, JPEG, PNG.

description string
type stringrequired

Responses

201

Created - The request was processed successfully.

application/json

Schema

Schema

object

Example (from schema)

{}

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...