Skip to main content

Create a payment request

POST 
/api/payment_requests

Requires the PAYPAL OAuth scope. Create a draft payment request for a selected contact. You can upload attachments before finalizing it via /payment_requests/{id}/activate.

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.

Body

required
    contactId integernull

    Possible values: > 0

    contact object

    Alternative recipient definition when contactId is not provided.

    name stringrequired
    countryCode stringrequired
    type string
    email email
    amount stringnullrequired

    Possible values: Value must match regular expression ^(\d+(\.\d{1,2})?)$

    currencyCode stringnullrequired

    Possible values: >= 3 characters and <= 3 characters

    invoiceReference stringnull

    Possible values: <= 255 characters

    invoiceDate stringnullrequired
    dueDate stringnullrequired
    message stringnull
    reminderEnabled boolean
    tagIds integer[]
    deliveryChannel stringrequired

    Possible values: [email_and_url, url_only]

    Default value: email_and_url

    email email

Responses​

Created - The request was processed successfully.

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

    Default value: true

    draft boolean
    hash string
    paymentPageUrl stringnull
Loading...