hryvinskyi/reepay-api

2.0.3 2023-03-27 22:11 UTC

This package is auto-updated.

Last update: 2024-04-04 21:36:55 UTC


README

REST API to manage Reepay resources

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/hryvinskyi/reepay-api.git"
    }
  ],
  "require": {
    "hryvinskyi/reepay-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->createPrivateKey();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->createPrivateKey: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->createPublicKey();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->createPublicKey: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$key = "key_example"; // string | Private key

try {
    $apiInstance->expirePrivateKey($key);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->expirePrivateKey: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$key = "key_example"; // string | Public key

try {
    $apiInstance->expirePublicKey($key);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->expirePublicKey: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->generateWebhookSecret();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->generateWebhookSecret: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getCurrentAccount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getCurrentAccount: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getDiscountSettings();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getDiscountSettings: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getMailSettings();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getMailSettings: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getMfaSettings();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getMfaSettings: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getPrivateKeys();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getPrivateKeys: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getPublicKeys();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getPublicKeys: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getTerms();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getTerms: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getWebhookSettings();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getWebhookSettings: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Reepay\Model\UpdateAccount(); // \Reepay\Model\UpdateAccount | 

try {
    $result = $apiInstance->updateAccountJson($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->updateAccountJson: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Reepay\Model\DiscountSettings(); // \Reepay\Model\DiscountSettings | 

try {
    $result = $apiInstance->updateDiscountSettings($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->updateDiscountSettings: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Reepay\Model\MailSettings(); // \Reepay\Model\MailSettings | 

try {
    $result = $apiInstance->updateMailSettingsJson($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->updateMailSettingsJson: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Reepay\Model\AccountMfaSettings(); // \Reepay\Model\AccountMfaSettings | 

try {
    $result = $apiInstance->updateMfaSettings($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->updateMfaSettings: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Reepay\Model\Terms(); // \Reepay\Model\Terms | 

try {
    $result = $apiInstance->updateTerms($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->updateTerms: ', $e->getMessage(), PHP_EOL;
}
// Configure HTTP basic authorization: basicAuth
$config = Reepay\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Reepay\Model\UpdateWebhookSettings(); // \Reepay\Model\UpdateWebhookSettings | 

try {
    $result = $apiInstance->updateWebhookSettingsJson($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->updateWebhookSettingsJson: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://api.reepay.com/api.reepay.com

Class Method HTTP request Description
AccountApi createPrivateKey POST /v1/account/privkey Create private key
AccountApi createPublicKey POST /v1/account/pubkey Create public key
AccountApi expirePrivateKey POST /v1/account/privkey/{key}/expire Expire private key
AccountApi expirePublicKey POST /v1/account/pubkey/{key}/expire Expire public key
AccountApi generateWebhookSecret POST /v1/account/webhook_settings/secret Generate new webhook secret
AccountApi getCurrentAccount GET /v1/account Get account
AccountApi getDiscountSettings GET /v1/account/discount_settings Get discount settings
AccountApi getMailSettings GET /v1/account/mail_settings Get mail settings
AccountApi getMfaSettings GET /v1/account/mfa_settings Get account MFA settings
AccountApi getPrivateKeys GET /v1/account/privkey Get list of private keys
AccountApi getPublicKeys GET /v1/account/pubkey Get list of public keys
AccountApi getTerms GET /v1/account/terms Get terms
AccountApi getWebhookSettings GET /v1/account/webhook_settings Get webhook settings
AccountApi updateAccountJson PUT /v1/account Update account
AccountApi updateDiscountSettings PUT /v1/account/discount_settings Update discount settings
AccountApi updateMailSettingsJson PUT /v1/account/mail_settings Update mail settings
AccountApi updateMfaSettings PUT /v1/account/mfa_settings Update account MFA settings
AccountApi updateTerms POST /v1/account/terms Create or update terms
AccountApi updateWebhookSettingsJson PUT /v1/account/webhook_settings Update webhook settings
AddOnApi createAddOn POST /v1/add_on Create add-on
AddOnApi deleteAddOn DELETE /v1/add_on/{handle} Delete add-on
AddOnApi deleteMetadata DELETE /v1/add_on/{handle}/metadata Delete metadata
AddOnApi getAddOn GET /v1/add_on/{handle} Get add-on
AddOnApi getMetadata GET /v1/add_on/{handle}/metadata Get metadata
AddOnApi undeleteAddOn POST /v1/add_on/{handle}/undelete Un-delete add-on
AddOnApi updateAddOn PUT /v1/add_on/{handle} Update add-on
AddOnApi updateMetadata PUT /v1/add_on/{handle}/metadata Create or update metadata
AdditionalCostApi cancelAdditionalCost POST /v1/additional_cost/{handle}/cancel Cancel pending additional cost
AdditionalCostApi createAdditionalCostJson POST /v1/additional_cost Create additional cost
AdditionalCostApi getAdditionalCost GET /v1/additional_cost/{handle} Get additional cost
AdditionalCostApi getAdditionalCosts GET /v1/additional_cost/subscription/{handle} Get additional costs for subscription
AgreementApi activateMpsAgreement POST /v1/agreement/{id}/mps_activate Activate mps agreement by selecting provider
AgreementApi createAnydayAgreement POST /v1/agreement/anyday Create Anyday agreement
AgreementApi createApplepayAgreement POST /v1/agreement/applepay Create ApplePay agreement
AgreementApi createCardGatewayAgreement POST /v1/agreement/card_gateway Create card gateway agreement
AgreementApi createGooglepayAgreement POST /v1/agreement/googlepay Create GooglePay agreement
AgreementApi createKlarnaAgreement POST /v1/agreement/klarna Create Klarna agreement
AgreementApi createMpoAgreement POST /v1/agreement/mpo Create MobilePay Online agreement
AgreementApi createMpsAgreement POST /v1/agreement/mps Create pending MobilePay Subscriptions agreement
AgreementApi createOfflineAgreement POST /v1/agreement/offline Create offline agreement
AgreementApi createPayeverAgreement POST /v1/agreement/payever Create Payever agreement
AgreementApi createPaypalAgreement POST /v1/agreement/paypal Create PayPal agreement
AgreementApi createPproAgreement POST /v1/agreement/ppro Create ppro agreement
AgreementApi createResursAgreement POST /v1/agreement/resurs Create Resurs agreement
AgreementApi createSwishAgreement POST /v1/agreement/swish Create Swish agreement
AgreementApi createViabillAgreement POST /v1/agreement/viabill Create ViaBill agreement
AgreementApi createVippsAgreement POST /v1/agreement/vipps Create Vipps agreement
AgreementApi createVippsRecurringAgreement POST /v1/agreement/vipps_recurring Create Vipps Recurring agreement
AgreementApi deleteGatewayAgreement DELETE /v1/agreement/{id} Delete gateway agreement
AgreementApi disableGatewayAgreement POST /v1/agreement/{id}/disable Disable gateway agreement
AgreementApi enableGatewayAgreement POST /v1/agreement/{id}/enable Enable gateway agreement
AgreementApi getCardGatewayAgreements GET /v1/agreement/card_gateway Get all card gateway agreements
AgreementApi getGatewayAgreement GET /v1/agreement/{id} Get gateway agreement
AgreementApi getGatewayAgreements GET /v1/agreement Get all agreements
AgreementApi onboardMerchant POST /v1/agreement/vipps_recurring/onboard Onboard Merchant
AgreementApi updateAnydayAgreement PUT /v1/agreement/anyday/{id} Update Anyday agreement
AgreementApi updateApplepayAgreement PUT /v1/agreement/applepay/{id} Update ApplePay agreement
AgreementApi updateCardGatewayAgreement PUT /v1/agreement/card_gateway/{id} Update card gateway agreement
AgreementApi updateEmvConfiguration PUT /v1/agreement/{id}/card_gateway/emv_configuration Update card gateway EMV Configuration
AgreementApi updateFeeConfiguration PUT /v1/agreement/{id}/card_gateway/fee_configuration Update card gateway fee configuration
AgreementApi updateGooglepayAgreement PUT /v1/agreement/googlepay/{id} Update GooglePay agreement
AgreementApi updateKlarnaAgreement PUT /v1/agreement/klarna/{id} Update Klarna agreement
AgreementApi updateMpsAgreement PUT /v1/agreement/mps/{id} Update mps agreement
AgreementApi updateOfflineAgreement PUT /v1/agreement/offline/{id} Update offline agreement
AgreementApi updatePayeverAgreement PUT /v1/agreement/payever/{id} Update Payever agreement
AgreementApi updatePaypalAgreement PUT /v1/agreement/paypal/{id} Update PayPal agreement
AgreementApi updatePproAgreement PUT /v1/agreement/ppro/{id} Update ppro agreement
AgreementApi updateResursAgreement PUT /v1/agreement/resurs/{id} Update Resurs agreement
AgreementApi updateSurcharge PUT /v1/agreement/{id}/card_gateway/surcharge Update card gateway surcharge
AgreementApi updateSwishAgreement PUT /v1/agreement/swish/{id} Update Swish agreement
AgreementApi updateViabillAgreement PUT /v1/agreement/viabill/{id} Update ViaBill agreement
AgreementApi updateVippsAgreement PUT /v1/agreement/vipps/{id} Update Vipps agreement
AgreementApi updateVippsRecurringAgreement PUT /v1/agreement/vipps_recurring/{id} Update Vipps Recurring agreement
AuthenticateApi login POST /v1/authenticate/login User login
AuthenticateApi renew POST /v1/authenticate/renew Renew user login
AuthenticateApi verifyAuthentication GET /v1/authenticate/verify Verify authentication
ChargeApi cancelCharge POST /v1/charge/{handle}/cancel Cancel charge
ChargeApi createCharge POST /v1/charge Create charge
ChargeApi deleteCreatedInvoice DELETE /v1/charge/{id} Delete created charge
ChargeApi getCharge GET /v1/charge/{handle} Get charge
ChargeApi offlineSettle POST /v1/charge/{id}/transaction/{transaction}/offline_settle Settle offline transaction
ChargeApi prepareCharge POST /v1/charge/prepare Prepare charge
ChargeApi settleCharge POST /v1/charge/{handle}/settle Settle charge
CouponApi createCoupon POST /v1/coupon Create coupon
CouponApi deleteCoupon DELETE /v1/coupon/{handle} Delete coupon
CouponApi expireCoupon POST /v1/coupon/{handle}/expire Expire coupon
CouponApi getCoupon GET /v1/coupon/{handle} Get coupon
CouponApi updateCoupon PUT /v1/coupon/{handle} Update coupon
CouponApi validateCode GET /v1/coupon/code/validate Validate coupon
CreditApi cancelCredit POST /v1/credit/{handle}/cancel Cancel credit
CreditApi createCreditJson POST /v1/credit Create credit
CreditApi getCredit GET /v1/credit/{handle} Get credit
CreditApi getCredits GET /v1/credit/subscription/{handle} Get credits for subscription
CreditNoteApi getCreditNote GET /v1/credit_note/{id} Get credit note
CustomerApi createCustomerInvoice POST /v1/customer/{handle}/invoice Create invoice for customer
CustomerApi createCustomerJson POST /v1/customer Create customer
CustomerApi createCustomerNoteJson POST /v1/customer/{handle}/note Create customer note
CustomerApi deleteCustomer DELETE /v1/customer/{handle} Delete customer
CustomerApi deleteMetadata1 DELETE /v1/customer/{handle}/metadata Delete metadata
CustomerApi getCustomer GET /v1/customer/{handle} Get customer
CustomerApi getCustomerNotes GET /v1/customer/{handle}/note Get customer notes
CustomerApi getMetadata1 GET /v1/customer/{handle}/metadata Get metadata
CustomerApi updateCustomerJson PUT /v1/customer/{handle} Update customer
CustomerApi updateMetadata1 PUT /v1/customer/{handle}/metadata Create or update metadata
DefaultApi createOrUpdateConfiguration POST /v1/risk/configuration Create or update risk configuration
DefaultApi deleteConfiguration DELETE /v1/risk/configuration Delete risk configuration
DefaultApi getAccountData GET /v1/checkout/account
DefaultApi getBlocklist GET /v1/blocklist
DefaultApi getConfiguration GET /v1/risk/configuration Get risk configuration
DefaultApi getErrorCodes GET /v1/error_codes Get error codes
DefaultApi getSessionData GET /v1/checkout/session
DefaultApi getSwaggerSpec GET /swagger.json
DiscountApi createDiscount POST /v1/discount Create discount
DiscountApi deleteDiscount DELETE /v1/discount/{handle} Delete discount
DiscountApi getDiscount GET /v1/discount/{handle} Get discount
DiscountApi undeleteDiscount POST /v1/discount/{handle}/undelete Undelete discount
DiscountApi updateDiscount PUT /v1/discount/{handle} Update discount
DunningPlanApi createDunningPlanJson POST /v1/dunning_plan Create dunning plan
DunningPlanApi deleteDunningPlan DELETE /v1/dunning_plan/{handle} Delete dunning plan
DunningPlanApi getDunningPlan GET /v1/dunning_plan/{handle} Get dunning plan
DunningPlanApi getDunningPlans GET /v1/dunning_plan Get list of dunning plans
DunningPlanApi updateJson PUT /v1/dunning_plan/{handle} Update dunning plan
EntitlementApi createEntitlement POST /v1/entitlement Create entitlement
EntitlementApi getEntitlements GET /v1/entitlement Get entitlements
EventApi getEvent GET /v1/event/{id} Get event
EventApi getEvents GET /v1/event Get list of events
InvoiceApi cancelAllDunningPending POST /v1/invoice/cancel_all_dunning_pending/subscription/{handle} Cancel all dunning and pending
InvoiceApi cancelInvoice POST /v1/invoice/{id}/cancel Cancel invoice
InvoiceApi cancelSettleLater POST /v1/invoice/{id}/settle/cancel Cancel settle later
InvoiceApi cancelTransaction POST /v1/invoice/{id}/transaction/{transaction}/cancel Cancel transaction
InvoiceApi createOrUpdateBillingAddress PUT /v1/invoice/{id}/billing_address Create or update invoice billing address
InvoiceApi createOrUpdateShippingAddress PUT /v1/invoice/{id}/shipping_address Create or update invoice shipping address
InvoiceApi deleteBillingAddress DELETE /v1/invoice/{id}/billing_address Delete invoice billing address
InvoiceApi deleteMetadata2 DELETE /v1/invoice/{handle}/metadata Delete metadata
InvoiceApi deleteShippingAddress DELETE /v1/invoice/{id}/shipping_address Delete invoice shipping address
InvoiceApi detachFromSubscription POST /v1/invoice/{id}/detach Detach from subscription
InvoiceApi extendKAuthTransaction POST /v1/invoice/{id}/transaction/{transaction}/extend Extend authorization transaction
InvoiceApi extendKlarnaTransaction POST /v1/invoice/{id}/transaction/{transaction}/extend_klarna Extend Klarna authorization transaction
InvoiceApi failInvoice POST /v1/invoice/{id}/fail Fail invoice
InvoiceApi getInvoice GET /v1/invoice/{id} Get invoice
InvoiceApi getMetadata2 GET /v1/invoice/{handle}/metadata Get metadata
InvoiceApi manualSettle POST /v1/invoice/{id}/manual_settle Manual settle
InvoiceApi reactivateInvoice POST /v1/invoice/{id}/reactivate Reactivate invoice
InvoiceApi settle POST /v1/invoice/{id}/settle Settle
InvoiceApi transaction GET /v1/invoice/{id}/transaction/{transaction} Get transaction
InvoiceApi transactionDetails GET /v1/invoice/{id}/transaction/{transaction}/details Get transaction details
InvoiceApi updateMetadata2 PUT /v1/invoice/{handle}/metadata Create or update metadata
InvoiceConfigurationApi createInvoiceSequenceConfiguration POST /v1/invoice_configuration/sequence Set invoice sequence configuration
InvoiceConfigurationApi getDebtorSettings GET /v1/invoice_configuration/debtor_settings Get customer debtor settings
InvoiceConfigurationApi getInvoiceConfiguration GET /v1/invoice_configuration Get invoice configuration
InvoiceConfigurationApi getInvoiceSequenceConfiguration GET /v1/invoice_configuration/sequence Get invoice sequence configuration
InvoiceConfigurationApi updateDebtorSettings POST /v1/invoice_configuration/debtor_settings Create or update customer debtor settings
InvoiceConfigurationApi updateInvoiceConfiguration POST /v1/invoice_configuration Create or update invoice configuration
ListApi getAddOnList GET /v1/list/add_on Get list of add-ons
ListApi getChargeList GET /v1/list/charge Get list of charges
ListApi getCouponList GET /v1/list/coupon Get list of coupons
ListApi getCustomerList GET /v1/list/customer Get list of customers
ListApi getDiscountList GET /v1/list/discount Get list of discounts
ListApi getInvoiceCreditNoteList GET /v1/list/credit_note
ListApi getInvoiceList GET /v1/list/invoice Get list of invoices
ListApi getPaymentMethodList GET /v1/list/payment_method Get list of payment methods
ListApi getPayoutList GET /v1/list/payout Get list of payouts
ListApi getPlanList GET /v1/list/plan Get list of plans
ListApi getSubscriptionList GET /v1/list/subscription Get list of subscriptions
ListApi getTaxPolicyList GET /v1/list/tax_policy Get list of tax policies
ListApi getTransactionList GET /v1/list/transaction Get list of transactions
ListApi getWebhookList GET /v1/list/webhook Get list of webhooks
MailTemplateApi getSample GET /v1/mail_template/sample Get sample data
OrganisationApi getOrganisation GET /v1/organisation Get organisation
OrganisationApi update PUT /v1/organisation Update organisation
PaymentMethodApi activatePaymentMethodV2 POST /v1/payment_method/{id}/activate Activate payment method
PaymentMethodApi addPaymentMethodV2 POST /v1/payment_method Add payment method
PaymentMethodApi cardVerification POST /v1/payment_method/{id}/card/verify Verify card validity
PaymentMethodApi copyCardPaymentMethodV2 POST /v1/payment_method/{id}/card_copy Copy card to customer
PaymentMethodApi deletePaymentMethodV2 DELETE /v1/payment_method/{id} Delete payment method
PaymentMethodApi enrollCardPaymentMethodV2 POST /v1/payment_method/{id}/card_enroll Enroll card to EMV Token
PaymentMethodApi getCardTokenDetails GET /v1/payment_method/card_token/{tokenid}/details Get card token details
PaymentMethodApi getPaymentMethodDetailsV2 GET /v1/payment_method/{id}/details Get payment method details
PaymentMethodApi getPaymentMethodV2 GET /v1/payment_method/{id} Get payment method
PaymentMethodApi importMpsPaymentMethod POST /v1/payment_method/import_mps Import MobilePay Subscription payment method
PaymentMethodApi importVippsRecurringPaymentMethod POST /v1/payment_method/import_vipps_recurring Import Vipps Recurring payment method
PaymentMethodApi inactivatePaymentMethodV2 POST /v1/payment_method/{id}/inactivate Inactivate payment method
PaymentMethodApi moveCardPaymentMethodV2 POST /v1/payment_method/{id}/card_move Move card to other agreement
PaymentMethodApi reactivateCardV2 POST /v1/payment_method/{id}/card_reactivate Reactivate failed card
PayoutApi createPayout POST /v1/payout Create payout
PayoutApi getPayout GET /v1/payout/{handle} Get payout
PayoutApi transactionDetails1 GET /v1/payout/{id}/transaction/{transaction}/details Get transaction details
PlanApi createPlanJson POST /v1/plan Create plan
PlanApi deleteMetadata3 DELETE /v1/plan/{handle}/metadata Delete metadata
PlanApi deletePlan DELETE /v1/plan/{handle} Delete plan
PlanApi getCurrentPlan GET /v1/plan/{handle}/current Get plan
PlanApi getMetadata3 GET /v1/plan/{handle}/metadata Get metadata
PlanApi getPlan GET /v1/plan/{handle}/{version} Get plan version
PlanApi getPlans GET /v1/plan/{handle} Get list of plan versions
PlanApi supersedePlanJson POST /v1/plan/{handle} Supersede plan
PlanApi unDeletePlan POST /v1/plan/{handle}/undelete Undelete plan
PlanApi updateMetadata3 PUT /v1/plan/{handle}/metadata Create or update metadata
PlanApi updatePlanJson PUT /v1/plan/{handle} Update plan
RefundApi createRefund POST /v1/refund Create refund
RefundApi getRefund GET /v1/refund/{id} Get refund
SubscriptionApi activate POST /v1/subscription/{handle}/activate Activate pending subscription
SubscriptionApi cancelPreviewSubscription POST /v1/subscription/{handle}/cancel_preview Preview subscription cancel
SubscriptionApi cancelSubscription POST /v1/subscription/{handle}/cancel Cancel subscription
SubscriptionApi changeNextPeriodStartJson POST /v1/subscription/{handle}/change_next_period_start Change next renewal date
SubscriptionApi changeSubscription PUT /v1/subscription/{handle} Change subscription
SubscriptionApi createSubscriptionDiscount POST /v1/subscription/{handle}/discount Add subscription discount
SubscriptionApi createSubscriptionInvoice POST /v1/subscription/{handle}/invoice Create invoice ondemand for subscription
SubscriptionApi createSubscriptionJson POST /v1/subscription Create subscription
SubscriptionApi deleteMetadata4 DELETE /v1/subscription/{handle}/metadata Delete metadata
SubscriptionApi deletePending DELETE /v1/subscription/{handle} Delete pending subscription. A pending subscription can only be deleted if no transactions has been made for the potential initial invoice.
SubscriptionApi deleteSubscriptionDiscount DELETE /v1/subscription/{handle}/discount/{sdHandle} Delete subscription discount
SubscriptionApi expire POST /v1/subscription/{handle}/expire Expire subscription
SubscriptionApi getMetadata4 GET /v1/subscription/{handle}/metadata Get metadata
SubscriptionApi getPayableInvoice GET /v1/subscription/{handle}/invoice Get most relevant payable invoice for subscription
SubscriptionApi getSubscription GET /v1/subscription/{handle} Get subscription
SubscriptionApi getSubscriptionAddOn GET /v1/subscription/{handle}/add_on/{saHandle} Get subscription add-on
SubscriptionApi getSubscriptionAddOns GET /v1/subscription/{handle}/add_on Get subscription add-ons
SubscriptionApi getSubscriptionDiscount GET /v1/subscription/{handle}/discount/{sdHandle} Get subscription discount
SubscriptionApi getSubscriptionDiscounts GET /v1/subscription/{handle}/discount Get subscription discounts
SubscriptionApi getSubscriptionPaymentMethod GET /v1/subscription/{handle}/pm Get payment method
SubscriptionApi getSubscriptionPeriodBalance GET /v1/subscription/{handle}/period_balance Get the period balance for subscription
SubscriptionApi intervalAmount GET /v1/subscription/{handle}/interval_amount Calculate interval amount
SubscriptionApi onHold POST /v1/subscription/{handle}/on_hold Subscription on hold
SubscriptionApi prepareSubscription POST /v1/subscription/prepare Prepare pending subscription
SubscriptionApi previewChangeSubscription PUT /v1/subscription/{handle}/preview Preview change subscription
SubscriptionApi previewSubscription POST /v1/subscription/preview Preview subscription
SubscriptionApi reactivateSubscription POST /v1/subscription/{handle}/reactivate Reactivate subscription on hold
SubscriptionApi redeemCouponCode POST /v1/subscription/{handle}/coupon Redeem coupon code for subscription
SubscriptionApi removeAllSubscriptionPaymentMethods DELETE /v1/subscription/{handle}/pm Remove all payment methods
SubscriptionApi removeSubscriptionPaymentMethod DELETE /v1/subscription/{handle}/pm/{method_id} Remove payment method
SubscriptionApi setSubscriptionPaymentMethod POST /v1/subscription/{handle}/pm Set payment method
SubscriptionApi uncancel POST /v1/subscription/{handle}/uncancel Uncancel subscription
SubscriptionApi updateMetadata4 PUT /v1/subscription/{handle}/metadata Create or update metadata
TaxPolicyApi createTaxPolicies POST /v1/tax_policy Create tax policy
TaxPolicyApi deleteTaxPolicies DELETE /v1/tax_policy/{handle} Delete tax policy
TaxPolicyApi getStandardTaxRates GET /v1/tax_policy/standard_tax_rates List of predefined standard tax rates
TaxPolicyApi getTaxPolicies GET /v1/tax_policy/{handle} Get tax policy
TaxPolicyApi getTaxRate GET /v1/tax_policy/{handle}/rates/{country} Tax Rate for a country
TaxPolicyApi updateTaxPolicies PUT /v1/tax_policy/{handle} Update tax policy
UserApi cancelInvitation DELETE /v1/user/invite/{id} Cancel invitation
UserApi deleteUser DELETE /v1/user/{id} Delete user
UserApi getUser GET /v1/user/{id} Get user
UserApi getUserInfo GET /v1/user/{id}/info Get user info
UserApi getUserMfa GET /v1/user/{id}/mfa Get MFA setup details
UserApi getUsers GET /v1/user Get users
UserApi inviteUser POST /v1/user/invite Invite user
UserApi inviteUserAccept POST /v1/user/invite/{token} Accept invite
UserApi inviteUserGet GET /v1/user/invite/{token} Get invite
UserApi resetPassword POST /v1/user/reset_password Reset password request
UserApi resetPasswordWithToken POST /v1/user/reset_password/{token} Reset password
UserApi setMfa PUT /v1/user/{id}/mfa Set user MFA
UserApi updateAuth PUT /v1/user/{id}/groups Update user groups
UserApi updatePassword PUT /v1/user/{id}/password Change password
UserApi updateUser PUT /v1/user/{id} Update user
UserApi verifyEmail POST /v1/user/verify_email/{token} Verify email
UserApi verifyEmailRequest POST /v1/user/{id}/verify_email Send verification email
WebhookApi disableWebhooks POST /v1/webhook/disable Disable webhooks
WebhookApi getWebhook GET /v1/webhook/{id} Get webhooks
WebhookApi getWebhookRequests GET /v1/webhook/{id}/request Get webhook requests
WebhookApi getWebhooks GET /v1/webhook Get list of webhooks
WebhookApi resendJson POST /v1/webhook/resend Re-send webhooks
WebhookApi updateWebhooks POST /v1/webhook/update Update and resend webhooks

Documentation For Models

Documentation For Authorization

apiKey

  • Type: API key
  • API key parameter name: X-Auth-Token
  • Location: HTTP header

basicAuth

  • Type: HTTP basic authentication

Author

support@reepay.com