{"items":[{"type":"link","label":"PayPro API Reference","link":"/reference/api","routeSlug":"/reference/api","content":{"contentType":"overview","meta":{"name":"PayPro API Reference"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.paypro.nl"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"PayPro API Reference (v1)","showPageActions":true}],"sectionId":"/reference/api"}]}]}},{"type":"separator","label":"Payments","content":null},{"type":"group","label":"Payments","link":"/reference/api/payments","routeSlug":"/reference/api/payments","items":[{"label":"Retrieves a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/payments/retrievepayment","routeSlug":"/reference/api/payments/retrievepayment","metadata":{"seo":{"title":"Retrieves a payment","description":"Retrieves a single payment based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrievePayment","name":"Retrieves a payment","isWebhook":false,"pointer":"/paths/~1payments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single payment based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the payment","required":true}],"pointer":"/paths/~1payments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/payments/{id}","href":"payments/retrievepayment","openApiOperationId":"retrievePayment","summary":"Retrieves a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"payment found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment"}},"schemaId":"components/schemas/payment"},{"code":"404","description":"payment not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1payments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/retrievepayment"}],"panels":[]}]},"httpPath":"/payments/{id}"},{"label":"Cancels a payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/payments/cancelpayment","routeSlug":"/reference/api/payments/cancelpayment","metadata":{"seo":{"title":"Cancels a payment","description":"Cancels a payment. It is possible to cancel payment only in open or initialiazed state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelPayment","name":"Cancels a payment","isWebhook":false,"pointer":"/paths/~1payments~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels a payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a payment. It is possible to cancel payment only in open or initialiazed state."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the payment","required":true}],"pointer":"/paths/~1payments~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payments/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payments/{id}","href":"payments/cancelpayment","openApiOperationId":"cancelPayment","summary":"Cancels a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"payment canceled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment"}},"schemaId":"components/schemas/payment"}],"pointer":"/paths/~1payments~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/cancelpayment"}],"panels":[]}]},"httpPath":"/payments/{id}"},{"label":"Retrieve a list of payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/payments/retrievelistofpayments","routeSlug":"/reference/api/payments/retrievelistofpayments","metadata":{"seo":{"title":"Retrieve a list of payments","description":"Retrieve a list of payments that have been created for your account. The payments are sorted, with the most recent first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfPayments","name":"Retrieve a list of payments","isWebhook":false,"pointer":"/paths/~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of payments that have been created for your account. The payments are sorted, with the most recent first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payments","href":"payments/retrievelistofpayments","openApiOperationId":"retrieveListOfPayments","summary":"Retrieve a list of payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"payments found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19"}],"pointer":"/paths/~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/retrievelistofpayments"}],"panels":[]}]},"httpPath":"/payments"},{"label":"Creates a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/payments/createpayment","routeSlug":"/reference/api/payments/createpayment","metadata":{"seo":{"title":"Creates a payment","description":"Creates a Payment object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPayment","name":"Creates a payment","isWebhook":false,"pointer":"/paths/~1payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Payment object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After you have created a Payment you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links.checkout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link to redirect your customer."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_payment"}},"schemaId":"components/schemas/request_create_payment","pointer":"/paths/~1payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_payment"}},"responseCodes":["201"],"pointer":"/payments","href":"payments/createpayment","openApiOperationId":"createPayment","summary":"Creates a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_payment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_payment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"payment created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment"}},"schemaId":"components/schemas/payment"}],"pointer":"/paths/~1payments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/createpayment"}],"panels":[]}]},"httpPath":"/payments"},{"label":"Retrieves a list of chargebacks that belong to this payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/payments/retrievelistofchargebacksbypayment","routeSlug":"/reference/api/payments/retrievelistofchargebacksbypayment","metadata":{"seo":{"title":"Retrieves a list of chargebacks that belong to this payment","description":"Retrieves a list of chargebacks that belong to this payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfChargebacksByPayment","name":"Retrieves a list of chargebacks that belong to this payment","isWebhook":false,"pointer":"/paths/~1payments~1{id}~1chargebacks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of chargebacks that belong to this payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of chargebacks that belong to this payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the payment","required":true}],"pointer":"/paths/~1payments~1{id}~1chargebacks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{id}/chargebacks","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payments/{id}/chargebacks","href":"payments/retrievelistofchargebacksbypayment","openApiOperationId":"retrieveListOfChargebacksByPayment","summary":"Retrieves a list of chargebacks that belong to this payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"chargebacks found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20"}],"pointer":"/paths/~1payments~1{id}~1chargebacks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/retrievelistofchargebacksbypayment"}],"panels":[]}]},"httpPath":"/payments/{id}/chargebacks"},{"label":"Retrieves a list of refunds that belong to this payment.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/payments/retrievelistofrefundsbypayment","routeSlug":"/reference/api/payments/retrievelistofrefundsbypayment","metadata":{"seo":{"title":"Retrieves a list of refunds that belong to this payment.","description":"Retrieves a list of refunds that belong to this payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfRefundsByPayment","name":"Retrieves a list of refunds that belong to this payment.","isWebhook":false,"pointer":"/paths/~1payments~1{id}~1refunds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of refunds that belong to this payment.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of refunds that belong to this payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the payment","required":true}],"pointer":"/paths/~1payments~1{id}~1refunds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{id}/refunds","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payments/{id}/refunds","href":"payments/retrievelistofrefundsbypayment","openApiOperationId":"retrieveListOfRefundsByPayment","summary":"Retrieves a list of refunds that belong to this payment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"refunds found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"}],"pointer":"/paths/~1payments~1{id}~1refunds/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/retrievelistofrefundsbypayment"}],"panels":[]}]},"httpPath":"/payments/{id}/refunds"},{"label":"Creates a refund for this payment.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/payments/createrefundforpayment","routeSlug":"/reference/api/payments/createrefundforpayment","metadata":{"seo":{"title":"Creates a refund for this payment.","description":"Creates a Refund object for this Payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRefundForPayment","name":"Creates a refund for this payment.","isWebhook":false,"pointer":"/paths/~1payments~1{id}~1refunds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a refund for this payment.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Refund object for this Payment.\n\nCreating a refund will refund a certain amount back to the customer. This amount will be deducted from your balance.\n\nYou can choose to only refund a part of the total amount. You can do this multiple times, but the total refunded\namount can't exceed the payment amount.\n\nSome pay methods require additional information, like IBAN and account holder name, to be supplied.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the payment","required":true}],"pointer":"/paths/~1payments~1{id}~1refunds/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_refund"}},"schemaId":"components/schemas/request_create_refund","pointer":"/paths/~1payments~1{id}~1refunds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{id}/refunds","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_refund"}},"responseCodes":["201"],"pointer":"/payments/{id}/refunds","href":"payments/createrefundforpayment","openApiOperationId":"createRefundForPayment","summary":"Creates a refund for this payment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_refund","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_refund"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"refund created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refund"}},"schemaId":"components/schemas/refund"}],"pointer":"/paths/~1payments~1{id}~1refunds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/refund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refund"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/createrefundforpayment"}],"panels":[]}]},"httpPath":"/payments/{id}/refunds"}],"content":{"contentType":"group","meta":{"name":"Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is the core of the PayPro API. You can create payments to let a customer pay which ultimately transfers funds from them to you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows you to setup one-time payments, recurring payments, subscriptions or invoices."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/creating-payments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating payments guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see how you can implement payments."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payments/{id}","summary":"Retrieves a payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/retrievepayment","deprecated":false},{"title":"/payments/{id}","summary":"Cancels a payment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payments/cancelpayment","deprecated":false},{"title":"/payments","summary":"Retrieve a list of payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/retrievelistofpayments","deprecated":false},{"title":"/payments","summary":"Creates a payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/createpayment","deprecated":false},{"title":"/payments/{id}/chargebacks","summary":"Retrieves a list of chargebacks that belong to this payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/retrievelistofchargebacksbypayment","deprecated":false},{"title":"/payments/{id}/refunds","summary":"Retrieves a list of refunds that belong to this payment.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/retrievelistofrefundsbypayment","deprecated":false},{"title":"/payments/{id}/refunds","summary":"Creates a refund for this payment.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/createrefundforpayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Refunds","link":"/reference/api/refunds","routeSlug":"/reference/api/refunds","items":[{"label":"Retrieves a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/refunds/retrieverefund","routeSlug":"/reference/api/refunds/retrieverefund","metadata":{"seo":{"title":"Retrieves a refund","description":"Retrieves a single refund based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveRefund","name":"Retrieves a refund","isWebhook":false,"pointer":"/paths/~1refunds~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single refund based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the refund","required":true}],"pointer":"/paths/~1refunds~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refunds/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/refunds/{id}","href":"refunds/retrieverefund","openApiOperationId":"retrieveRefund","summary":"Retrieves a refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"refund found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refund"}},"schemaId":"components/schemas/refund"},{"code":"404","description":"refund not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1refunds~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/refund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refund"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/retrieverefund"}],"panels":[]}]},"httpPath":"/refunds/{id}"},{"label":"Cancels a refund","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/refunds/cancelrefund","routeSlug":"/reference/api/refunds/cancelrefund","metadata":{"seo":{"title":"Cancels a refund","description":"Cancels a refund. It is possible to cancel refund only in open, pending or processing state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelRefund","name":"Cancels a refund","isWebhook":false,"pointer":"/paths/~1refunds~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels a refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a refund. It is possible to cancel refund only in open, pending or processing state."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the refund","required":true}],"pointer":"/paths/~1refunds~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/refunds/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/refunds/{id}","href":"refunds/cancelrefund","openApiOperationId":"cancelRefund","summary":"Cancels a refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"refund canceled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refund"}},"schemaId":"components/schemas/refund"}],"pointer":"/paths/~1refunds~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/refund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/refund"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/cancelrefund"}],"panels":[]}]},"httpPath":"/refunds/{id}"},{"label":"Retrieve a list of refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/refunds/retrievelistofrefunds","routeSlug":"/reference/api/refunds/retrievelistofrefunds","metadata":{"seo":{"title":"Retrieve a list of refunds","description":"Retrieve a list of refunds that have been created for your account. The refunds are sorted, with the most recent first"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfRefunds","name":"Retrieve a list of refunds","isWebhook":false,"pointer":"/paths/~1refunds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of refunds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of refunds that have been created for your account. The refunds are sorted, with the most recent first"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refunds","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/refunds","href":"refunds/retrievelistofrefunds","openApiOperationId":"retrieveListOfRefunds","summary":"Retrieve a list of refunds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"refunds found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"}],"pointer":"/paths/~1refunds/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/retrievelistofrefunds"}],"panels":[]}]},"httpPath":"/refunds"}],"content":{"contentType":"group","meta":{"name":"Refunds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refunds","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunds allow you to return funds to your customer. These funds are deducted from your PayPro balance and are refunded to the card, bank account or wallet used in the initial payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create refunds yourself or in some cases the customer can initiate a refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on how to manage and create refunds."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/refunds/{id}","summary":"Retrieves a refund","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/retrieverefund","deprecated":false},{"title":"/refunds/{id}","summary":"Cancels a refund","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/refunds/cancelrefund","deprecated":false},{"title":"/refunds","summary":"Retrieve a list of refunds","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/retrievelistofrefunds","deprecated":false}]}]}]}]}},{"type":"group","label":"Chargebacks","link":"/reference/api/chargebacks","routeSlug":"/reference/api/chargebacks","items":[{"label":"Retrieves a chargeback","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/chargebacks/retrievechargeback","routeSlug":"/reference/api/chargebacks/retrievechargeback","metadata":{"seo":{"title":"Retrieves a chargeback","description":"Retrieves a single chargeback based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveChargeback","name":"Retrieves a chargeback","isWebhook":false,"pointer":"/paths/~1chargebacks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a chargeback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single chargeback based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the chargeback","required":true}],"pointer":"/paths/~1chargebacks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chargebacks/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/chargebacks/{id}","href":"chargebacks/retrievechargeback","openApiOperationId":"retrieveChargeback","summary":"Retrieves a chargeback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"chargeback found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/chargeback"}},"schemaId":"components/schemas/chargeback"},{"code":"404","description":"chargeback not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1chargebacks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/chargeback","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/chargeback"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chargebacks/retrievechargeback"}],"panels":[]}]},"httpPath":"/chargebacks/{id}"},{"label":"Retrieve a list of chargebacks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/chargebacks/retrievelistofchargebacks","routeSlug":"/reference/api/chargebacks/retrievelistofchargebacks","metadata":{"seo":{"title":"Retrieve a list of chargebacks","description":"Retrieve a list of chargebacks that have been created for your account. The chargebacks are sorted, with the most recent first"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfChargebacks","name":"Retrieve a list of chargebacks","isWebhook":false,"pointer":"/paths/~1chargebacks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of chargebacks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of chargebacks that have been created for your account. The chargebacks are sorted, with the most recent first"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chargebacks","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/chargebacks","href":"chargebacks/retrievelistofchargebacks","openApiOperationId":"retrieveListOfChargebacks","summary":"Retrieve a list of chargebacks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"chargebacks found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20"}],"pointer":"/paths/~1chargebacks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chargebacks/retrievelistofchargebacks"}],"panels":[]}]},"httpPath":"/chargebacks"}],"content":{"contentType":"group","meta":{"name":"Chargebacks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chargebacks","showPageActions":true},{"nodeType":"markdoc","content":"Chargebacks are created by our system when a customer files a dispute and initiates a chargeback. For example this can happen when the customer does not receive the product bought.\n\nOnly certain  pay methods have chargebacks like credit card and SEPA Direct Debit. Once the customer initiates a chargeback we will create a chargeback object and notify you through our webhooks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/chargebacks/{id}","summary":"Retrieves a chargeback","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chargebacks/retrievechargeback","deprecated":false},{"title":"/chargebacks","summary":"Retrieve a list of chargebacks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chargebacks/retrievelistofchargebacks","deprecated":false}]}]}]}]}},{"type":"group","label":"Pay methods","link":"/reference/api/pay-methods","routeSlug":"/reference/api/pay-methods","items":[{"label":"Retrieve a list of pay methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/pay-methods/retrievelistofpaymethods","routeSlug":"/reference/api/pay-methods/retrievelistofpaymethods","metadata":{"seo":{"title":"Retrieve a list of pay methods","description":"Retrieve a list of pay methods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfPayMethods","name":"Retrieve a list of pay methods","isWebhook":false,"pointer":"/paths/~1pay_methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of pay methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of pay methods."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pay_methods","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/pay_methods","href":"pay-methods/retrievelistofpaymethods","openApiOperationId":"retrieveListOfPayMethods","summary":"Retrieve a list of pay methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"pay methods found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"}],"pointer":"/paths/~1pay_methods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pay-methods/retrievelistofpaymethods"}],"panels":[]}]},"httpPath":"/pay_methods"}],"content":{"contentType":"group","meta":{"name":"Pay methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pay methods","showPageActions":true},{"nodeType":"markdoc","content":"Pay method endpoints can be used to retrieve all available payment methods for your account.\n\nThe pay method object contains information about the pay method for instance the minimum and maximum amount or which currencies are allowed."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pay_methods","summary":"Retrieve a list of pay methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pay-methods/retrievelistofpaymethods","deprecated":false}]}]}]}]}},{"type":"separator","label":"Customers","content":null},{"type":"group","label":"Customers","link":"/reference/api/customers","routeSlug":"/reference/api/customers","items":[{"label":"Retrieves a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/customers/retrievecustomer","routeSlug":"/reference/api/customers/retrievecustomer","metadata":{"seo":{"title":"Retrieves a customer","description":"Retrieves a single customer based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveCustomer","name":"Retrieves a customer","isWebhook":false,"pointer":"/paths/~1customers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single customer based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the customer","required":true}],"pointer":"/paths/~1customers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/customers/{id}","href":"customers/retrievecustomer","openApiOperationId":"retrieveCustomer","summary":"Retrieves a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"customer found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customer"}},"schemaId":"components/schemas/customer"},{"code":"404","description":"customer not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1customers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customer"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/retrievecustomer"}],"panels":[]}]},"httpPath":"/customers/{id}"},{"label":"Updates a customer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/customers/updatecustomer","routeSlug":"/reference/api/customers/updatecustomer","metadata":{"seo":{"title":"Updates a customer","description":"Updates a Customer object. Returns the updated Customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomer","name":"Updates a customer","isWebhook":false,"pointer":"/paths/~1customers~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a Customer object. Returns the updated Customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the customer","required":true}],"pointer":"/paths/~1customers~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_customer"}},"schemaId":"components/schemas/request_create_customer","pointer":"/paths/~1customers~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/customers/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_customer"}},"responseCodes":["200","404"],"pointer":"/customers/{id}","href":"customers/updatecustomer","openApiOperationId":"updateCustomer","summary":"Updates a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_customer","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_customer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"customer found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customer"}},"schemaId":"components/schemas/customer"},{"code":"404","description":"customer not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1customers~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customer"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/updatecustomer"}],"panels":[]}]},"httpPath":"/customers/{id}"},{"label":"Retrieves a list of customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/customers/retrievelistofcustomers","routeSlug":"/reference/api/customers/retrievelistofcustomers","metadata":{"seo":{"title":"Retrieves a list of customers","description":"Retrieve a list of customers that have been created for your account. The customers are sorted, with the most recent first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfCustomers","name":"Retrieves a list of customers","isWebhook":false,"pointer":"/paths/~1customers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of customers that have been created for your account. The customers are sorted, with the most recent first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/customers","href":"customers/retrievelistofcustomers","openApiOperationId":"retrieveListOfCustomers","summary":"Retrieves a list of customers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"customers found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"}],"pointer":"/paths/~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/retrievelistofcustomers"}],"panels":[]}]},"httpPath":"/customers"},{"label":"Creates a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/customers/createcustomer","routeSlug":"/reference/api/customers/createcustomer","metadata":{"seo":{"title":"Creates a customer","description":"Creates a Customer object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomer","name":"Creates a customer","isWebhook":false,"pointer":"/paths/~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Customer object."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_customer"}},"schemaId":"components/schemas/request_create_customer","pointer":"/paths/~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_customer"}},"responseCodes":["201"],"pointer":"/customers","href":"customers/createcustomer","openApiOperationId":"createCustomer","summary":"Creates a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_customer","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_customer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"customer created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customer"}},"schemaId":"components/schemas/customer"}],"pointer":"/paths/~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/customer"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/createcustomer"}],"panels":[]}]},"httpPath":"/customers"},{"label":"Retrieves a list of subscriptions that belong to this customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/customers/retrievelistofsubscriptionsbycustomer","routeSlug":"/reference/api/customers/retrievelistofsubscriptionsbycustomer","metadata":{"seo":{"title":"Retrieves a list of subscriptions that belong to this customer","description":"Retrieves a list of subscriptions that belong to this customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfSubscriptionsByCustomer","name":"Retrieves a list of subscriptions that belong to this customer","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of subscriptions that belong to this customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of subscriptions that belong to this customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the customer","required":true}],"pointer":"/paths/~1customers~1{id}~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{id}/subscriptions","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/customers/{id}/subscriptions","href":"customers/retrievelistofsubscriptionsbycustomer","openApiOperationId":"retrieveListOfSubscriptionsByCustomer","summary":"Retrieves a list of subscriptions that belong to this customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"subscriptions found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24"},{"code":"404","description":"customer not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1customers~1{id}~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/retrievelistofsubscriptionsbycustomer"}],"panels":[]}]},"httpPath":"/customers/{id}/subscriptions"},{"label":"Retrieves a list of mandates that belong to this customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/customers/retrievelistofmandatesbycustomer","routeSlug":"/reference/api/customers/retrievelistofmandatesbycustomer","metadata":{"seo":{"title":"Retrieves a list of mandates that belong to this customer","description":"Retrieves a list of mandates that belong to this customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfMandatesByCustomer","name":"Retrieves a list of mandates that belong to this customer","isWebhook":false,"pointer":"/paths/~1customers~1{id}~1mandates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of mandates that belong to this customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of mandates that belong to this customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the customer","required":true}],"pointer":"/paths/~1customers~1{id}~1mandates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{id}/mandates","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/customers/{id}/mandates","href":"customers/retrievelistofmandatesbycustomer","openApiOperationId":"retrieveListOfMandatesByCustomer","summary":"Retrieves a list of mandates that belong to this customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"mandates found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25"},{"code":"404","description":"customer not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1customers~1{id}~1mandates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/retrievelistofmandatesbycustomer"}],"panels":[]}]},"httpPath":"/customers/{id}/mandates"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers are a representation of your customers. These are used to get better insight in your PayPro payments for instance when searching for a customer name in our dashboard."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers can be "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/customers/createcustomer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly through the API or are created by the system when a payment is paid and no existing customer is associated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring payments and subscriptions it is mandatory to create a customer. This allows us to manage "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/mandates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mandates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/payments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the customer level."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customer does not require any customer information, but we recommend to atleast provide a name or email. This makes it easier to manage your customers and payments in the PayPro dashboard."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To see how you can use customers see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customers/{id}","summary":"Retrieves a customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/retrievecustomer","deprecated":false},{"title":"/customers/{id}","summary":"Updates a customer","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customers/updatecustomer","deprecated":false},{"title":"/customers","summary":"Retrieves a list of customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/retrievelistofcustomers","deprecated":false},{"title":"/customers","summary":"Creates a customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/createcustomer","deprecated":false},{"title":"/customers/{id}/subscriptions","summary":"Retrieves a list of subscriptions that belong to this customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/retrievelistofsubscriptionsbycustomer","deprecated":false},{"title":"/customers/{id}/mandates","summary":"Retrieves a list of mandates that belong to this customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/retrievelistofmandatesbycustomer","deprecated":false}]}]}]}]}},{"type":"group","label":"Mandates","link":"/reference/api/mandates","routeSlug":"/reference/api/mandates","items":[{"label":"Retrieves a mandate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/mandates/retrievemandate","routeSlug":"/reference/api/mandates/retrievemandate","metadata":{"seo":{"title":"Retrieves a mandate","description":"Retrieves a single mandate based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveMandate","name":"Retrieves a mandate","isWebhook":false,"pointer":"/paths/~1mandates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a mandate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single mandate based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the mandate","required":true}],"pointer":"/paths/~1mandates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/mandates/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/mandates/{id}","href":"mandates/retrievemandate","openApiOperationId":"retrieveMandate","summary":"Retrieves a mandate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"mandate found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mandate"}},"schemaId":"components/schemas/mandate"},{"code":"404","description":"payment not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1mandates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/mandate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mandate"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mandates/retrievemandate"}],"panels":[]}]},"httpPath":"/mandates/{id}"},{"label":"Retrieve a list of mandates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/mandates/retrievelistofmandates","routeSlug":"/reference/api/mandates/retrievelistofmandates","metadata":{"seo":{"title":"Retrieve a list of mandates","description":"Retrieve a list of mandates that have been created for your account. The mandates are sorted, with the most recent first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfMandates","name":"Retrieve a list of mandates","isWebhook":false,"pointer":"/paths/~1mandates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of mandates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of mandates that have been created for your account. The mandates are sorted, with the most recent first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/mandates","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/mandates","href":"mandates/retrievelistofmandates","openApiOperationId":"retrieveListOfMandates","summary":"Retrieve a list of mandates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"mandates found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25"}],"pointer":"/paths/~1mandates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mandates/retrievelistofmandates"}],"panels":[]}]},"httpPath":"/mandates"},{"label":"Creates a mandate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/mandates/createmandate","routeSlug":"/reference/api/mandates/createmandate","metadata":{"seo":{"title":"Creates a mandate","description":"Creates a Mandate object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMandate","name":"Creates a mandate","isWebhook":false,"pointer":"/paths/~1mandates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a mandate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Mandate object.\n\nYou can only create a mandate manually for 'direct-debit'. The other supported pay methods\nrequire authorization through a Payment.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_mandate"}},"schemaId":"components/schemas/request_create_mandate","pointer":"/paths/~1mandates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/mandates","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_mandate"}},"responseCodes":["201"],"pointer":"/mandates","href":"mandates/createmandate","openApiOperationId":"createMandate","summary":"Creates a mandate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_mandate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_mandate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"mandate created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mandate"}},"schemaId":"components/schemas/mandate"}],"pointer":"/paths/~1mandates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/mandate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mandate"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mandates/createmandate"}],"panels":[]}]},"httpPath":"/mandates"}],"content":{"contentType":"group","meta":{"name":"Mandates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mandates","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Mandate symbolizes the permission the customer gave you to charge their payment method. This is used to setup recurring payments and subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandates can be created directly for some payment types like \"direct-debit\" or require an authorization payment which is generally the first payment when setting up the recurring payments or subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/recurring-payments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring payments guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for how to use mandates."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/mandates/{id}","summary":"Retrieves a mandate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mandates/retrievemandate","deprecated":false},{"title":"/mandates","summary":"Retrieve a list of mandates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mandates/retrievelistofmandates","deprecated":false},{"title":"/mandates","summary":"Creates a mandate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mandates/createmandate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Recurring","content":null},{"type":"group","label":"Subscriptions","link":"/reference/api/subscriptions","routeSlug":"/reference/api/subscriptions","items":[{"label":"Retrieves a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscriptions/retrievesubscription","routeSlug":"/reference/api/subscriptions/retrievesubscription","metadata":{"seo":{"title":"Retrieves a subscription","description":"Retrieves a single subscription based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveSubscription","name":"Retrieves a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single subscription based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the subscription","required":true}],"pointer":"/paths/~1subscriptions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/subscriptions/{id}","href":"subscriptions/retrievesubscription","openApiOperationId":"retrieveSubscription","summary":"Retrieves a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"subscription found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}},"schemaId":"components/schemas/subscription"},{"code":"404","description":"subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1subscriptions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/retrievesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Updates a subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscriptions/updatesubscription","routeSlug":"/reference/api/subscriptions/updatesubscription","metadata":{"seo":{"title":"Updates a subscription","description":"Updates a Subscription object. Returns the updated Subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscription","name":"Updates a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a Subscription object. Returns the updated Subscription"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the subscription","required":true}],"pointer":"/paths/~1subscriptions~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_update_subscription"}},"schemaId":"components/schemas/request_update_subscription","pointer":"/paths/~1subscriptions~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/subscriptions/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_update_subscription"}},"responseCodes":["200","404"],"pointer":"/subscriptions/{id}","href":"subscriptions/updatesubscription","openApiOperationId":"updateSubscription","summary":"Updates a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_update_subscription","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_update_subscription"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"subscription updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}},"schemaId":"components/schemas/subscription"},{"code":"404","description":"subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1subscriptions~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/updatesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Cancels a subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscriptions/cancelsubscription","routeSlug":"/reference/api/subscriptions/cancelsubscription","metadata":{"seo":{"title":"Cancels a subscription","description":"Cancels a subscription. A canceled subscription will no longer create new subscription periods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelSubscription","name":"Cancels a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a subscription. A canceled subscription will no longer create new subscription periods.\n\nIt is not possible to resume a canceled subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the subscription","required":true}],"pointer":"/paths/~1subscriptions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriptions/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/subscriptions/{id}","href":"subscriptions/cancelsubscription","openApiOperationId":"cancelSubscription","summary":"Cancels a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"subscription canceled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}},"schemaId":"components/schemas/subscription"}],"pointer":"/paths/~1subscriptions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/cancelsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Retrieves a list of subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscriptions/retrievelistofsubscriptions","routeSlug":"/reference/api/subscriptions/retrievelistofsubscriptions","metadata":{"seo":{"title":"Retrieves a list of subscriptions","description":"Retrieve a list of subscriptions that have been created for your account. The subscriptions are sorted, with the most recent first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfSubscriptions","name":"Retrieves a list of subscriptions","isWebhook":false,"pointer":"/paths/~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of subscriptions that have been created for your account. The subscriptions are sorted, with the most recent first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/subscriptions","href":"subscriptions/retrievelistofsubscriptions","openApiOperationId":"retrieveListOfSubscriptions","summary":"Retrieves a list of subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"subscriptions found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24"}],"pointer":"/paths/~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/retrievelistofsubscriptions"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Creates a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscriptions/createsubscription","routeSlug":"/reference/api/subscriptions/createsubscription","metadata":{"seo":{"title":"Creates a subscription","description":"Creates a Subscription object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscription","name":"Creates a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Subscription object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_subscription"}},"schemaId":"components/schemas/request_create_subscription","pointer":"/paths/~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_subscription"}},"responseCodes":["201"],"pointer":"/subscriptions","href":"subscriptions/createsubscription","openApiOperationId":"createSubscription","summary":"Creates a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_subscription","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_subscription"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"subscription created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}},"schemaId":"components/schemas/subscription"}],"pointer":"/paths/~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/createsubscription"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Pauses a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscriptions/pausesubscription","routeSlug":"/reference/api/subscriptions/pausesubscription","metadata":{"seo":{"title":"Pauses a subscription","description":"Pauses a subscription. A paused subscription will no longer create new subscription periods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pauseSubscription","name":"Pauses a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1pause/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pauses a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Pauses a subscription. A paused subscription will no longer create new subscription periods.\n\nYou can resume the subscription by calling the /subscriptions/:id/resume endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the subscription","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1pause/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/pause","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/subscriptions/{id}/pause","href":"subscriptions/pausesubscription","openApiOperationId":"pauseSubscription","summary":"Pauses a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"subscription paused","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}},"schemaId":"components/schemas/subscription"}],"pointer":"/paths/~1subscriptions~1{id}~1pause/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/pausesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/pause"},{"label":"Resumes a paused subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscriptions/resumesubscription","routeSlug":"/reference/api/subscriptions/resumesubscription","metadata":{"seo":{"title":"Resumes a paused subscription","description":"Resumes a paused subscription. The paused subscription will return to the active state and will resume creating new subscription periods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resumeSubscription","name":"Resumes a paused subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1resume/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resumes a paused subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resumes a paused subscription. The paused subscription will return to the active state and will resume creating new subscription periods.\n\nIt is not possible to resume a canceled subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the subscription","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1resume/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/resume","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/subscriptions/{id}/resume","href":"subscriptions/resumesubscription","openApiOperationId":"resumeSubscription","summary":"Resumes a paused subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"subscription resumes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}},"schemaId":"components/schemas/subscription"}],"pointer":"/paths/~1subscriptions~1{id}~1resume/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/resumesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/resume"},{"label":"Retrieves a list subscription periods that belong to this subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscriptions/retrievelistofsubscriptionperiodsbysubscription","routeSlug":"/reference/api/subscriptions/retrievelistofsubscriptionperiodsbysubscription","metadata":{"seo":{"title":"Retrieves a list subscription periods that belong to this subscription","description":"Retrieves a list of subscription periods that belong to this subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfSubscriptionPeriodsBySubscription","name":"Retrieves a list subscription periods that belong to this subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1subscription_periods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list subscription periods that belong to this subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of subscription periods that belong to this subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the subscription","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1subscription_periods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{id}/subscription_periods","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/subscriptions/{id}/subscription_periods","href":"subscriptions/retrievelistofsubscriptionperiodsbysubscription","openApiOperationId":"retrieveListOfSubscriptionPeriodsBySubscription","summary":"Retrieves a list subscription periods that belong to this subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"subscription periods found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"}],"pointer":"/paths/~1subscriptions~1{id}~1subscription_periods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/retrievelistofsubscriptionperiodsbysubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/subscription_periods"},{"label":"Create a next period for this subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscriptions/createsubscriptionperiod","routeSlug":"/reference/api/subscriptions/createsubscriptionperiod","metadata":{"seo":{"title":"Create a next period for this subscription","description":"Create a next period for this subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateSubscriptionPeriod","name":"Create a next period for this subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}~1subscription_periods/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a next period for this subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a next period for this subscription"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the subscription","required":true}],"pointer":"/paths/~1subscriptions~1{id}~1subscription_periods/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_subscription_period"}},"schemaId":"components/schemas/request_create_subscription_period","pointer":"/paths/~1subscriptions~1{id}~1subscription_periods/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}/subscription_periods","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_subscription_period"}},"responseCodes":["201","404"],"pointer":"/subscriptions/{id}/subscription_periods","href":"subscriptions/createsubscriptionperiod","openApiOperationId":"CreateSubscriptionPeriod","summary":"Create a next period for this subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_subscription_period","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_subscription_period"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"subscription period created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_period"}},"schemaId":"components/schemas/subscription_period"},{"code":"404","description":"subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1subscriptions~1{id}~1subscription_periods/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/subscription_period","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_period"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/createsubscriptionperiod"}],"panels":[]}]},"httpPath":"/subscriptions/{id}/subscription_periods"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions are the easiest way to setup and schedule recurring payments. You provide us the amounts and intervals and PayPro will manage the full life-cycle of the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each interval a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/subscription-periods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/payments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be created which will charge the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These subscriptions can be managed through the API or in our dashboard and also includes optional invoicing, debtor management and other features."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" how to setup and manage your subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is also possible to create the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/subscription-periods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" yourself which we call an \"on-demand\" subscription check our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/on-demand-subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On-demand subscriptions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" how to do this."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriptions/{id}","summary":"Retrieves a subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/retrievesubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Updates a subscription","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subscriptions/updatesubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Cancels a subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/cancelsubscription","deprecated":false},{"title":"/subscriptions","summary":"Retrieves a list of subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/retrievelistofsubscriptions","deprecated":false},{"title":"/subscriptions","summary":"Creates a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/createsubscription","deprecated":false},{"title":"/subscriptions/{id}/pause","summary":"Pauses a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/pausesubscription","deprecated":false},{"title":"/subscriptions/{id}/resume","summary":"Resumes a paused subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/resumesubscription","deprecated":false},{"title":"/subscriptions/{id}/subscription_periods","summary":"Retrieves a list subscription periods that belong to this subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/retrievelistofsubscriptionperiodsbysubscription","deprecated":false},{"title":"/subscriptions/{id}/subscription_periods","summary":"Create a next period for this subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/createsubscriptionperiod","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscription periods","link":"/reference/api/subscription-periods","routeSlug":"/reference/api/subscription-periods","items":[{"label":"Retrieves a subscription period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscription-periods/retrievesubscriptionperiod","routeSlug":"/reference/api/subscription-periods/retrievesubscriptionperiod","metadata":{"seo":{"title":"Retrieves a subscription period","description":"Retrieves a single subscription period based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveSubscriptionPeriod","name":"Retrieves a subscription period","isWebhook":false,"pointer":"/paths/~1subscription_periods~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a subscription period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single subscription period based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the subscription period","required":true}],"pointer":"/paths/~1subscription_periods~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription_periods/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/subscription_periods/{id}","href":"subscription-periods/retrievesubscriptionperiod","openApiOperationId":"retrieveSubscriptionPeriod","summary":"Retrieves a subscription period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"subscription period found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_period"}},"schemaId":"components/schemas/subscription_period"},{"code":"404","description":"subscription period not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1subscription_periods~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_period","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_period"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-periods/retrievesubscriptionperiod"}],"panels":[]}]},"httpPath":"/subscription_periods/{id}"},{"label":"Retrieves a list of payments that belong to this subscription period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/subscription-periods/retrievelistofpaymentsbysubscriptionperiod","routeSlug":"/reference/api/subscription-periods/retrievelistofpaymentsbysubscriptionperiod","metadata":{"seo":{"title":"Retrieves a list of payments that belong to this subscription period","description":"Retrieves a list of payments that belong to this subscription period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfPaymentsBySubscriptionPeriod","name":"Retrieves a list of payments that belong to this subscription period","isWebhook":false,"pointer":"/paths/~1subscription_periods~1{id}~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of payments that belong to this subscription period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of payments that belong to this subscription period."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the subscription period","required":true}],"pointer":"/paths/~1subscription_periods~1{id}~1payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription_periods/{id}/payments","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/subscription_periods/{id}/payments","href":"subscription-periods/retrievelistofpaymentsbysubscriptionperiod","openApiOperationId":"retrieveListOfPaymentsBySubscriptionPeriod","summary":"Retrieves a list of payments that belong to this subscription period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"payments found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19"}],"pointer":"/paths/~1subscription_periods~1{id}~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-periods/retrievelistofpaymentsbysubscriptionperiod"}],"panels":[]}]},"httpPath":"/subscription_periods/{id}/payments"}],"content":{"contentType":"group","meta":{"name":"Subscription periods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription periods","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Subscription period represents a period in a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". These are created by the system at the interval you specified or by yourself when using an \"on-demand\" subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/payments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created to charge the customer is associated with the subscription period as well as other payments that might happen if the first one fails or when a customer repays after a chargeback."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscription_periods/{id}","summary":"Retrieves a subscription period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-periods/retrievesubscriptionperiod","deprecated":false},{"title":"/subscription_periods/{id}/payments","summary":"Retrieves a list of payments that belong to this subscription period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-periods/retrievelistofpaymentsbysubscriptionperiod","deprecated":false}]}]}]}]}},{"type":"group","label":"Installment plans","link":"/reference/api/installment-plans","routeSlug":"/reference/api/installment-plans","items":[{"label":"Retrieves a list of installment plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/installment-plans/retrievelistofinstallmentplans","routeSlug":"/reference/api/installment-plans/retrievelistofinstallmentplans","metadata":{"seo":{"title":"Retrieves a list of installment plans","description":"Retrieve a list of installment plans that have been created for your account. The installment plans are sorted, with the most recent first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfInstallmentPlans","name":"Retrieves a list of installment plans","isWebhook":false,"pointer":"/paths/~1installment_plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of installment plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of installment plans that have been created for your account. The installment plans are sorted, with the most recent first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/installment_plans","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/installment_plans","href":"installment-plans/retrievelistofinstallmentplans","openApiOperationId":"retrieveListOfInstallmentPlans","summary":"Retrieves a list of installment plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"installment plans found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27"}],"pointer":"/paths/~1installment_plans/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/retrievelistofinstallmentplans"}],"panels":[]}]},"httpPath":"/installment_plans"},{"label":"Creates a installment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/installment-plans/createinstallmentplan","routeSlug":"/reference/api/installment-plans/createinstallmentplan","metadata":{"seo":{"title":"Creates a installment plan","description":"Creates a Installment plan object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInstallmentPlan","name":"Creates a installment plan","isWebhook":false,"pointer":"/paths/~1installment_plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a installment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Installment plan object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_installment_plan"}},"schemaId":"components/schemas/request_create_installment_plan","pointer":"/paths/~1installment_plans/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/installment_plans","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_installment_plan"}},"responseCodes":["201"],"pointer":"/installment_plans","href":"installment-plans/createinstallmentplan","openApiOperationId":"createInstallmentPlan","summary":"Creates a installment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_installment_plan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_installment_plan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"installment plan created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}},"schemaId":"components/schemas/installment_plan"}],"pointer":"/paths/~1installment_plans/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/installment_plan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/createinstallmentplan"}],"panels":[]}]},"httpPath":"/installment_plans"},{"label":"Retrieves a installment plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/installment-plans/retrieveinstallmentplan","routeSlug":"/reference/api/installment-plans/retrieveinstallmentplan","metadata":{"seo":{"title":"Retrieves a installment plan","description":"Retrieves a single installment plan based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveInstallmentPlan","name":"Retrieves a installment plan","isWebhook":false,"pointer":"/paths/~1installment_plans~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a installment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single installment plan based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the installment plan","required":true}],"pointer":"/paths/~1installment_plans~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/installment_plans/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/installment_plans/{id}","href":"installment-plans/retrieveinstallmentplan","openApiOperationId":"retrieveInstallmentPlan","summary":"Retrieves a installment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"installment plan found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}},"schemaId":"components/schemas/installment_plan"},{"code":"404","description":"installment plan not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1installment_plans~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/installment_plan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/retrieveinstallmentplan"}],"panels":[]}]},"httpPath":"/installment_plans/{id}"},{"label":"Updates an installment plan","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/installment-plans/updateinstallmentplan","routeSlug":"/reference/api/installment-plans/updateinstallmentplan","metadata":{"seo":{"title":"Updates an installment plan","description":"Updates an Installment plan object. Returns the updated Installment plan"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInstallmentPlan","name":"Updates an installment plan","isWebhook":false,"pointer":"/paths/~1installment_plans~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates an installment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an Installment plan object. Returns the updated Installment plan"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the installment plan","required":true}],"pointer":"/paths/~1installment_plans~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_update_installment_plan"}},"schemaId":"components/schemas/request_update_installment_plan","pointer":"/paths/~1installment_plans~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/installment_plans/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_update_installment_plan"}},"responseCodes":["200","404"],"pointer":"/installment_plans/{id}","href":"installment-plans/updateinstallmentplan","openApiOperationId":"updateInstallmentPlan","summary":"Updates an installment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_update_installment_plan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_update_installment_plan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"installment plan updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}},"schemaId":"components/schemas/installment_plan"},{"code":"404","description":"installment plan not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1installment_plans~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/installment_plan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/updateinstallmentplan"}],"panels":[]}]},"httpPath":"/installment_plans/{id}"},{"label":"Cancels a installment plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/installment-plans/cancelinstallmentplan","routeSlug":"/reference/api/installment-plans/cancelinstallmentplan","metadata":{"seo":{"title":"Cancels a installment plan","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelInstallmentPlan","name":"Cancels a installment plan","isWebhook":false,"pointer":"/paths/~1installment_plans~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels a installment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a installment plan. A canceled installment plan will no longer create new installment plan periods.\nIt is not possible to resume a canceled installment plan."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the installment plan","required":true}],"pointer":"/paths/~1installment_plans~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/installment_plans/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/installment_plans/{id}","href":"installment-plans/cancelinstallmentplan","openApiOperationId":"cancelInstallmentPlan","summary":"Cancels a installment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"installment plan canceled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}},"schemaId":"components/schemas/installment_plan"}],"pointer":"/paths/~1installment_plans~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/installment_plan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/cancelinstallmentplan"}],"panels":[]}]},"httpPath":"/installment_plans/{id}"},{"label":"Retrieves a list installment plan periods that belong to this installment plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/installment-plans/retrievelistofinstallmentplanperiodsbyinstallmentplan","routeSlug":"/reference/api/installment-plans/retrievelistofinstallmentplanperiodsbyinstallmentplan","metadata":{"seo":{"title":"Retrieves a list installment plan periods that belong to this installment plan","description":"Retrieves a list of installment plan periods that belong to this installment plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfInstallmentPlanPeriodsByInstallmentPlan","name":"Retrieves a list installment plan periods that belong to this installment plan","isWebhook":false,"pointer":"/paths/~1installment_plans~1{id}~1installment_plan_periods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list installment plan periods that belong to this installment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of installment plan periods that belong to this installment plan."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the installment plan","required":true}],"pointer":"/paths/~1installment_plans~1{id}~1installment_plan_periods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/installment_plans/{id}/installment_plan_periods","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/installment_plans/{id}/installment_plan_periods","href":"installment-plans/retrievelistofinstallmentplanperiodsbyinstallmentplan","openApiOperationId":"retrieveListOfInstallmentPlanPeriodsByInstallmentPlan","summary":"Retrieves a list installment plan periods that belong to this installment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"installment plan periods found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28"}],"pointer":"/paths/~1installment_plans~1{id}~1installment_plan_periods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/retrievelistofinstallmentplanperiodsbyinstallmentplan"}],"panels":[]}]},"httpPath":"/installment_plans/{id}/installment_plan_periods"},{"label":"Pauses a installment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/installment-plans/pauseinstallmentplan","routeSlug":"/reference/api/installment-plans/pauseinstallmentplan","metadata":{"seo":{"title":"Pauses a installment plan","description":"Pauses a installment plan. A paused installment plan will no longer create new installment plan periods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pauseInstallmentPlan","name":"Pauses a installment plan","isWebhook":false,"pointer":"/paths/~1installment_plans~1{id}~1pause/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pauses a installment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pauses a installment plan. A paused installment plan will no longer create new installment plan periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can resume the installment plan by calling the /installment_plans/:id/resume endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the installment plan","required":true}],"pointer":"/paths/~1installment_plans~1{id}~1pause/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/installment_plans/{id}/pause","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/installment_plans/{id}/pause","href":"installment-plans/pauseinstallmentplan","openApiOperationId":"pauseInstallmentPlan","summary":"Pauses a installment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"installment plan paused","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}},"schemaId":"components/schemas/installment_plan"}],"pointer":"/paths/~1installment_plans~1{id}~1pause/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/installment_plan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/pauseinstallmentplan"}],"panels":[]}]},"httpPath":"/installment_plans/{id}/pause"},{"label":"Resumes a paused installment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/installment-plans/resumeinstallmentplan","routeSlug":"/reference/api/installment-plans/resumeinstallmentplan","metadata":{"seo":{"title":"Resumes a paused installment plan","description":"Resumes a paused installment plan. The paused installment plan will return to the active state and will resume creating new installment plan periods."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resumeInstallmentPlan","name":"Resumes a paused installment plan","isWebhook":false,"pointer":"/paths/~1installment_plans~1{id}~1resume/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resumes a paused installment plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resumes a paused installment plan. The paused installment plan will return to the active state and will resume creating new installment plan periods.\n\nIt is not possible to resume a canceled installment plan."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the installment plan","required":true}],"pointer":"/paths/~1installment_plans~1{id}~1resume/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/installment_plans/{id}/resume","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/installment_plans/{id}/resume","href":"installment-plans/resumeinstallmentplan","openApiOperationId":"resumeInstallmentPlan","summary":"Resumes a paused installment plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"installment plan resumes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}},"schemaId":"components/schemas/installment_plan"}],"pointer":"/paths/~1installment_plans~1{id}~1resume/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/installment_plan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/resumeinstallmentplan"}],"panels":[]}]},"httpPath":"/installment_plans/{id}/resume"}],"content":{"contentType":"group","meta":{"name":"Installment plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Installment plans","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Installment plans can be used to periodically charge a customer by specifying the amount and interval. The amount and number of periods are fixed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The main difference with a subscription is that an installment plan does not run indefinitely and the invoice is generated up front. Where with a subscription it can run indefinitely and an invoice is created for each period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are unsure which to use we suggest to look at the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" first. Most use cases can be solved with subscriptions and installment plans should only be considered if a single invoice is required."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/installment_plans","summary":"Retrieves a list of installment plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-plans/retrievelistofinstallmentplans","deprecated":false},{"title":"/installment_plans","summary":"Creates a installment plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-plans/createinstallmentplan","deprecated":false},{"title":"/installment_plans/{id}","summary":"Retrieves a installment plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-plans/retrieveinstallmentplan","deprecated":false},{"title":"/installment_plans/{id}","summary":"Updates an installment plan","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/installment-plans/updateinstallmentplan","deprecated":false},{"title":"/installment_plans/{id}","summary":"Cancels a installment plan","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/installment-plans/cancelinstallmentplan","deprecated":false},{"title":"/installment_plans/{id}/installment_plan_periods","summary":"Retrieves a list installment plan periods that belong to this installment plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-plans/retrievelistofinstallmentplanperiodsbyinstallmentplan","deprecated":false},{"title":"/installment_plans/{id}/pause","summary":"Pauses a installment plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-plans/pauseinstallmentplan","deprecated":false},{"title":"/installment_plans/{id}/resume","summary":"Resumes a paused installment plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-plans/resumeinstallmentplan","deprecated":false}]}]}]}]}},{"type":"group","label":"Installment plan periods","link":"/reference/api/installment-plan-periods","routeSlug":"/reference/api/installment-plan-periods","items":[{"label":"Retrieves a installment plan period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/installment-plan-periods/retrieveinstallmentplanperiod","routeSlug":"/reference/api/installment-plan-periods/retrieveinstallmentplanperiod","metadata":{"seo":{"title":"Retrieves a installment plan period","description":"Retrieves a single installment plan period based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveInstallmentPlanPeriod","name":"Retrieves a installment plan period","isWebhook":false,"pointer":"/paths/~1installment_plan_periods~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a installment plan period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single installment plan period based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the installment plan period","required":true}],"pointer":"/paths/~1installment_plan_periods~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/installment_plan_periods/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/installment_plan_periods/{id}","href":"installment-plan-periods/retrieveinstallmentplanperiod","openApiOperationId":"retrieveInstallmentPlanPeriod","summary":"Retrieves a installment plan period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"installment plan period found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan_period"}},"schemaId":"components/schemas/installment_plan_period"},{"code":"404","description":"installment plan period not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1installment_plan_periods~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/installment_plan_period","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/installment_plan_period"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plan-periods/retrieveinstallmentplanperiod"}],"panels":[]}]},"httpPath":"/installment_plan_periods/{id}"},{"label":"Retrieves a list of payments that belong to this installment plan period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/installment-plan-periods/retrievelistofpaymentsbyinstallmentplanperiod","routeSlug":"/reference/api/installment-plan-periods/retrievelistofpaymentsbyinstallmentplanperiod","metadata":{"seo":{"title":"Retrieves a list of payments that belong to this installment plan period","description":"Retrieves a list of payments that belong to this installment plan period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfPaymentsByInstallmentPlanPeriod","name":"Retrieves a list of payments that belong to this installment plan period","isWebhook":false,"pointer":"/paths/~1installment_plan_periods~1{id}~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of payments that belong to this installment plan period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of payments that belong to this installment plan period."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the installment plan period","required":true}],"pointer":"/paths/~1installment_plan_periods~1{id}~1payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/installment_plan_periods/{id}/payments","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/installment_plan_periods/{id}/payments","href":"installment-plan-periods/retrievelistofpaymentsbyinstallmentplanperiod","openApiOperationId":"retrieveListOfPaymentsByInstallmentPlanPeriod","summary":"Retrieves a list of payments that belong to this installment plan period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"payments found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19"}],"pointer":"/paths/~1installment_plan_periods~1{id}~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plan-periods/retrievelistofpaymentsbyinstallmentplanperiod"}],"panels":[]}]},"httpPath":"/installment_plan_periods/{id}/payments"}],"content":{"contentType":"group","meta":{"name":"Installment plan periods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Installment plan periods","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Installment plan period represents a period in an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/installment-plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"installment plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". These are created by the system at the interval you specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/payments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created to charge the customer are associated with the installment plan period as well as other payments that might happen if the first one fails or when a customer repays after a chargeback."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/installment_plan_periods/{id}","summary":"Retrieves a installment plan period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-plan-periods/retrieveinstallmentplanperiod","deprecated":false},{"title":"/installment_plan_periods/{id}/payments","summary":"Retrieves a list of payments that belong to this installment plan period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-plan-periods/retrievelistofpaymentsbyinstallmentplanperiod","deprecated":false}]}]}]}]}},{"type":"separator","label":"Webhooks","content":null},{"type":"group","label":"Events","link":"/reference/api/events","routeSlug":"/reference/api/events","items":[{"label":"Retrieves an event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/events/retrieveevent","routeSlug":"/reference/api/events/retrieveevent","metadata":{"seo":{"title":"Retrieves an event","description":"Retrieves a single event based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveEvent","name":"Retrieves an event","isWebhook":false,"pointer":"/paths/~1events~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single event based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the event","required":true}],"pointer":"/paths/~1events~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/events/{id}","href":"events/retrieveevent","openApiOperationId":"retrieveEvent","summary":"Retrieves an event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"event found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event"}},"schemaId":"components/schemas/event"},{"code":"404","description":"payment not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1events~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/event","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/retrieveevent"}],"panels":[]}]},"httpPath":"/events/{id}"},{"label":"Retrieve a list of events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/events/retrievelistofevents","routeSlug":"/reference/api/events/retrievelistofevents","metadata":{"seo":{"title":"Retrieve a list of events","description":"Retrieve a list of events that have been created for your account. The events are sorted, with the most recent first"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfEvents","name":"Retrieve a list of events","isWebhook":false,"pointer":"/paths/~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of events that have been created for your account. The events are sorted, with the most recent first"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/events","href":"events/retrievelistofevents","openApiOperationId":"retrieveListOfEvents","summary":"Retrieve a list of events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"events found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29"}],"pointer":"/paths/~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/retrievelistofevents"}],"panels":[]}]},"httpPath":"/events"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events are generated by our system to notify about something that happened in your account. Events contain an event type like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a payload with information about the object for which this event happened."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event payload always contains the information about the resource at the moment the event was created. This means the information in the payload may be out-of-date. To avoid this you should retrieve the resource from the API again and use the information retrieved in the API request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use these endpoints to retrieve events from your account. Our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" system uses these events when sending notifications to your server."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhooks section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events/{id}","summary":"Retrieves an event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/retrieveevent","deprecated":false},{"title":"/events","summary":"Retrieve a list of events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/retrievelistofevents","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/reference/api/webhooks","routeSlug":"/reference/api/webhooks","items":[{"label":"Retrieves a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/webhooks/retrievewebhook","routeSlug":"/reference/api/webhooks/retrievewebhook","metadata":{"seo":{"title":"Retrieves a webhook","description":"Retrieves a single webhook based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveWebhook","name":"Retrieves a webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single webhook based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the webhook","required":true}],"pointer":"/paths/~1webhooks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/webhooks/{id}","href":"webhooks/retrievewebhook","openApiOperationId":"retrieveWebhook","summary":"Retrieves a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"webhook found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}},"schemaId":"components/schemas/webhook"},{"code":"404","description":"webhook not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1webhooks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/retrievewebhook"}],"panels":[]}]},"httpPath":"/webhooks/{id}"},{"label":"Updates a webhook","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/webhooks/updatewebhook","routeSlug":"/reference/api/webhooks/updatewebhook","metadata":{"seo":{"title":"Updates a webhook","description":"Updates a Webhook object. Returns the updated Webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhook","name":"Updates a webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a Webhook object. Returns the updated Webhook"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the webhook","required":true}],"pointer":"/paths/~1webhooks~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_update_webhook"}},"schemaId":"components/schemas/request_update_webhook","pointer":"/paths/~1webhooks~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/webhooks/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_update_webhook"}},"responseCodes":["200","404"],"pointer":"/webhooks/{id}","href":"webhooks/updatewebhook","openApiOperationId":"updateWebhook","summary":"Updates a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_update_webhook","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_update_webhook"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"webhook updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}},"schemaId":"components/schemas/webhook"},{"code":"404","description":"webhook not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1webhooks~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/updatewebhook"}],"panels":[]}]},"httpPath":"/webhooks/{id}"},{"label":"Deletes a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/webhooks/deletewebhook","routeSlug":"/reference/api/webhooks/deletewebhook","metadata":{"seo":{"title":"Deletes a webhook","description":"Deletes a webhook. A deleted webhook will no longer send events to the endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Deletes a webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a webhook. A deleted webhook will no longer send events to the endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the webhook","required":true}],"pointer":"/paths/~1webhooks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/webhooks/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/webhooks/{id}","href":"webhooks/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Deletes a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"webhook deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}},"schemaId":"components/schemas/webhook"}],"pointer":"/paths/~1webhooks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhook"}],"panels":[]}]},"httpPath":"/webhooks/{id}"},{"label":"Retrieves a list of webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/webhooks/retrievelistofwebhooks","routeSlug":"/reference/api/webhooks/retrievelistofwebhooks","metadata":{"seo":{"title":"Retrieves a list of webhooks","description":"Retrieve a list of webhooks that have been created for your account. The webhooks are sorted, with the most recent first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfWebhooks","name":"Retrieves a list of webhooks","isWebhook":false,"pointer":"/paths/~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of webhooks that have been created for your account. The webhooks are sorted, with the most recent first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/webhooks","href":"webhooks/retrievelistofwebhooks","openApiOperationId":"retrieveListOfWebhooks","summary":"Retrieves a list of webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"webhooks found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30"}],"pointer":"/paths/~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/retrievelistofwebhooks"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Creates a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/webhooks/createwebhook","routeSlug":"/reference/api/webhooks/createwebhook","metadata":{"seo":{"title":"Creates a webhook","description":"Creates a Webhook object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Creates a webhook","isWebhook":false,"pointer":"/paths/~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Webhook object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A webhook needs to have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default the Webhook will be active and subscribed to all event types. You can add the parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make it inactive."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_webhook"}},"schemaId":"components/schemas/request_create_webhook","pointer":"/paths/~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_webhook"}},"responseCodes":["201"],"pointer":"/webhooks","href":"webhooks/createwebhook","openApiOperationId":"createWebhook","summary":"Creates a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_webhook","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_webhook"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"webhook created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}},"schemaId":"components/schemas/webhook"}],"pointer":"/paths/~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhook"}],"panels":[]}]},"httpPath":"/webhooks"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks can be used to send "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/events"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to an HTTP endpoint. A typical event is when a payment is paid, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment.paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve and manage your webhooks through the API or in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.paypro.nl/developers/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayPro dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhooks section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on how to setup and use webhooks and events."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/webhooks/{id}","summary":"Retrieves a webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/retrievewebhook","deprecated":false},{"title":"/webhooks/{id}","summary":"Updates a webhook","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhooks/updatewebhook","deprecated":false},{"title":"/webhooks/{id}","summary":"Deletes a webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhook","deprecated":false},{"title":"/webhooks","summary":"Retrieves a list of webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/retrievelistofwebhooks","deprecated":false},{"title":"/webhooks","summary":"Creates a webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhook","deprecated":false}]}]}]}]}},{"type":"separator","label":"Balances","content":null},{"type":"group","label":"Balances","link":"/reference/api/balances","routeSlug":"/reference/api/balances","items":[{"label":"Retrieves a list of balance transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/balances/retrievelistofbalancetransactions","routeSlug":"/reference/api/balances/retrievelistofbalancetransactions","metadata":{"seo":{"title":"Retrieves a list of balance transactions","description":"Retrieves a list of balance transactions for the given balance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfBalanceTransactions","name":"Retrieves a list of balance transactions","isWebhook":false,"pointer":"/paths/~1balances~1{balance_id}~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of balance transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of balance transactions for the given balance."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"balance_id","in":"path","schemaId":"schema_18","description":"ID of the balance","required":true}],"pointer":"/paths/~1balances~1{balance_id}~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/balances/{balance_id}/transactions","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"balance_id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/balances/{balance_id}/transactions","href":"balances/retrievelistofbalancetransactions","openApiOperationId":"retrieveListOfBalanceTransactions","summary":"Retrieves a list of balance transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"balance transactions found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31"},{"code":"404","description":"balance not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1balances~1{balance_id}~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/retrievelistofbalancetransactions"}],"panels":[]}]},"httpPath":"/balances/{balance_id}/transactions"},{"label":"Retrieves a balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/balances/retrievebalance","routeSlug":"/reference/api/balances/retrievebalance","metadata":{"seo":{"title":"Retrieves a balance","description":"Retrieves a single balance based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveBalance","name":"Retrieves a balance","isWebhook":false,"pointer":"/paths/~1balances~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single balance based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the balance","required":true}],"pointer":"/paths/~1balances~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/balances/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/balances/{id}","href":"balances/retrievebalance","openApiOperationId":"retrieveBalance","summary":"Retrieves a balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"balance found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balance"}},"schemaId":"components/schemas/balance"},{"code":"404","description":"balance not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1balances~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/balance","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balance"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/retrievebalance"}],"panels":[]}]},"httpPath":"/balances/{id}"},{"label":"Retrieve a list of balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/balances/retrievelistofbalances","routeSlug":"/reference/api/balances/retrievelistofbalances","metadata":{"seo":{"title":"Retrieve a list of balances","description":"Retrieve a list of balances that are available for your PayPro account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfBalances","name":"Retrieve a list of balances","isWebhook":false,"pointer":"/paths/~1balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of balances that are available for your PayPro account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/balances","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/balances","href":"balances/retrievelistofbalances","openApiOperationId":"retrieveListOfBalances","summary":"Retrieve a list of balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"balances found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}},"schemaId":"schema_32"}],"pointer":"/paths/~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_32","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/retrievelistofbalances"}],"panels":[]}]},"httpPath":"/balances"}],"content":{"contentType":"group","meta":{"name":"Balances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balances","showPageActions":true},{"nodeType":"markdoc","content":"Balances reflect your PayPro balance. You can retrieve it to see the balances you currently have in your PayPro account.\n\nYour account has a balance object per currency."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/balances/{balance_id}/transactions","summary":"Retrieves a list of balance transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/retrievelistofbalancetransactions","deprecated":false},{"title":"/balances/{id}","summary":"Retrieves a balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/retrievebalance","deprecated":false},{"title":"/balances","summary":"Retrieve a list of balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/retrievelistofbalances","deprecated":false}]}]}]}]}},{"type":"group","label":"Currency conversions","link":"/reference/api/currency-conversions","routeSlug":"/reference/api/currency-conversions","items":[{"label":"Retrieves a currency conversion","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/currency-conversions/retrievecurrencyconversion","routeSlug":"/reference/api/currency-conversions/retrievecurrencyconversion","metadata":{"seo":{"title":"Retrieves a currency conversion","description":"Retrieves a single currency conversion based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveCurrencyConversion","name":"Retrieves a currency conversion","isWebhook":false,"pointer":"/paths/~1currency_conversions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a currency conversion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single currency conversion based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the currency conversion","required":true}],"pointer":"/paths/~1currency_conversions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/currency_conversions/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/currency_conversions/{id}","href":"currency-conversions/retrievecurrencyconversion","openApiOperationId":"retrieveCurrencyConversion","summary":"Retrieves a currency conversion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"currency conversion found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/currency_conversion"}},"schemaId":"components/schemas/currency_conversion"},{"code":"404","description":"currency conversion not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1currency_conversions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/currency_conversion","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/currency_conversion"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-conversions/retrievecurrencyconversion"}],"panels":[]}]},"httpPath":"/currency_conversions/{id}"},{"label":"Retrieves a list of currency conversions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/currency-conversions/retrievelistofcurrencyconversions","routeSlug":"/reference/api/currency-conversions/retrievelistofcurrencyconversions","metadata":{"seo":{"title":"Retrieves a list of currency conversions","description":"Retrieve a list of currency conversions that have been created for your account. The currency conversions are sorted, with the most recent first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfCurrencyConversions","name":"Retrieves a list of currency conversions","isWebhook":false,"pointer":"/paths/~1currency_conversions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of currency conversions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of currency conversions that have been created for your account. The currency conversions are sorted, with the most recent first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/currency_conversions","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/currency_conversions","href":"currency-conversions/retrievelistofcurrencyconversions","openApiOperationId":"retrieveListOfCurrencyConversions","summary":"Retrieves a list of currency conversions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"currency conversions found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"}],"pointer":"/paths/~1currency_conversions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-conversions/retrievelistofcurrencyconversions"}],"panels":[]}]},"httpPath":"/currency_conversions"},{"label":"Retrieves a list of payments that belong to this currency conversion","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/currency-conversions/retrievelistofpaymentsbycurrencyconversion","routeSlug":"/reference/api/currency-conversions/retrievelistofpaymentsbycurrencyconversion","metadata":{"seo":{"title":"Retrieves a list of payments that belong to this currency conversion","description":"Retrieves a list of payments that belong to this currency conversion."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfPaymentsByCurrencyConversion","name":"Retrieves a list of payments that belong to this currency conversion","isWebhook":false,"pointer":"/paths/~1currency_conversions~1{id}~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of payments that belong to this currency conversion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of payments that belong to this currency conversion."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the currency conversion","required":true}],"pointer":"/paths/~1currency_conversions~1{id}~1payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/currency_conversions/{id}/payments","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/currency_conversions/{id}/payments","href":"currency-conversions/retrievelistofpaymentsbycurrencyconversion","openApiOperationId":"retrieveListOfPaymentsByCurrencyConversion","summary":"Retrieves a list of payments that belong to this currency conversion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"payments found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19"}],"pointer":"/paths/~1currency_conversions~1{id}~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-conversions/retrievelistofpaymentsbycurrencyconversion"}],"panels":[]}]},"httpPath":"/currency_conversions/{id}/payments"},{"label":"Retrieves a list of balance transactions that belong to this currency conversion","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/currency-conversions/retrievelistoftransactionsbycurrencyconversion","routeSlug":"/reference/api/currency-conversions/retrievelistoftransactionsbycurrencyconversion","metadata":{"seo":{"title":"Retrieves a list of balance transactions that belong to this currency conversion","description":"Retrieves a list of balance transactions that belong to this currency conversion."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfTransactionsByCurrencyConversion","name":"Retrieves a list of balance transactions that belong to this currency conversion","isWebhook":false,"pointer":"/paths/~1currency_conversions~1{id}~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of balance transactions that belong to this currency conversion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of balance transactions that belong to this currency conversion."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the currency conversion","required":true}],"pointer":"/paths/~1currency_conversions~1{id}~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/currency_conversions/{id}/transactions","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/currency_conversions/{id}/transactions","href":"currency-conversions/retrievelistoftransactionsbycurrencyconversion","openApiOperationId":"retrieveListOfTransactionsByCurrencyConversion","summary":"Retrieves a list of balance transactions that belong to this currency conversion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"balance transactions found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31"},{"code":"404","description":"currency conversion not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1currency_conversions~1{id}~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-conversions/retrievelistoftransactionsbycurrencyconversion"}],"panels":[]}]},"httpPath":"/currency_conversions/{id}/transactions"}],"content":{"contentType":"group","meta":{"name":"Currency conversions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Currency conversions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency conversions represent the conversion of a certain amount from one currency to the other. Currency conversion amounts are based on the associated payments that are converted to a different currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The FX rate of a currency conversion is determined by our partners. On top of that they can have a separate PayPro fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To see the associated payments you can use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/currency-conversions/retrievelistofpaymentsbycurrencyconversion"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/currency_conversions/{id}","summary":"Retrieves a currency conversion","prefix":{"name":"get","color":"get"},"badges":[],"link":"/currency-conversions/retrievecurrencyconversion","deprecated":false},{"title":"/currency_conversions","summary":"Retrieves a list of currency conversions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/currency-conversions/retrievelistofcurrencyconversions","deprecated":false},{"title":"/currency_conversions/{id}/payments","summary":"Retrieves a list of payments that belong to this currency conversion","prefix":{"name":"get","color":"get"},"badges":[],"link":"/currency-conversions/retrievelistofpaymentsbycurrencyconversion","deprecated":false},{"title":"/currency_conversions/{id}/transactions","summary":"Retrieves a list of balance transactions that belong to this currency conversion","prefix":{"name":"get","color":"get"},"badges":[],"link":"/currency-conversions/retrievelistoftransactionsbycurrencyconversion","deprecated":false}]}]}]}]}},{"type":"group","label":"Payouts","link":"/reference/api/payouts","routeSlug":"/reference/api/payouts","items":[{"label":"Retrieves a payout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/payouts/retrievepayout","routeSlug":"/reference/api/payouts/retrievepayout","metadata":{"seo":{"title":"Retrieves a payout","description":"Retrieves a single payout based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrievePayout","name":"Retrieves a payout","isWebhook":false,"pointer":"/paths/~1payouts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a payout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single payout based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the payout","required":true}],"pointer":"/paths/~1payouts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payouts/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/payouts/{id}","href":"payouts/retrievepayout","openApiOperationId":"retrievePayout","summary":"Retrieves a payout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"payout found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payout"}},"schemaId":"components/schemas/payout"},{"code":"404","description":"payout not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1payouts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/payout","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payout"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payouts/retrievepayout"}],"panels":[]}]},"httpPath":"/payouts/{id}"},{"label":"Retrieve a list of payouts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/payouts/retrievelistofpayouts","routeSlug":"/reference/api/payouts/retrievelistofpayouts","metadata":{"seo":{"title":"Retrieve a list of payouts","description":"Retrieve a list of payouts that have been created for your account. The payouts are sorted, with the most recent first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfPayouts","name":"Retrieve a list of payouts","isWebhook":false,"pointer":"/paths/~1payouts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of payouts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of payouts that have been created for your account. The payouts are sorted, with the most recent first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payouts","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payouts","href":"payouts/retrievelistofpayouts","openApiOperationId":"retrieveListOfPayouts","summary":"Retrieve a list of payouts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"payouts found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"}],"pointer":"/paths/~1payouts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payouts/retrievelistofpayouts"}],"panels":[]}]},"httpPath":"/payouts"},{"label":"Creates a payout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/payouts/createpayout","routeSlug":"/reference/api/payouts/createpayout","metadata":{"seo":{"title":"Creates a payout","description":"Creates a Payout object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPayout","name":"Creates a payout","isWebhook":false,"pointer":"/paths/~1payouts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a payout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Payout object."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_payout"}},"schemaId":"components/schemas/request_create_payout","pointer":"/paths/~1payouts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payouts","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_payout"}},"responseCodes":["201"],"pointer":"/payouts","href":"payouts/createpayout","openApiOperationId":"createPayout","summary":"Creates a payout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_payout","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_payout"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"payout created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payout"}},"schemaId":"components/schemas/payout"}],"pointer":"/paths/~1payouts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/payout","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payout"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payouts/createpayout"}],"panels":[]}]},"httpPath":"/payouts"}],"content":{"contentType":"group","meta":{"name":"Payouts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payouts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payouts are created when you receive funds from PayPro to one of your bank accounts. These can be created on a schedule, through the dashboard or by using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/payouts/createpayout"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout create endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a payout you must have sufficient balance in your PayPro account."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payouts/{id}","summary":"Retrieves a payout","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payouts/retrievepayout","deprecated":false},{"title":"/payouts","summary":"Retrieve a list of payouts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payouts/retrievelistofpayouts","deprecated":false},{"title":"/payouts","summary":"Creates a payout","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payouts/createpayout","deprecated":false}]}]}]}]}},{"type":"group","label":"Top-ups","link":"/reference/api/top-ups","routeSlug":"/reference/api/top-ups","items":[{"label":"Retrieves a top-up","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/top-ups/retrievetopup","routeSlug":"/reference/api/top-ups/retrievetopup","metadata":{"seo":{"title":"Retrieves a top-up","description":"Retrieves a single top-up based on the id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveTopUp","name":"Retrieves a top-up","isWebhook":false,"pointer":"/paths/~1top_ups~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a top-up","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single top-up based on the id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_18","description":"ID of the top-up","required":true}],"pointer":"/paths/~1top_ups~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/top_ups/{id}","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/top_ups/{id}","href":"top-ups/retrievetopup","openApiOperationId":"retrieveTopUp","summary":"Retrieves a top-up"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"top-up found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/top_up"}},"schemaId":"components/schemas/top_up"},{"code":"404","description":"top-up not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}},"schemaId":"components/schemas/not_found_error"}],"pointer":"/paths/~1top_ups~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/top_up","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/top_up"}}},{"code":"404","schemaId":"components/schemas/not_found_error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/not_found_error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/top-ups/retrievetopup"}],"panels":[]}]},"httpPath":"/top_ups/{id}"},{"label":"Retrieve a list of top-ups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/top-ups/retrievelistoftopups","routeSlug":"/reference/api/top-ups/retrievelistoftopups","metadata":{"seo":{"title":"Retrieve a list of top-ups","description":"Retrieve a list of top-ups that have been created for your account. The top-ups are sorted, with the most recent first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveListOfTopUps","name":"Retrieve a list of top-ups","isWebhook":false,"pointer":"/paths/~1top_ups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of top-ups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of top-ups that have been created for your account. The top-ups are sorted, with the most recent first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/top_ups","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/top_ups","href":"top-ups/retrievelistoftopups","openApiOperationId":"retrieveListOfTopUps","summary":"Retrieve a list of top-ups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"top-ups found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1top_ups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/top-ups/retrievelistoftopups"}],"panels":[]}]},"httpPath":"/top_ups"},{"label":"Creates a top-up","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/top-ups/createtopup","routeSlug":"/reference/api/top-ups/createtopup","metadata":{"seo":{"title":"Creates a top-up","description":"Creates a Top-up object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTopUp","name":"Creates a top-up","isWebhook":false,"pointer":"/paths/~1top_ups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a top-up","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Top-up object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After you have created a Top-up you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links.checkout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" link to redirect to the pay page."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_top_up"}},"schemaId":"components/schemas/request_create_top_up","pointer":"/paths/~1top_ups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/top_ups","servers":[{"url":"https://api.paypro.nl"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request_create_top_up"}},"responseCodes":["201"],"pointer":"/top_ups","href":"top-ups/createtopup","openApiOperationId":"createTopUp","summary":"Creates a top-up"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.paypro.nl"}],"schemaId":"components/schemas/request_create_top_up","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request_create_top_up"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"top-up created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/top_up"}},"schemaId":"components/schemas/top_up"}],"pointer":"/paths/~1top_ups/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/top_up","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/top_up"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/top-ups/createtopup"}],"panels":[]}]},"httpPath":"/top_ups"}],"content":{"contentType":"group","meta":{"name":"Top-ups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Top-ups","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Top-ups are a way to top-up your PayPro balance. This can be done through our dashboard or by using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/reference/api/top-ups/createtopup"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Top-up create endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The top-up has a unique ID which might be necessary to use when doing manual transfers. When the top-up is processed your PayPro balance will automatically be increased by the amount in the top-up."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/top_ups/{id}","summary":"Retrieves a top-up","prefix":{"name":"get","color":"get"},"badges":[],"link":"/top-ups/retrievetopup","deprecated":false},{"title":"/top_ups","summary":"Retrieve a list of top-ups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/top-ups/retrievelistoftopups","deprecated":false},{"title":"/top_ups","summary":"Creates a top-up","prefix":{"name":"post","color":"post"},"badges":[],"link":"/top-ups/createtopup","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/all_event_types":{"id":"components/schemas/all_event_types","kind":"json-schema","title":"all_event_types","data":{"type":"string","enum":["all"]}},"components/schemas/balance":{"id":"components/schemas/balance","kind":"json-schema","title":"balance","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["balance"]},"amount":{"type":"integer"},"currency":{"type":"string","enum":["EUR","USD","XCG"]},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"}},"required":["self"]}},"required":["id","type","amount","currency","_links"],"example":{"id":"PBA7HA516X604D","type":"balance","amount":1000,"currency":"EUR","_links":{"self":"https://api.paypro.nl/balances/PBA7HA516X604D"}}}},"components/schemas/balance_transaction":{"id":"components/schemas/balance_transaction","kind":"json-schema","title":"balance_transaction","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer"},"type":{"type":"string","enum":["balance_transaction"]},"amount":{"type":"integer"},"fee_amount":{"type":"integer"},"vat_amount":{"type":"integer"},"currency":{"type":"string","enum":["EUR","USD","XCG"]},"description":{"type":"string"},"transaction_type":{"type":"string"},"source":{"type":"string","nullable":true},"payout":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"_links":{"type":"object","additionalProperties":false,"properties":{"payout":{"type":"string","format":"uri"},"payment":{"type":"string","format":"uri"},"refund":{"type":"string","format":"uri"},"chargeback":{"type":"string","format":"uri"},"top_up":{"type":"string","format":"uri"},"ow_payment":{"type":"string","format":"uri"},"ow_refund":{"type":"string","format":"uri"},"currency_conversion":{"type":"string","format":"uri"},"commission":{"type":"string","format":"uri"}}}},"required":["id","type","amount","fee_amount","vat_amount","currency","description","transaction_type","source","payout","date","_links"],"example":{"id":12345,"type":"balance_transaction","amount":10000,"fee_amount":350,"vat_amount":74,"currency":"EUR","description":"Product name","transaction_type":"SAL","source":"PP8VZWQN7REXUA","payout":"POKHCDCQPS4GAA","date":"2025-05-28T14:52:26Z","_links":{}}}},"components/schemas/chargeback":{"id":"components/schemas/chargeback","kind":"json-schema","title":"chargeback","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["chargeback"]},"amount":{"type":"integer"},"description":{"type":"string"},"reason":{"type":"string","nullable":true},"currency":{"type":"string","enum":["EUR"]},"payment":{"type":"string"},"state":{"type":"string"},"charged_back_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"},"payment":{"type":"string","format":"uri"}},"required":["self","payment"]}},"required":["id","type","amount","description","reason","payment","currency","state","charged_back_at","created_at","_links"],"example":{"id":"PCG2SZKYJCCDV8","type":"chargeback","amount":1000,"description":"Test Payment","reason":"MD06","payment":"PPBLGEE6UG92MS","currency":"EUR","state":"completed","refunded_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/chargebacks/PCG2SZKYJCCDV8","payment":"https://api.paypro.nl/payments/PPBLGEE6UG92MS"}}}},"components/schemas/currency_conversion":{"id":"components/schemas/currency_conversion","kind":"json-schema","title":"currency_conversion","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["currency_conversion"]},"from_amount":{"type":"integer"},"from_currency":{"type":"string","enum":["EUR"]},"to_amount":{"type":"integer"},"to_currency":{"type":"string","enum":["USD","XCG"]},"fx_rate":{"type":"string","format":"decimal"},"fee_amount":{"type":"integer"},"fee_currency":{"type":"string","enum":["EUR"]},"created_at":{"type":"string","format":"date-time"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"},"payments":{"type":"string","format":"uri"},"transactions":{"type":"string","format":"uri"}},"required":["self","payments","transactions"]}},"required":["id","type","from_amount","from_currency","to_amount","to_currency","fx_rate","fee_amount","fee_currency","created_at","_links"],"example":{"id":"PCCQ38GVLGQHXRH","type":"currency_conversion","from_amount":1000,"from_currency":"EUR","to_amount":2319,"to_currency":"USD","fx_rate":"1.1594","fee_amount":0,"fee_currency":"EUR","created_at":"2025-10-14T14:49:29Z","_links":{"self":"https://api.paypro.nl/currency_conversions/PCCQ38GVLGQHXRH","payments":"https://api.paypro.nl/currency_conversions/PCCQ38GVLGQHXRH/payments","transactions":"https://api.paypro.nl/currency_conversions/PCCQ38GVLGQHXRH/transactions"}}}},"components/schemas/customer":{"id":"components/schemas/customer","kind":"json-schema","title":"customer","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["customer"]},"email":{"type":"string","format":"email","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"postal":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"vat_number":{"type":"string","nullable":true},"company_name":{"type":"string","nullable":true},"phone_number":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"}},"required":["self"]}},"required":["id","type","email","first_name","last_name","address","postal","city","country","vat_number","company_name","phone_number","created_at","_links"],"example":{"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":{"self":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9"}}}},"components/schemas/event":{"id":"components/schemas/event","kind":"json-schema","title":"event","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["event"]},"event_type":{"type":"string"},"payload":{"oneOf":[{"$ref":"#/components/schemas/chargeback"},{"$ref":"#/components/schemas/payment"},{"$ref":"#/components/schemas/refund"}]},"created_at":{"type":"string","format":"date-time"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"}},"required":["self"]}},"required":["id","type","event_type","payload","created_at","_links"],"example":{"id":"EVYKMZD2E452EDFB48","type":"event","event_type":"payment.created","payload":{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"initialized","return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}},"created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/events/EVYKMZD2E452EDFB48"}}}},"components/schemas/installment_plan":{"id":"components/schemas/installment_plan","kind":"json-schema","title":"installment_plan","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["installment_plan"]},"description":{"type":"string"},"installment_plan_type":{"type":"string","enum":["direct_debit"],"nullable":true},"state":{"type":"string"},"currency":{"type":"string","enum":["EUR"]},"created_at":{"type":"string","format":"date-time"},"customer":{"type":"string","nullable":true},"mandate":{"type":"string","nullable":true},"period":{"type":"object","additionalProperties":false,"properties":{"amount":{"type":"integer"},"vat":{"type":"number","minimum":0,"maximum":100},"multiplier":{"type":"integer"},"interval":{"type":"string","enum":["day","week","month","year"]}},"required":["amount","vat","multiplier","interval"]},"first_period":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"amount":{"type":"integer"},"vat":{"type":"number","minimum":0,"maximum":100},"multiplier":{"type":"integer"},"interval":{"type":"string","enum":["day","week","month","year"]}},"required":["amount","vat"]},"number_of_periods":{"type":"number","minimum":1},"payment_details":{"type":"object","additionalProperties":false,"properties":{"return_url":{"type":"string","format":"uri","nullable":true},"cancel_url":{"type":"string","format":"uri","nullable":true}},"required":["return_url","cancel_url"]},"next_period_date":{"type":"string","format":"date","nullable":true},"metadata":{"type":"object"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"},"customer":{"type":"string","format":"uri"},"mandate":{"type":"string","format":"uri"},"checkout":{"type":"string","format":"uri"}},"required":["self"]}},"required":["id","type","description","currency","installment_plan_type","state","created_at","customer","mandate","period","first_period","number_of_periods","payment_details","next_period_date","metadata","_links"],"example":{"id":"PIV1QACRO4DSMQT0KK","type":"installment_plan","description":"Test installment plan","currency":"EUR","installment_plan_type":"direct_debit","state":"active","created_at":"2023-07-24T12:40:10Z","customer":"CU7JRN6W6K3DA9","mandate":"MDC7XX65BH42PW","period":{"amount":"1000","vat":"21","multiplier":1,"interval":"month"},"first_period":{"amount":"1000","vat":"21","multiplier":1,"interval":"month"},"number_of_periods":5,"payment_details":{"return_url":null,"cancel_url":null},"next_period_date":null,"metadata":{},"_links":{"self":"https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MDC7XX65BH42PW"}}}},"components/schemas/installment_plan_period":{"id":"components/schemas/installment_plan_period","kind":"json-schema","title":"installment_plan_period","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["installment_plan_period"]},"amount":{"type":"integer"},"period_number":{"type":"integer"},"installment_plan":{"type":"string"},"state":{"type":"string","enum":["open","pending","paid","canceled","reversed","refunded"]},"payments":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/payment"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"created_at":{"type":"string","format":"date-time"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"},"installment_plan":{"type":"string","format":"uri"}},"required":["self","installment_plan"]}},"required":["id","type","amount","period_number","installment_plan","state","payments","created_at","_links"],"example":{"id":"IPD344S1PDY8XX","type":"installment_plan_period","amount":1500,"period_number":1,"installment_plan":"PIUJDW4VCMG9JS","state":"paid","payments":{"type":"list","data":[{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"paid","refunded_amount":0,"return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}}],"count":1,"_links":{"self":"https://api.paypro.nl/installment_plan_periods/SPD344S1PDY8XX/payments"}},"created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/installment_plan_periods/IPD344S1PDY8XX","installment_plan":"https://api.paypro.nl/installment_plans/PIUJDW4VCMG9JS"}}}},"components/schemas/mandate":{"id":"components/schemas/mandate","kind":"json-schema","title":"mandate","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["mandate"]},"state":{"type":"string"},"customer":{"type":"string"},"pay_method":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"},"customer":{"type":"string","format":"uri"}},"required":["self","customer"]}},"required":["id","type","state","customer","pay_method","created_at","_links"],"example":{"id":"MDQVT0CGB8Z5JK","type":"mandate","state":"pending","customer":"CUWSWVVPTL94VX","pay_method":"direct-debit","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/mandates/MDQVT0CGB8Z5JK","customer":"https://api.paypro.nl/customers/CUWSWVVPTL94VX"}}}},"components/schemas/not_found_error":{"id":"components/schemas/not_found_error","kind":"json-schema","title":"not_found_error","data":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"object","additionalProperties":false,"properties":{"message":{"type":"string","description":"The error message"},"type":{"type":"string","description":"Type of error","enum":["invalid_request"]}},"required":["message","type"]}},"required":["error"]}},"components/schemas/null_type":{"id":"components/schemas/null_type","kind":"json-schema","title":"null_type","data":{"enum":[null]}},"components/schemas/pay_method":{"id":"components/schemas/pay_method","kind":"json-schema","title":"pay_method","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["pay_method"]},"name":{"type":"string"},"currencies":{"type":"array","items":{"type":"string","enum":["EUR"]}},"minimum_amount":{"type":"integer"},"maximum_amount":{"type":"integer"},"details":{"type":"object","properties":{"issuers":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}}},"nullable":true},"iban":{"type":"string","nullable":true},"bic":{"type":"string","nullable":true},"account_name":{"type":"string","nullable":true},"routing_number":{"type":"string","nullable":true},"account_number":{"type":"string","nullable":true}}}},"required":["id","type","name"],"example":{"id":"ideal","type":"pay_method","name":"iDEAL | Wero","currencies":["EUR"],"minimum_amount":10,"maximum_amount":5000000,"details":{"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}}}},"components/schemas/payment":{"id":"components/schemas/payment","kind":"json-schema","title":"payment","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["payment"]},"amount":{"type":"integer"},"description":{"type":"string"},"currency":{"type":"string","enum":["EUR"]},"pay_method":{"anyOf":[{"$ref":"#/components/schemas/pay_method"},{"$ref":"#/components/schemas/null_type"}]},"state":{"type":"string"},"refunded_amount":{"type":"integer"},"return_url":{"type":"string","format":"uri","nullable":true},"cancel_url":{"type":"string","format":"uri","nullable":true},"metadata":{"type":"object"},"customer":{"type":"string","nullable":true},"mandate":{"type":"string","nullable":true},"subscription":{"type":"string","nullable":true},"installment_plan":{"type":"string","nullable":true},"locale":{"type":"string","enum":["de","en","fr","nl"],"nullable":true},"paid_at":{"type":"string","format":"date-time","nullable":true},"fail_reason":{"type":"string","enum":["The transaction amount or count exceeds the permitted frequency for this card or account.","The card holder lacks sufficient funds to complete the transaction.","The transaction could not be processed with the provided card number.","The issuer has declined the transaction for authentication reasons.","The transaction is suspected to be fraudulent.","The issuer did not allow this transaction against this card based on internal reasons, such as the transaction originated from a specifically restricted industry or country.","The payment is declined."],"nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"},"customer":{"type":"string","format":"uri"},"mandate":{"type":"string","format":"uri"},"subscription":{"type":"string","format":"uri"},"installment_plan":{"type":"string","format":"uri"},"checkout":{"type":"string","format":"uri"}},"required":["self"]}},"required":["id","type","amount","description","currency","pay_method","state","refunded_amount","return_url","cancel_url","metadata","customer","mandate","subscription","installment_plan","locale","paid_at","created_at","_links"],"example":{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","pay_method":{"id":"ideal","type":"pay_method","name":"iDEAL | Wero","currencies":["EUR"],"minimum_amount":10,"maximum_amount":5000000,"details":{}},"state":"paid","refunded_amount":0,"return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","metadata":{},"customer":"CU7JRN6W6K3DA9","mandate":"MD6ULYXJ4HP9RJ","subscription":null,"installment_plan":null,"locale":"en","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}}}},"components/schemas/payout":{"id":"components/schemas/payout","kind":"json-schema","title":"payout","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["payout"]},"amount":{"type":"integer"},"fee_amount":{"type":"integer"},"fee_vat_amount":{"type":"integer"},"currency":{"type":"string","enum":["EUR"]},"description":{"type":"string"},"state":{"type":"string"},"bank_account":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["sepa"]},"iban":{"type":"string"},"name":{"type":"string"}},"required":["type","iban","name"]},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["ach"]},"account_number":{"type":"string"},"routing_number":{"type":"string"},"name":{"type":"string"}},"required":["type","account_number","routing_number","name"]}]},"metadata":{"type":"object"},"created_at":{"type":"string","format":"date-time","nullable":true},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"}},"required":["self"]}},"required":["id","type","amount","fee_amount","fee_vat_amount","currency","description","state","bank_account","metadata","created_at","_links"],"example":{"id":"POKHCDCQPS4GAA","type":"payout","amount":12300,"fee_amount":0,"fee_vat_amount":0,"currency":"EUR","description":"Payout #1","state":"pending","bank_account":{"type":"sepa","iban":"NL18RABO0123459876","name":"Rabobank"},"metadata":{},"created_at":"2025-05-28T14:52:26Z","_links":{"self":"https://api.paypro.nl/payouts/POKHCDCQPS4GAA"}}}},"components/schemas/refund":{"id":"components/schemas/refund","kind":"json-schema","title":"refund","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["refund"]},"amount":{"type":"integer"},"description":{"type":"string"},"reason":{"type":"string","nullable":true},"currency":{"type":"string","enum":["EUR"]},"payment":{"type":"string"},"state":{"type":"string"},"metadata":{"type":"object"},"refunded_at":{"type":"string","format":"date-time","nullable":true},"fail_reason":{"type":"string","enum":["Not enough balance in your PayPro account","Missing details","Declined (by PayPro or bank)","Payment is not refundable anymore","Unknown"],"nullable":true},"created_at":{"type":"string","format":"date-time"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"},"payment":{"type":"string","format":"uri"}},"required":["self","payment"]}},"required":["id","type","amount","description","reason","payment","currency","state","refunded_at","created_at","metadata","_links"],"example":{"id":"PRRNQH3PCD125Z","type":"refund","amount":1000,"description":"Test Payment","reason":"","payment":"PPBLGEE6UG92MS","currency":"EUR","state":"refunded","metadata":{},"refunded_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/refunds/PRRNQH3PCD125Z","payment":"https://api.paypro.nl/payments/PPBLGEE6UG92MS"}}}},"components/schemas/request_create_customer":{"id":"components/schemas/request_create_customer","kind":"json-schema","title":"request_create_customer","data":{"type":"object","additionalProperties":false,"properties":{"email":{"type":"string","description":"Customer's email address","nullable":true},"first_name":{"type":"string","description":"Customer's first name","nullable":true},"last_name":{"type":"string","description":"Customer's last name","nullable":true},"address":{"type":"string","description":"Customer's address","nullable":true},"postal":{"type":"string","description":"Customer's postal code or ZIP","nullable":true},"city":{"type":"string","description":"Customer's city","nullable":true},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's country in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-3166-1 alpha-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, example: 'NL'"},"children":[]}]}]}],"nullable":true},"vat_number":{"type":"string","description":"Customer's company vat number","nullable":true},"company_name":{"type":"string","description":"Customer's company name","nullable":true},"phone_number":{"type":"string","description":"Customer's phone number","nullable":true}},"example":{"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"}}},"components/schemas/request_create_installment_plan":{"id":"components/schemas/request_create_installment_plan","kind":"json-schema","title":"request_create_installment_plan","data":{"type":"object","additionalProperties":false,"properties":{"customer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the customer for installment plan. Cannot be used together with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"mandate":{"type":"string","description":"ID of the mandate for installment plan"},"description":{"type":"string","description":"Description of the installment plan. This will be shown to customers"},"currency":{"type":"string","description":"The currency of the installment plan. Only 'EUR' is supported"},"pay_methods":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay methods that can be used to start the subscription. Using this creates the subscription with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow and will start the subscription when the first payment is paid. Use the checkout link in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to redirect the customer. Cannot be used together with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","enum":["bancontact","bank-transfer","creditcard","direct-debit","ideal","ideal-qr","klarna-paynow"]},"nullable":true},"payment_details":{"type":"object","description":"Fields to be passed to the authorization payment.","additionalProperties":false,"properties":{"return_url":{"type":"string","description":"The URL where the customer will be send to after the payment has been processed.","format":"uri","nullable":true},"cancel_url":{"type":"string","description":"The URL where the customer will be send to after the payment has been canceled by the customer.","format":"uri","nullable":true},"issuer":{"type":"string","deprecated":true,"description":"Specifying the iDEAL issuer is deprecated and will be ignored if provided.","enum":["SNSBNL2A","ASNBNL21","ABNANL2A","BUNQNL2A","KNABNL2H","RABONL2U","REVOLT21","RBRBNL21","TRIONL2U","FVLBNL22","INGBNL2A","BITSNL2A","NTSBDEB1","NNBANL2G"],"nullable":true}}},"period":{"type":"object","additionalProperties":false,"description":"Settings for when new periods should be created and with which amounts","properties":{"amount":{"type":"integer","description":"The amount in cents that the customer will have to pay."},"vat":{"type":"number","description":"The vat included in the amount. Accepted values: from 0 till 30","nullable":true},"interval":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interval of each period. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]}]}]}]},"multiplier":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The multiplier of the interval between periods. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval=month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mulitplier=3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will create a new period every 3 months."},"children":[]}]}]}]}}},"first_period":{"type":"object","additionalProperties":false,"description":"Settings for when the first period should be created and with what amount","nullable":true,"properties":{"amount":{"type":"integer","description":"The amount in cents that the customer will have to pay."},"vat":{"type":"number","description":"The vat included in the amount. Accepted values: from 0 till 30","nullable":true},"interval":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interval of each period. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]}]}]}]},"multiplier":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The multiplier of the interval between periods. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval=month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mulitplier=3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will create a new period every 3 months."},"children":[]}]}]}]}}},"number_of_periods":{"type":"integer","description":"The number of installment plan periods."},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"nullable":true}},"required":["customer","description","currency","period","number_of_periods"],"example":{"customer":"CUW78XU8BYL8X6","pay_methods":["creditcard","direct-debit","ideal"],"description":"description","currency":"EUR","period":{"amount":1000,"vat":21,"multiplier":1,"type":"month"},"number_of_periods":5}}},"components/schemas/request_create_mandate":{"id":"components/schemas/request_create_mandate","kind":"json-schema","title":"request_create_mandate","data":{"type":"object","additionalProperties":false,"properties":{"customer":{"type":"string","description":"The reference of the Customer you want to create the mandate for."},"pay_method":{"type":"string","description":"The payment method of the mandate. Only 'direct-debit' is supported.","enum":["direct-debit"]},"iban":{"type":"string","description":"When using 'direct-debit', this is the IBAN of the bank account.","nullable":true},"account_holder_name":{"type":"string","description":"When using 'direct-debit', this is the name of the account holder.","nullable":true}},"required":["customer","pay_method"],"example":{"customer":"CUWSWVVPTL94VX","pay_method":"direct-debit","iban":"NL47ABNA0612205029","account_holder_name":"PayPro"}}},"components/schemas/request_create_payment":{"id":"components/schemas/request_create_payment","kind":"json-schema","title":"request_create_payment","data":{"type":"object","additionalProperties":false,"properties":{"amount":{"type":"integer","description":"The amount that the customer will have to pay."},"currency":{"type":"string","description":"The currency of the payment. Only 'EUR' is supported.","enum":["EUR"]},"description":{"type":"string","description":"The description of the payment. This will be shown to your customer and will be visible in the dashboard."},"return_url":{"type":"string","description":"The URL where the customer will be send to after the payment has been processed.","format":"uri","nullable":true},"cancel_url":{"type":"string","description":"The URL where the customer will be send to after the payment has been canceled by the customer.","format":"uri","nullable":true},"pay_methods":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The allowed pay methods of the payment. If only one pay method is specified, it will be set as the payment pay method. Cannot be used together with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","enum":["afterpay","bancontact","bank-transfer","creditcard","direct-debit","ideal","ideal-qr","klarna-paynow","paypal"]},"nullable":true},"issuer":{"type":"string","deprecated":true,"description":"Specifying the iDEAL issuer is deprecated and will be ignored if provided.","enum":["SNSBNL2A","ASNBNL21","ABNANL2A","BUNQNL2A","KNABNL2H","RABONL2U","REVOLT21","RBRBNL21","TRIONL2U","FVLBNL22","INGBNL2A","BITSNL2A","NTSBDEB1","NNBANL2G"],"nullable":true},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"nullable":true},"customer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the customer that pays. This field is optional, if nothing is given we create a new Customer. Cannot be used together with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"mandate":{"type":"string","description":"ID of the mandate for payment","nullable":true},"setup_mandate":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the payment should create a mandate after it has been paid. This allows to setup recurring payments without the need to use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InstallmentPlan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Needs the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to be set as well. Cannot be used together with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"locale":{"type":"string","description":"Specifies the language to be used for the payment pages shown to the customer. If no locale or an invalid locale is specified we will ignore it and choose the locale based on the account settings or the locale used by the customer.","enum":["de","en","fr","nl"],"nullable":true}},"required":["amount","currency","description"],"example":{"amount":1000,"currency":"EUR","description":"Test Payment","return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","pay_methods":["ideal","creditcard","paypal"]}}},"components/schemas/request_create_payout":{"id":"components/schemas/request_create_payout","kind":"json-schema","title":"request_create_payout","data":{"type":"object","additionalProperties":false,"properties":{"amount":{"type":"integer","description":"The amount that will be withdrawn from your balance."},"currency":{"type":"string","description":"The currency of the payout.","enum":["EUR"]},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can put in random data that you like to save alongside the payout. When you fetch the payout this will be returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"nullable":true}},"required":["amount","currency"],"example":{"amount":10000,"currency":"EUR"}}},"components/schemas/request_create_refund":{"id":"components/schemas/request_create_refund","kind":"json-schema","title":"request_create_refund","data":{"type":"object","additionalProperties":false,"properties":{"amount":{"type":"integer","description":"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":{"type":"string","description":"The description of the refund. This will be shown to your customer and will be visible in the dashboard.","default":"The description of the payment.","nullable":true},"reason":{"type":"string","description":"The reason for this refund.","nullable":true},"account_holder_name":{"type":"string","description":"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.","nullable":true},"iban":{"type":"string","description":"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."},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can put in random data that you like to save alongside the refund. When you fetch the refund this will be returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"nullable":true}},"required":["amount"],"example":{"amount":1000,"description":"Test Refund","reason":"Customer requested","account_holder_name":"John Doe","iban":"NL02ABNA0123456789"}}},"components/schemas/request_create_subscription":{"id":"components/schemas/request_create_subscription","kind":"json-schema","title":"request_create_subscription","data":{"type":"object","additionalProperties":false,"properties":{"customer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the customer that subscribes. Cannot be used together with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":{"type":"string","description":"Description of the subscription. This will be shown to customers and in the PayPro dashboard"},"mandate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandate that will be used for the subscription. Using this will start the subscription immediately. Cannot be used together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pay_methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"nullable":true},"currency":{"type":"string","description":"The currency of the subscription. Only 'EUR' is supported"},"start_at":{"type":"string","description":"Date when the subscription will start. When left empty, it will start at creation","nullable":true},"cancel_at":{"type":"string","description":"Date at which the subscription will be canceled. When left empty, the subscription will be active until manually canceled","nullable":true},"pay_methods":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay methods that can be used to start the subscription. Using this creates the subscription with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow and will start the subscription when the first payment is paid. Use the checkout link in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to redirect the customer. Cannot be used together with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","enum":["bancontact","bank-transfer","creditcard","direct-debit","ideal","ideal-qr","klarna-paynow"]},"nullable":true},"payment_details":{"type":"object","description":"Fields to be passed to the authorization payment.","additionalProperties":false,"properties":{"return_url":{"type":"string","description":"The URL where the customer will be send to after the payment has been processed.","format":"uri","nullable":true},"cancel_url":{"type":"string","description":"The URL where the customer will be send to after the payment has been canceled by the customer.","format":"uri","nullable":true},"issuer":{"type":"string","deprecated":true,"description":"Specifying the iDEAL issuer is deprecated and will be ignored if provided.","enum":["SNSBNL2A","ASNBNL21","ABNANL2A","BUNQNL2A","KNABNL2H","RABONL2U","REVOLT21","RBRBNL21","TRIONL2U","FVLBNL22","INGBNL2A","BITSNL2A","NTSBDEB1","NNBANL2G"],"nullable":true}}},"period":{"type":"object","additionalProperties":false,"description":"Settings for when new periods should be created and with which amounts","properties":{"amount":{"type":"integer","description":"The amount in cents that the customer will have to pay."},"vat":{"type":"number","description":"The vat included in the amount. Accepted values: from 0 till 30","nullable":true},"interval":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interval of each period. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]}]}]}]},"multiplier":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The multiplier of the interval between periods. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval=month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mulitplier=3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will create a new period every 3 months."},"children":[]}]}]}]}}},"first_period":{"type":"object","additionalProperties":false,"description":"Settings for when the first period should be created and with what amount","nullable":true,"properties":{"amount":{"type":"integer","description":"The amount in cents that the customer will have to pay."},"vat":{"type":"number","description":"The vat included in the amount. Accepted values: from 0 till 30","nullable":true},"interval":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interval of each period. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]}]}]}]},"multiplier":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The multiplier of the interval between periods. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval=month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mulitplier=3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will create a new period every 3 months."},"children":[]}]}]}]}}},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"nullable":true}},"required":["customer","description","currency","period"],"example":{"customer":"CUW78XU8BYL8X6","pay_methods":["creditcard","direct-debit","ideal"],"description":"description","currency":"EUR","start_at":"2023-08-01","period":{"amount":1000,"vat":21,"multiplier":1,"type":"month"}}}},"components/schemas/request_create_subscription_period":{"id":"components/schemas/request_create_subscription_period","kind":"json-schema","title":"request_create_subscription_period","data":{"type":"object","additionalProperties":false,"properties":{"amount":{"type":"integer","description":"The amount that the customer will have to pay in the next period."},"description":{"type":"string","description":"Description of the subscription. This will be shown to customers and in the PayPro dashboard"}},"required":["amount"],"example":{"amount":1000}}},"components/schemas/request_create_top_up":{"id":"components/schemas/request_create_top_up","kind":"json-schema","title":"request_create_top_up","data":{"type":"object","additionalProperties":false,"properties":{"amount":{"type":"integer","description":"The amount that the customer will have to pay."},"currency":{"type":"string","description":"The currency of the top-up.","enum":["EUR"]},"description":{"type":"string","description":"The description of the top-up.","nullable":true},"pay_method":{"type":"string","description":"The pay method of the top-up.","enum":["bancontact","bank-transfer","ideal"],"nullable":true},"locale":{"type":"string","description":"Specifies the language to be used for the top-up page. If no locale or an invalid locale is specified we will ignore it and choose the locale based on the account settings.","enum":["de","en","fr","nl"],"nullable":true},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can put in random data that you like to save alongside the top-up. When you fetch the top-up this will be returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"nullable":true}},"required":["amount"],"example":{"amount":1000,"currency":"EUR"}}},"components/schemas/request_create_webhook":{"id":"components/schemas/request_create_webhook","kind":"json-schema","title":"request_create_webhook","data":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","description":"Description of the webhook. It describes what this webhook is used for."},"name":{"type":"string","description":"Name of the webhook."},"url":{"type":"string","description":"The URL of the webhook endpoint","format":"uri"},"active":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this webhook endpoint will receive events."},"children":[]}]}]}],"default":true,"nullable":true},"enabled_event_types":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event types that will be sent to the webhook endpoint. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not supplied, all event types will be sent. Also, you can supply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['all']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable all event types."},"children":[]}]}]}],"items":{"anyOf":[{"$ref":"#/components/schemas/all_event_types"},{"$ref":"#/components/schemas/event_types"}]},"nullable":true}},"example":{"name":"Webhook name","description":"Webhook description","url":"https://www.example.org/webhook","active":true,"enabled_event_types":["all"]}}},"components/schemas/request_update_customer":{"id":"components/schemas/request_update_customer","kind":"json-schema","title":"request_update_customer","data":{"type":"object","additionalProperties":false,"properties":{"email":{"type":"string","description":"Customer's email address","nullable":true},"first_name":{"type":"string","description":"Customer's first name","nullable":true},"last_name":{"type":"string","description":"Customer's last name","nullable":true},"address":{"type":"string","description":"Customer's address","nullable":true},"postal":{"type":"string","description":"Customer's postal code or ZIP","nullable":true},"city":{"type":"string","description":"Customer's city","nullable":true},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's country in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-3166-1 alpha-2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, example: 'NL'"},"children":[]}]}]}],"nullable":true},"vat_number":{"type":"string","description":"Customer's company vat number","nullable":true},"company_name":{"type":"string","description":"Customer's company name","nullable":true},"phone_number":{"type":"string","description":"Customer's phone number","nullable":true}},"example":{"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"}}},"components/schemas/request_update_installment_plan":{"id":"components/schemas/request_update_installment_plan","kind":"json-schema","title":"request_update_installment_plan","data":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","description":"Description of the installment plan. This will be shown to customers and in the PayPro dashboard"},"mandate":{"type":"string","description":"ID of the mandate for installment plan. Only approved 'direct-debit' customer's mandates are supported."},"number_of_periods":{"type":"number","minimum":1},"period":{"type":"object","additionalProperties":false,"description":"Settings for when new periods should be created and with which amounts. When the Installment plan is active updates to these settings will only affect new periods.","properties":{"amount":{"type":"integer","description":"The amount in cents that the customer will have to pay."},"interval":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interval of each period. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]}]}]}]},"multiplier":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The multiplier of the interval between periods. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval=month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mulitplier=3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will create a new period every 3 months."},"children":[]}]}]}]}}},"first_period":{"type":"object","additionalProperties":false,"description":"Settings for when the first period should be created and with what amount. These settings can only be updated if the Installment plan has not started yet.","nullable":true,"properties":{"amount":{"type":"integer","description":"The amount in cents that the customer will have to pay."},"interval":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interval of each period. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]}]}]}]},"multiplier":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The multiplier of the interval between periods. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval=month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mulitplier=3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will create a new period every 3 months."},"children":[]}]}]}]}}},"next_debit_date":{"type":"string","description":"Date when the next payment period will be collected","nullable":true}},"example":{"description":"description","period":{"amount":1000}}}},"components/schemas/request_update_subscription":{"id":"components/schemas/request_update_subscription","kind":"json-schema","title":"request_update_subscription","data":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","description":"Description of the subscription. This will be shown to customers and in the PayPro dashboard"},"mandate":{"type":"string","description":"ID of the mandate for subscription. Only approved 'direct-debit' customer's mandates are supported."},"cancel_at":{"type":"string","description":"Date at which the subscription will be canceled. When left empty, the subscription will be active until manually canceled","nullable":true},"cancel_periods_on_cancellation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", canceling a subscription will also cancel any open and reversed periods."},"children":[]}]}]}],"nullable":true},"period":{"type":"object","additionalProperties":false,"description":"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.","properties":{"amount":{"type":"integer","description":"The amount in cents that the customer will have to pay."},"vat":{"type":"number","description":"The vat included in the amount. Accepted values: from 0 till 30","nullable":true},"interval":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interval of each period. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]}]}]}]},"multiplier":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The multiplier of the interval between periods. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval=month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mulitplier=3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will create a new period every 3 months."},"children":[]}]}]}]}}},"first_period":{"type":"object","additionalProperties":false,"description":"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.","nullable":true,"properties":{"amount":{"type":"integer","description":"The amount in cents that the customer will have to pay."},"vat":{"type":"number","description":"The vat included in the amount. Accepted values: from 0 till 30","nullable":true},"interval":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interval of each period. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]}]}]}]},"multiplier":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The multiplier of the interval between periods. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval=month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mulitplier=3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will create a new period every 3 months."},"children":[]}]}]}]}}},"next_debit_date":{"type":"string","description":"Date when the next payment period will be collected","nullable":true}},"example":{"description":"description","period":{"amount":1000}}}},"components/schemas/request_update_webhook":{"id":"components/schemas/request_update_webhook","kind":"json-schema","title":"request_update_webhook","data":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","description":"Description of the webhook. It describes what this webhook is used for.","nullable":true},"name":{"type":"string","description":"Name of the webhook.","nullable":true},"url":{"type":"string","description":"The URL of the webhook endpoint","format":"uri","nullable":true},"active":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this webhook endpoint will receive events."},"children":[]}]}]}],"nullable":true},"enabled_event_types":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event types that will be sent to the webhook endpoint. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"['all']"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter can be supplied to enable all event types"},"children":[]}]}]}],"items":{"anyOf":[{"$ref":"#/components/schemas/all_event_types"},{"$ref":"#/components/schemas/event_types"}]},"nullable":true}},"example":{"name":"Webhook name","description":"Webhook description","url":"https://www.example.org/webhook","active":true,"enabled_event_types":["payment.created","payment.paid"]}}},"components/schemas/subscription":{"id":"components/schemas/subscription","kind":"json-schema","title":"subscription","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["subscription"]},"description":{"type":"string"},"subscription_type":{"type":"string","enum":["direct_debit"],"nullable":true},"state":{"type":"string"},"currency":{"type":"string","enum":["EUR"]},"created_at":{"type":"string","format":"date-time"},"start_at":{"type":"string","format":"date","nullable":true},"cancel_at":{"type":"string","format":"date","nullable":true},"customer":{"type":"string","nullable":true},"mandate":{"type":"string","nullable":true},"scheduling":{"type":"string","enum":["manual","automatic"],"nullable":true},"cancel_periods_on_cancellation":{"type":"boolean"},"period":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"amount":{"type":"integer"},"vat":{"type":"number","minimum":0,"maximum":100},"multiplier":{"type":"integer"},"interval":{"type":"string","enum":["day","week","month","year"]}},"required":["amount","vat","multiplier","interval"]},"first_period":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"amount":{"type":"integer"},"vat":{"type":"number","minimum":0,"maximum":100},"multiplier":{"type":"integer"},"interval":{"type":"string","enum":["day","week","month","year"]}},"required":["amount","vat"]},"payment_details":{"type":"object","additionalProperties":false,"properties":{"return_url":{"type":"string","format":"uri","nullable":true},"cancel_url":{"type":"string","format":"uri","nullable":true}},"required":["return_url","cancel_url"]},"next_period_date":{"type":"string","format":"date","nullable":true},"available_until":{"type":"string","format":"date","nullable":true},"metadata":{"type":"object"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"},"customer":{"type":"string","format":"uri"},"mandate":{"type":"string","format":"uri"},"checkout":{"type":"string","format":"uri"}},"required":["self"]}},"required":["id","type","description","currency","subscription_type","state","start_at","created_at","cancel_at","customer","mandate","period","first_period","payment_details","next_period_date","available_until","metadata","_links"],"example":{"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","cancel_periods_on_cancellation":false,"period":{"amount":"1000","vat":"21","multiplier":1,"interval":"month"},"first_period":{"amount":"1000","vat":"21","multiplier":1,"interval":"month"},"payment_details":{"return_url":null,"cancel_url":null},"next_period_date":null,"available_until":null,"metadata":{},"_links":{"self":"https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}}}},"components/schemas/subscription_period":{"id":"components/schemas/subscription_period","kind":"json-schema","title":"subscription_period","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["subscription_period"]},"amount":{"type":"integer"},"period_number":{"type":"integer"},"subscription":{"type":"string"},"state":{"type":"string","enum":["open","pending","paid","canceled","reversed","refunded"]},"payments":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/payment"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"created_at":{"type":"string","format":"date-time"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"},"subscription":{"type":"string","format":"uri"}},"required":["self","subscription"]}},"required":["id","type","amount","period_number","subscription","state","payments","created_at","_links"],"example":{"id":"SPD344S1PDY8XX","type":"subscription_period","amount":1500,"period_number":1,"subscription":"PSUJDW4VCMG9JS","state":"paid","payments":{"type":"list","data":[{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"paid","refunded_amount":0,"return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}}],"count":1,"_links":{"self":"https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX/payments"}},"created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX","subscription":"https://api.paypro.nl/subscriptions/PSUJDW4VCMG9JS"}}}},"components/schemas/top_up":{"id":"components/schemas/top_up","kind":"json-schema","title":"top_up","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["top_up"]},"amount":{"type":"integer"},"description":{"type":"string"},"currency":{"type":"string","enum":["EUR"]},"pay_method":{"anyOf":[{"$ref":"#/components/schemas/pay_method"},{"$ref":"#/components/schemas/null_type"}]},"state":{"type":"string"},"locale":{"type":"string","enum":["de","en","fr","nl"],"nullable":true},"metadata":{"type":"object"},"paid_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"},"checkout":{"type":"string","format":"uri"}},"required":["self"]}},"required":["id","type","amount","description","currency","pay_method","state","locale","metadata","paid_at","created_at","_links"],"example":{"id":"TUMKR465ZG6QDU","type":"top_up","amount":12300,"currency":"EUR","description":"Top-up TUMKR465ZG6QDU","pay_method":{"id":"ideal","type":"pay_method","name":"iDEAL | Wero","currencies":["EUR"],"minimum_amount":1,"maximum_amount":5000000,"details":{}},"locale":"en","state":"paid","metadata":{},"created_at":"2025-05-28T14:52:26Z","paid_at":"2025-05-28T14:53:03Z","_links":{"self":"http://api.paypro.test:3000/top_ups/TUMKR465ZG6QDU"}}}},"components/schemas/webhook":{"id":"components/schemas/webhook","kind":"json-schema","title":"webhook","data":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["webhook"]},"name":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean"},"url":{"type":"string","format":"uri"},"secret":{"type":"string"},"enabled_event_types":{"type":"array","items":{"$ref":"#/components/schemas/event_types"}},"created_at":{"type":"string","format":"date-time"},"_links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","format":"uri"}},"required":["self"]}},"required":["id","type","name","description","active","url","secret","created_at","_links"],"example":{"id":"WHXFPVRLXYL3U7","type":"webhook","name":"Webhook Name","description":"Webhook Description","active":true,"url":"https://example.com/webhook","secret":"V9xVoX4sVJE8x41hATbFYZJ5qd6HALhN","enabled_event_types":["payment.created","payment.paid"],"created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/webhooks/WHXFPVRLXYL3U7"}}}},"components/schemas/event_types":{"id":"components/schemas/event_types","kind":"json-schema","title":"event_types","data":{"type":"string","enum":["currency_conversion.created","customer.created","customer.updated","chargeback.created","payout.created","payout.approved","payout.rejected","payout.failed","payout.paid","payment.created","payment.started","payment.canceled","payment.failed","payment.paid","payment.expired","refund.created","refund.canceled","refund.failed","refund.refunded","refund.expired","subscription.created","subscription.started","subscription.canceled","subscription.paused","subscription.resumed","subscription.updated","subscription.completed","installment_plan.created","installment_plan.started","installment_plan.canceled","installment_plan.paused","installment_plan.resumed","installment_plan.updated","installment_plan.completed","topup.created","topup.started","topup.canceled","topup.failed","topup.paid","topup.expired"]}},"schema_18":{"kind":"json-schema","data":{"type":"string"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/payment"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/chargeback"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/refund"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/pay_method"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/customer"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/subscription"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/mandate"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/subscription_period"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/installment_plan"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/installment_plan_period"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/event"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/webhook"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/balance_transaction"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/balance"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/currency_conversion"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/payout"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/top_up"}},"count":{"type":"integer"},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"next":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri"}},"required":["self"]}},"required":["type","data","count","_links"]},"id":"schema_35"}},"exampleStore":{},"securitySchemeStore":{"apiKey":{"id":"apiKey","type":"http","scheme":"bearer","bearerFormat":"API key"}},"servers":[{"url":"https://api.paypro.nl"}],"specType":"openapi"},"options":{"hideDownloadButtons":true,"hideInfoMetadata":true,"hideReplay":true,"codeSamples":{"languages":[]},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/reference/api.json?download"},{"url":"/_bundle/reference/api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"PayPro API Reference"}},"baseSlug":"/reference/api","routesMapping":{}}