PayPro
Powered by Redocly

PayPro API Reference (v1)

The PayPro API can be used to integrate your systems and applications with our services.

The API is organized around REST and has predictable, resource-oriented URLs, and uses HTTP response codes to indicate success or failure. JSON is returned for all API responses, including errors.

Authentication

The PayPro API uses API keys to authenticate requests. You can retrieve your API keys in the PayPro Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via the Authorization header. Provider your API key as the bearer token. Like: Authorization: Bearer pp_ffTBYqhJjsxs6CzdyDq6Mwza4UztqGin

All API requests must be made over HTTPS and with TLS 1.2+.

Errors

The PayPro API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate and error that failed given the information provided (e.g., a required parameter was omitted, a payment failed, etc.). Codes in the 5xx range indicate an error with PayPro's servers.

Pagination

Most top-level API resources have support for a list API method to enable bulk fetches. For instance you can list your Payment or Customer objects. These list API methods share a common structure.

The pagination is cursor based and if the results exceed the limit the API will return a next or prev attribute in the _links section. These can be used to continue with the results where prev will contain the previous entities and next will contain the next entities.

You can also specify a limit by setting the limit query parameter.

Payments

Retrieves a payment

get/payments/{id}

Retrieves a single payment based on the id.

Request
path Parameters
id
required
string
Responses
200

payment found

404

payment not found

Response samples
application/json
{
  • "id": "PPH25H07JYWLR7PA82",
  • "type": "payment",
  • "amount": 1000,
  • "description": "Test Payment",
  • "currency": "EUR",
  • "pay_method": {
    },
  • "state": "paid",
  • "refunded_amount": 0,
  • "return_url": "https://example.com/thank-you",
  • "cancel_url": "https://example.com/cancel",
  • "metadata": { },
  • "paid_at": "2023-06-30T12:44:35Z",
  • "created_at": "2023-06-30T12:40:10Z",
  • "_links": {}
}

Cancels a payment

delete/payments/{id}

Cancels a payment. It is possible to cancel payment only in open or initialiazed state.

Request
path Parameters
id
required
string
Responses
200

payment canceled

Response samples
application/json
{
  • "id": "PPH25H07JYWLR7PA82",
  • "type": "payment",
  • "amount": 1000,
  • "description": "Test Payment",
  • "currency": "EUR",
  • "pay_method": {
    },
  • "state": "paid",
  • "refunded_amount": 0,
  • "return_url": "https://example.com/thank-you",
  • "cancel_url": "https://example.com/cancel",
  • "metadata": { },
  • "paid_at": "2023-06-30T12:44:35Z",
  • "created_at": "2023-06-30T12:40:10Z",
  • "_links": {}
}

Retrieve a list of payments

get/payments

Retrieve a list of payments that have been created for your account. The payments are sorted, with the most recent first.

Responses
200

payments found

Response samples
application/json
{}

Creates a payment

post/payments

Creates a Payment object.

After you have created a Payment you can use the _links.checkout link to redirect your customer.

Request
Request Body schema: application/json
amount
required
integer

The amount that the customer will have to pay.

currency
required
string

The currency of the payment. Only 'EUR' is supported.

Value: "EUR"
description
required
string

The description of the payment. This will be shown to your customer and will be visible in the dashboard.

return_url
string or null <uri>

The URL where the customer will be send to after the payment has been processed.

cancel_url
string or null <uri>

The URL where the customer will be send to after the payment has been canceled by the customer.

pay_methods
Array of strings or null

The allowed pay methods of the payment. If only one pay method is specified, it will be set as the payment pay method.

Enum: "afterpay" "bancontact" "bank-transfer" "creditcard" "direct-debit" "ideal" "ideal-qr" "klarna-paynow" "paypal"
issuer
string or null

The issuer of the IDEAL payment.

Enum: "SNSBNL2A" "ASNBNL21" "ABNANL2A" "BUNQNL2A" "KNABNL2H" "RABONL2U" "REVOLT21" "RBRBNL21" "TRIONL2U" "FVLBNL22" "INGBNL2A" "BITSNL2A" "NTSBDEB1" "NNBANL2G"
metadata
object or null

You can put in random data that you like to save alongside the payment. When you fetch the payment this will be returned in the metadata field.

Responses
201

payment created

Request samples
application/json
{}
Response samples
application/json
{
  • "id": "PPH25H07JYWLR7PA82",
  • "type": "payment",
  • "amount": 1000,
  • "description": "Test Payment",
  • "currency": "EUR",
  • "pay_method": {
    },
  • "state": "paid",
  • "refunded_amount": 0,
  • "return_url": "https://example.com/thank-you",
  • "cancel_url": "https://example.com/cancel",
  • "metadata": { },
  • "paid_at": "2023-06-30T12:44:35Z",
  • "created_at": "2023-06-30T12:40:10Z",
  • "_links": {}
}

Retrieves a list of chargebacks that belong to this payment

get/payments/{id}/chargebacks

Retrieves a list of chargebacks that belong to this payment.

Request
path Parameters
id
required
string
Responses
200

chargebacks found

Response samples
application/json
{}

Retrieves a list of refunds that belong to this payment.

get/payments/{id}/refunds

Retrieves a list of refunds that belong to this payment.

Request
path Parameters
id
required
string
Responses
200

refunds found

Response samples
application/json
{}

Creates a refund for this payment.

post/payments/{id}/refunds

Creates a Refund object for this Payment.

Creating a refund will refund a certain amount back to the customer. This amount will be deducted from your balance.

You can choose to only refund a part of the total amount. You can do this multiple times, but the total refunded amount can't exceed the payment amount.

Some pay methods require additional information, like IBAN and account holder name, to be supplied.

Request
path Parameters
id
required
string
Request Body schema: application/json
amount
required
integer

The amount that will be refunded to the customer. This can be an amount lower than the total amount to do a partial refund. You can't refund more than the total amount of the original payment.

description
string or null
Default: "The description of the payment."

The description of the refund. This will be shown to your customer and will be visible in the dashboard.

reason
string or null

The reason for this refund.

account_holder_name
string or null

Name of the account holder of the account where the refund will be credited. This is a required field for the pay methods 'bancontact' and 'creditcard'. For other pay methods we will use the orginal customer information provided by the pay method to do the refund.

iban
string

IBAN of the account where the refund will be credited. required field for the pay methods 'bancontact' and 'creditcard'. For other pay methods we will use the orginal customer information provided by the pay method to do the refund.

Responses
201

refund created

Request samples
application/json
{
  • "amount": 1000,
  • "description": "Test Refund",
  • "reason": "Customer requested",
  • "account_holder_name": "John Doe",
  • "iban": "NL02ABNA0123456789"
}
Response samples
application/json
{}

Refunds

Retrieves a refund

get/refunds/{id}

Retrieves a single refund based on the id.

Request
path Parameters
id
required
string
Responses
200

refund found

404

refund not found

Response samples
application/json
{}

Cancels a refund

delete/refunds/{id}

Cancels a refund. It is possible to cancel refund only in open, pending or processing state.

Request
path Parameters
id
required
string
Responses
200

refund canceled

Response samples
application/json
{}

Retrieve a list of refunds

get/refunds

Retrieve a list of refunds that have been created for your account. The refunds are sorted, with the most recent first

Responses
200

refunds found

Response samples
application/json
{}

Chargebacks

Retrieves a chargeback

get/chargebacks/{id}

Retrieves a single chargeback based on the id.

Request
path Parameters
id
required
string
Responses
200

chargeback found

404

chargeback not found

Response samples
application/json
{}

Retrieve a list of chargebacks

get/chargebacks

Retrieve a list of chargebacks that have been created for your account. The chargebacks are sorted, with the most recent first

Responses
200

chargebacks found

Response samples
application/json
{}

Pay methods

Retrieve a list of pay methods

get/pay_methods

Retrieve a list of pay methods.

Responses
200

pay methods found

Response samples
application/json
{
  • "type": "list",
  • "data": [
    ],
  • "count": 0,
  • "_links": {}
}

Customers

Retrieves a customer

get/customers/{id}

Retrieves a single customer based on the id.

Request
path Parameters
id
required
string
Responses
200

customer found

404

customer not found

Response samples
application/json
{
  • "id": "CU7JRN6W6K3DA9",
  • "type": "customer",
  • "email": "customer@paypro.nl",
  • "first_name": "firstname",
  • "last_name": "name",
  • "address": "address 2",
  • "postal": "1234AA",
  • "city": "city",
  • "country": "NL",
  • "vat_number": "vatnumber",
  • "company_name": "PayPro",
  • "phone_number": "012345679",
  • "created_at": "2022-12-31T23:00:00Z",
  • "_links": {}
}

Updates a customer

patch/customers/{id}

Updates a Customer object. Returns the updated Customer.

Request
path Parameters
id
required
string
Request Body schema: application/json
email
string or null

Customer's email address

first_name
string or null

Customer's first name

last_name
string or null

Customer's last name

address
string or null

Customer's address

postal
string or null

Customer's postal code or ZIP

city
string or null

Customer's city

country
string or null

Customer's country in ISO-3166-1 alpha-2 format, example: 'NL'

vat_number
string or null

Customer's company vat number

company_name
string or null

Customer's company name

phone_number
string or null

Customer's phone number

Responses
200

customer found

404

customer not found

Request samples
application/json
{
  • "email": "customer@paypro.nl",
  • "first_name": "firstname",
  • "last_name": "name",
  • "address": "address 2",
  • "postal": "1234AA",
  • "city": "city",
  • "country": "NL",
  • "vat_number": "vatnumber",
  • "company_name": "PayPro",
  • "phone_number": "012345679"
}
Response samples
application/json
{
  • "id": "CU7JRN6W6K3DA9",
  • "type": "customer",
  • "email": "customer@paypro.nl",
  • "first_name": "firstname",
  • "last_name": "name",
  • "address": "address 2",
  • "postal": "1234AA",
  • "city": "city",
  • "country": "NL",
  • "vat_number": "vatnumber",
  • "company_name": "PayPro",
  • "phone_number": "012345679",
  • "created_at": "2022-12-31T23:00:00Z",
  • "_links": {}
}

Retrieves a list of customers

get/customers

Retrieve a list of customers that have been created for your account. The customers are sorted, with the most recent first.

Responses
200

customers found

Response samples
application/json
{
  • "type": "list",
  • "data": [
    ],
  • "count": 0,
  • "_links": {}
}

Creates a customer

post/customers

Creates a Customer object.

Request
Request Body schema: application/json
email
string or null

Customer's email address

first_name
string or null

Customer's first name

last_name
string or null

Customer's last name

address
string or null

Customer's address

postal
string or null

Customer's postal code or ZIP

city
string or null

Customer's city

country
string or null

Customer's country in ISO-3166-1 alpha-2 format, example: 'NL'

vat_number
string or null

Customer's company vat number

company_name
string or null

Customer's company name

phone_number
string or null

Customer's phone number

Responses
201

customer created

Request samples
application/json
{
  • "email": "customer@paypro.nl",
  • "first_name": "firstname",
  • "last_name": "name",
  • "address": "address 2",
  • "postal": "1234AA",
  • "city": "city",
  • "country": "NL",
  • "vat_number": "vatnumber",
  • "company_name": "PayPro",
  • "phone_number": "012345679"
}
Response samples
application/json
{
  • "id": "CU7JRN6W6K3DA9",
  • "type": "customer",
  • "email": "customer@paypro.nl",
  • "first_name": "firstname",
  • "last_name": "name",
  • "address": "address 2",
  • "postal": "1234AA",
  • "city": "city",
  • "country": "NL",
  • "vat_number": "vatnumber",
  • "company_name": "PayPro",
  • "phone_number": "012345679",
  • "created_at": "2022-12-31T23:00:00Z",
  • "_links": {}
}

Retrieves a list of subscriptions that belong to this customer

get/customers/{id}/subscriptions

Retrieves a list of subscriptions that belong to this customer.

Request
path Parameters
id
required
string
Responses
200

subscriptions found

404

customer not found

Response samples
application/json
{}

Mandates

Retrieves a mandate

get/mandates/{id}

Retrieves a single mandate based on the id.

Request
path Parameters
id
required
string
Responses
200

mandate found

404

payment not found

Response samples
application/json
{}

Retrieve a list of mandates

get/mandates

Retrieve a list of mandates that have been created for your account. The mandates are sorted, with the most recent first.

Responses
200

mandates found

Response samples
application/json
{}

Creates a mandate

post/mandates

Creates a Mandate object.

You can only create a mandate manually for 'direct-debit'. The other supported pay methods require authorization through a Payment.

Request
Request Body schema: application/json
customer
required
string

The reference of the Customer you want to create the mandate for.

pay_method
required
string

The payment method of the mandate. Only 'direct-debit' is supported.

Value: "direct-debit"
iban
string or null

When using 'direct-debit', this is the IBAN of the bank account.

account_holder_name
string or null

When using 'direct-debit', this is the name of the account holder.

Responses
201

mandate created

Request samples
application/json
{
  • "customer": "CUWSWVVPTL94VX",
  • "pay_method": "direct-debit",
  • "iban": "NL47ABNA0612205029",
  • "account_holder_name": "PayPro"
}
Response samples
application/json
{}

Subscriptions

Retrieves a subscription

get/subscriptions/{id}

Retrieves a single subscription based on the id.

Request
path Parameters
id
required
string
Responses
200

subscription found

404

subscription not found

Response samples
application/json
{
  • "id": "PSV1QACRO4DSMQT0KK",
  • "type": "subscription",
  • "description": "Test subscription",
  • "currency": "EUR",
  • "subscription_type": "direct_debit",
  • "state": "active",
  • "start_at": null,
  • "created_at": "2023-07-24T12:40:10Z",
  • "cancel_at": null,
  • "customer": "CU7JRN6W6K3DA9",
  • "mandate": "MD6ULYXJ4HP9RJ",
  • "scheduling": "automatic",
  • "period": {
    },
  • "first_period": {
    },
  • "payment_details": {
    },
  • "metadata": { },
  • "_links": {}
}

Updates a subscription

patch/subscriptions/{id}

Updates a Subscription object. Returns the updated Subscription

Request
path Parameters
id
required
string
Request Body schema: application/json
description
string

Description of the subscription. This will be shown to customers and in the PayPro dashboard

object

Settings for when new periods should be created and with which amounts. When the Subscription is active updates to these settings will only affect new periods.

object or null

Settings for when the first period should be created and with what amount. These settings can only be updated if the Subscription has not started yet.

Responses
200

subscription updated

404

subscription not found

Request samples
application/json
{
  • "description": "description",
  • "period": {
    }
}
Response samples
application/json
{
  • "id": "PSV1QACRO4DSMQT0KK",
  • "type": "subscription",
  • "description": "Test subscription",
  • "currency": "EUR",
  • "subscription_type": "direct_debit",
  • "state": "active",
  • "start_at": null,
  • "created_at": "2023-07-24T12:40:10Z",
  • "cancel_at": null,
  • "customer": "CU7JRN6W6K3DA9",
  • "mandate": "MD6ULYXJ4HP9RJ",
  • "scheduling": "automatic",
  • "period": {
    },
  • "first_period": {
    },
  • "payment_details": {
    },
  • "metadata": { },
  • "_links": {}
}

Cancels a subscription

delete/subscriptions/{id}

Cancels a subscription. A canceled subscription will no longer create new subscription periods.

It is not possible to resume a canceled subscription.

Request
path Parameters
id
required
string
Responses
200

subscription canceled

Response samples
application/json
{
  • "id": "PSV1QACRO4DSMQT0KK",
  • "type": "subscription",
  • "description": "Test subscription",
  • "currency": "EUR",
  • "subscription_type": "direct_debit",
  • "state": "active",
  • "start_at": null,
  • "created_at": "2023-07-24T12:40:10Z",
  • "cancel_at": null,
  • "customer": "CU7JRN6W6K3DA9",
  • "mandate": "MD6ULYXJ4HP9RJ",
  • "scheduling": "automatic",
  • "period": {
    },
  • "first_period": {
    },
  • "payment_details": {
    },
  • "metadata": { },
  • "_links": {}
}

Retrieves a list of subscriptions

get/subscriptions

Retrieve a list of subscriptions that have been created for your account. The subscriptions are sorted, with the most recent first.

Responses
200

subscriptions found

Response samples
application/json
{}

Creates a subscription

post/subscriptions

Creates a Subscription object.

After you created the subscription it will either be started immediately or at the start_date when a mandate was given. When pay_methods are given you need to redirect the customer to the checkout link in the links section.

Request
Request Body schema: application/json
customer
required
string

ID of the customer that subscribes

description
required
string

Description of the subscription. This will be shown to customers and in the PayPro dashboard

mandate
string or null

Mandate that will be used for the subscription. Using this will start the subscription immediately. Cannot be used together with the pay_methods field.

currency
required
string

The currency of the subscription. Only 'EUR' is supported

start_at
string or null

Date when the subscription will start. When left empty, it will start at creation

cancel_at
string or null

Date at which the subscription will be canceled. When left empty, the subscription will be active until manually canceled

pay_methods
Array of strings or null

Pay methods that can be used to start the subscription. Using this creates the subscription with the authorization flow and will start the subscription when the first payment is paid. Use the checkout link in the links field to redirect the customer. Cannot be used together with a mandate.

Enum: "bancontact" "bank-transfer" "creditcard" "direct-debit" "ideal" "ideal-qr" "klarna-paynow"
object

Fields to be passed to the authorization payment.

required
object

Settings for when new periods should be created and with which amounts

object or null

Settings for when the first period should be created and with what amount

metadata
object or null

You can put in random data that you like to save alongside the subscription. When you fetch the subscription this will be returned in the metadata field.

Responses
201

subscription created

Request samples
application/json
{
  • "customer": "CUW78XU8BYL8X6",
  • "mandate": "MD6ULYXJ4HP9RJ",
  • "description": "description",
  • "currency": "EUR",
  • "start_at": "2023-08-01",
  • "period": {
    }
}
Response samples
application/json
{
  • "id": "PSV1QACRO4DSMQT0KK",
  • "type": "subscription",
  • "description": "Test subscription",
  • "currency": "EUR",
  • "subscription_type": "direct_debit",
  • "state": "active",
  • "start_at": null,
  • "created_at": "2023-07-24T12:40:10Z",
  • "cancel_at": null,
  • "customer": "CU7JRN6W6K3DA9",
  • "mandate": "MD6ULYXJ4HP9RJ",
  • "scheduling": "automatic",
  • "period": {
    },
  • "first_period": {
    },
  • "payment_details": {
    },
  • "metadata": { },
  • "_links": {}
}

Pauses a subscription

post/subscriptions/{id}/pause

Pauses a subscription. A paused subscription will no longer create new subscription periods.

You can resume the subscription by calling the /subscriptions/:id/resume endpoint.

Request
path Parameters
id
required
string
Responses
200

subscription paused

Response samples
application/json
{
  • "id": "PSV1QACRO4DSMQT0KK",
  • "type": "subscription",
  • "description": "Test subscription",
  • "currency": "EUR",
  • "subscription_type": "direct_debit",
  • "state": "active",
  • "start_at": null,
  • "created_at": "2023-07-24T12:40:10Z",
  • "cancel_at": null,
  • "customer": "CU7JRN6W6K3DA9",
  • "mandate": "MD6ULYXJ4HP9RJ",
  • "scheduling": "automatic",
  • "period": {
    },
  • "first_period": {
    },
  • "payment_details": {
    },
  • "metadata": { },
  • "_links": {}
}

Resumes a paused subscription

post/subscriptions/{id}/resume

Resumes a paused subscription. The paused subscription will return to the active state and will resume creating new subscription periods.

It is not possible to resume a canceled subscription.

Request
path Parameters
id
required
string
Responses
200

subscription resumes

Response samples
application/json
{
  • "id": "PSV1QACRO4DSMQT0KK",
  • "type": "subscription",
  • "description": "Test subscription",
  • "currency": "EUR",
  • "subscription_type": "direct_debit",
  • "state": "active",
  • "start_at": null,
  • "created_at": "2023-07-24T12:40:10Z",
  • "cancel_at": null,
  • "customer": "CU7JRN6W6K3DA9",
  • "mandate": "MD6ULYXJ4HP9RJ",
  • "scheduling": "automatic",
  • "period": {
    },
  • "first_period": {
    },
  • "payment_details": {
    },
  • "metadata": { },
  • "_links": {}
}

Retrieves a list subscription periods that belong to this subscription

get/subscriptions/{id}/subscription_periods

Retrieves a list of subscription periods that belong to this subscription.

Request
path Parameters
id
required
string
Responses
200

subscription periods found

Response samples
application/json
{}

Create a next period for this subscription

post/subscriptions/{id}/subscription_periods

Create a next period for this subscription

Request
path Parameters
id
required
string
Request Body schema: application/json
amount
required
integer

The amount that the customer will have to pay in the next period.

description
string

Description of the subscription. This will be shown to customers and in the PayPro dashboard

Responses
201

subscription period created

404

subscription not found

Request samples
application/json
{
  • "amount": 1000
}
Response samples
application/json
{}

Subscription periods

Retrieves a subscription period

get/subscription_periods/{id}

Retrieves a single subscription period based on the id.

Request
path Parameters
id
required
string
Responses
200

subscription period found

404

subscription period not found

Response samples
application/json
{}

Retrieves a list of payments that belong to this subscription period

get/subscription_periods/{id}/payments

Retrieves a list of payments that belong to this subscription period.

Request
path Parameters
id
required
string
Responses
200

payments found

Response samples
application/json
{}

Installment plans

Retrieves a list of installment plans

get/installment_plans

Retrieve a list of installment plans that have been created for your account. The installment plans are sorted, with the most recent first.

Responses
200

installment plans found

Response samples
application/json
{}

Creates a installment plan

post/installment_plans

Creates a Installment plan object.

After you have created a Installment plan, it will start immediately when mandate is given. When pay_methods are given you need to redirect the customer to the checkout link in the links section.

Request
Request Body schema: application/json
customer
required
string

ID of the customer for installment plan

mandate
string

ID of the mandate for installment plan

description
required
string

Description of the installment plan. This will be shown to customers

currency
required
string

The currency of the installment plan. Only 'EUR' is supported

pay_methods
Array of strings or null

Pay methods that can be used to start the subscription. Using this creates the subscription with the authorization flow and will start the subscription when the first payment is paid. Use the checkout link in the links field to redirect the customer. Cannot be used together with a mandate.

Enum: "bancontact" "bank-transfer" "creditcard" "direct-debit" "ideal" "ideal-qr" "klarna-paynow"
object

Fields to be passed to the authorization payment.

required
object

Settings for when new periods should be created and with which amounts

object or null

Settings for when the first period should be created and with what amount

number_of_periods
required
integer

The number of installment plan periods.

metadata
object or null

You can put in random data that you like to save alongside the installment plan. When you fetch the installment plan this will be returned in the metadata field.

Responses
201

installment plan created

Request samples
application/json
{
  • "customer": "CUW78XU8BYL8X6",
  • "mandate": "MDGSPX6GXLMTLL",
  • "description": "description",
  • "currency": "EUR",
  • "period": {
    },
  • "number_of_periods": 5
}
Response samples
application/json
{}

Retrieves a installment plan

get/installment_plans/{id}

Retrieves a single installment plan based on the id.

Request
path Parameters
id
required
string
Responses
200

installment plan found

404

installment plan not found

Response samples
application/json
{}

Cancels a installment plan

delete/installment_plans/{id}

Cancels a installment plan. A canceled installment plan will no longer create new installment plan periods. It is not possible to resume a canceled installment plan.

Request
path Parameters
id
required
string
Responses
200

installment plan canceled

Response samples
application/json
{}

Retrieves a list installment plan periods that belong to this installment plan

get/installment_plans/{id}/installment_plan_periods

Retrieves a list of installment plan periods that belong to this installment plan.

Request
path Parameters
id
required
string
Responses
200

installment plan periods found

Response samples
application/json
{}

Pauses a installment plan

post/installment_plans/{id}/pause

Pauses a installment plan. A paused installment plan will no longer create new installment plan periods.

You can resume the installment plan by calling the /installment_plans/:id/resume endpoint.

Request
path Parameters
id
required
string
Responses
200

installment plan paused

Response samples
application/json
{}

Resumes a paused installment plan

post/installment_plans/{id}/resume

Resumes a paused installment plan. The paused installment plan will return to the active state and will resume creating new installment plan periods.

It is not possible to resume a canceled installment plan.

Request
path Parameters
id
required
string
Responses
200

installment plan resumes

Response samples
application/json
{}

Installment plan periods

Retrieves a installment plan period

get/installment_plan_periods/{id}

Retrieves a single installment plan period based on the id.

Request
path Parameters
id
required
string
Responses
200

installment plan period found

404

installment plan period not found

Response samples
application/json
{}

Retrieves a list of payments that belong to this installment plan period

get/installment_plan_periods/{id}/payments

Retrieves a list of payments that belong to this installment plan period.

Request
path Parameters
id
required
string
Responses
200

payments found

Response samples
application/json
{}

Events

Retrieves an event

get/events/{id}

Retrieves a single event based on the id.

Request
path Parameters
id
required
string
Responses
200

event found

404

payment not found

Response samples
application/json
{}

Retrieve a list of events

get/events

Retrieve a list of events that have been created for your account. The events are sorted, with the most recent first

Responses
200

events found

Response samples
application/json
{}

Webhooks

Retrieves a webhook

get/webhooks/{id}

Retrieves a single webhook based on the id.

Request
path Parameters
id
required
string
Responses
200

webhook found

404

webhook not found

Response samples
application/json
{}

Updates a webhook

patch/webhooks/{id}

Updates a Webhook object. Returns the updated Webhook

Request
path Parameters
id
required
string
Request Body schema: application/json
description
string or null

Description of the webhook. It describes what this webhook is used for.

name
string or null

Name of the webhook.

url
string or null <uri>

The URL of the webhook endpoint

active
boolean or null

When active is true this webhook endpoint will receive events.

Responses
200

webhook updated

404

webhook not found

Request samples
application/json
{}
Response samples
application/json
{}

Deletes a webhook

delete/webhooks/{id}

Deletes a webhook. A deleted webhook will no longer send events to the endpoint.

Request
path Parameters
id
required
string
Responses
200

webhook deleted

Response samples
application/json
{}

Retrieves a list of webhooks

get/webhooks

Retrieve a list of webhooks that have been created for your account. The webhooks are sorted, with the most recent first.

Responses
200

webhooks found

Response samples
application/json
{}

Creates a webhook

post/webhooks

Creates a Webhook object.

A webhook needs to have a name, description and a url. By default the Webhook will be active. You can add the parameter active to false to make it inactive.

Request
Request Body schema: application/json
description
string

Description of the webhook. It describes what this webhook is used for.

name
string

Name of the webhook.

url
string <uri>

The URL of the webhook endpoint

active
boolean or null
Default: true

When active is true this webhook endpoint will receive events.

Responses
201

webhook created

Request samples
application/json
{}
Response samples
application/json
{}