Retrieve a single payment request

GET 
/api/payment_requests/:id

Requires the PAYPAL OAuth scope. Retrieve details for a payment request created by your business partner.

Request

Path Parameters

id stringrequired

PaymentRequest identifier

Responses

200

OK - The request was processed successfully.

application/json

Schema

Schema

id integer
contactId integer
currencyCode string
amount string
invoiceReference stringnullable
invoiceDate stringnullable
dueDate stringnullable
message stringnullable
reminderEnabled boolean
tagIds integer[]
email stringnullable
pending boolean

Default value: true

draft boolean
hash string
paymentPageUrl stringnullable

Example (from schema)

{
  "id": 42,
  "contactId": 145,
  "currencyCode": "CHF",
  "amount": "5000.50",
  "invoiceReference": "Invoice INV-2026-001",
  "invoiceDate": "2026-04-21",
  "dueDate": "2026-05-01",
  "message": "Please settle this invoice until due date.",
  "reminderEnabled": true,
  "tagIds": [
    1,
    2,
    3
  ],
  "email": "recipient@example.com",
  "pending": true,
  "draft": false,
  "hash": "a5eb1c1f-a4ad-4a19-ad72-f57ba5acf795",
  "paymentPageUrl": "https://www.paypal.com/checkoutnow?token=XYZ"
}

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.

application/json

Schema

Schema

title stringnullable

A short, human-readable summary of the problem.

detail stringnullable

A human-readable explanation specific to this occurrence of the problem.

status numbernullable

Default value: 400

instance stringnullable

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

type string

A URI reference that identifies the problem type

Example (from schema)

{
  "title": "string",
  "detail": "string",
  "status": 400,
  "instance": "string",
  "type": "string"
}

404

Not Found -- The requested resource could not be found.

application/json

Schema

Schema

title stringnullable

A short, human-readable summary of the problem.

detail stringnullable

A human-readable explanation specific to this occurrence of the problem.

status numbernullable

Default value: 400

instance stringnullable

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

type string

A URI reference that identifies the problem type

Example (from schema)

{
  "title": "string",
  "detail": "string",
  "status": 400,
  "instance": "string",
  "type": "string"
}

Loading...