Skip to main content
API docs by Redocly

PaymentsAI API (0.0.1)

Download OpenAPI specification:Download

Public API documentation for Payments AI

accounts

Activate account

Activate public-api account endpoint

Authorizations:
None
path Parameters
accountId
required
string

Account ID

Request Body schema: application/json
secret
string

Responses

Request samples

Content type
application/json
{
  • "secret": "secret"
}

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Update account's secret

Update public-api account's secret

Authorizations:
None
path Parameters
accountId
required
string

Account ID

Request Body schema: application/json
secret
string
newSecret
string

Responses

Request samples

Content type
application/json
{
  • "secret": "secret12345678910",
  • "newSecret": "secret1234567891011"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "message": "Bad request",
  • "details": "string"
}

api keys

Retrieve api key

Authorizations:
None
path Parameters
accountId
required
string

Account ID

Request Body schema: application/json
secret
string

Responses

Request samples

Content type
application/json
{
  • "secret": "secret"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create api key

Authorizations:
None
path Parameters
accountId
required
string

Account ID

Request Body schema: application/json
secret
string

Responses

Request samples

Content type
application/json
{
  • "secret": "secret"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Rotate api key

Authorizations:
None
path Parameters
accountId
required
string

Account ID

apiKeyId
required
string

Api Key ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

session

Get url that redirects to Payments AI v1

Authorizations:
None
query Parameters
accountId
required
string
Example: accountId=24ad6837-d38b-487e-a4d8-8c7131001c17
Request Body schema: application/json
optional
organizationId
string
cfWorkspaceHash
string
isOwner
boolean or null
object (WebhookMetadata)
object (WebhookMetadata)

Responses

Request samples

Content type
application/json
{
  • "organizationId": "string",
  • "cfWorkspaceHash": "string",
  • "isOwner": true,
  • "webhookMeta": {
    },
  • "sandboxWebhookMeta": {
    }
}

Response samples

Content type
application/json
{}

Create url that redirects to Payments AI v2

Authorizations:
None
path Parameters
organizationId
required
string

Organization ID

Request Body schema: application/json
optional
isOwner
boolean or null

Responses

Request samples

Content type
application/json
{
  • "isOwner": true
}

Response samples

Content type
application/json
{}

Redeem session for jwt token

Authorizations:
None
query Parameters
sessionToken
required
string
Example: sessionToken=24ad6837d38b487ea4d88c7131001c17

Responses

public

Create url that redirects to Payments AI v2

Authorizations:
None
path Parameters
organizationId
required
string

Organization ID

Request Body schema: application/json
optional
isOwner
boolean or null

Responses

Request samples

Content type
application/json
{
  • "isOwner": true
}

Response samples

Content type
application/json
{}

customers

Get list of organization customers

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

query Parameters
limit
integer [ 0 .. 100 ]
Default: 20
Example: limit=20

pagination limit

offset
number <integer> >= 0
Example: offset=1
search
string
showTestData
boolean
sortBy
string
Enum: "createdAt" "email" "name" "country" "lifetimeRevenue" "lastPaymentTime"
sortDirection
string
Enum: "asc" "desc"
revenueMin
string <date-time>
revenueMax
string <date-time>
createdFrom
string <date-time>
createdTo
string <date-time>
countries
Array of strings[ items = 2 characters ]
Example: countries=US

Array of ISO country codes

primaryPaymentInstrumentMethods
Array of strings (PaymentMethodEnum)
Items Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "Apple Pay" "AstroPay Card" "AstroPay-GO" "bank-transfer" "bank-transfer-2" "bank-transfer-3" "bank-transfer-4" "bank-transfer-5" "bank-transfer-6" "bank-transfer-7" "bank-transfer-8" "bank-transfer-9" "Beeline" "Belfius-direct-net" "bitcoin" "Boleto" "Boleto-2" "Boleto-3" "cash-deposit" "CASHlib" "CashToCode" "CCAvenue" "China UnionPay" "CODVoucher" "Conekta-oxxo" "Conekta-spei" "cryptocurrency" "Cupon-de-pagos" "CyberSource" "domestic-cards" "echeck" "ecoPayz" "ecoVoucher" "EPS" "ePay.bg" "Ethereum" "e-wallet" "ezyEFT" "eZeeWallet" "Flexepin" "Giropay" "GooglePay" "Gpaysafe" "iDebit" "iDEAL" "ING-homepay" "INOVAPAY-pin" "INOVAPAY-wallet" "InstaDebit" "instant-bank-transfer" "Interac-online" "Interac-eTransfer" "Interac-express-connect" "Interac" "invoice" "iWallet" "Jeton" "jpay" "Khelocard" "Klarna" "Litecoin" "loonie" "LPG-online" "LPG-payment-card" "Megafon" "MiFinity-eWallet" "miscellaneous" "Bancontact" "MTS" "MuchBetter" "MyFatoorah" "Neosurf" "Netbanking" "Neteller" "Nordea-Solo" "OchaPay" "online-bank-transfer" "Onlineueberweisen" "oriental-wallet" "OXXO" "PagoEffectivo" "Pagsmile-lottery" "Pagsmile-deposit-express" "PayCash" "Payeer" "PaymentAsia-crypto" "Paysafecard" "PayTabs" "Pay4Fun" "Paymero" "Paymero-QR" "PayULatam" "Perfect-money" "Piastrix" "PIX" "PinPay" "phone" "PhonePe" "POLi" "PostFinance-card" "PostFinance-e-finance" "Przelewy24" "QIWI" "QQPay" "Resurs" "SEPA" "Siirto" "Skrill" "Skrill Rapid Transfer" "SMSVoucher" "Sofort" "SparkPay" "swift-dbt" "Tele2" "Terminaly-RF" "Tether" "ToditoCash-card" "Trustly" "TWINT" "UniCrypt" "UPayCard" "UPI" "VCreditos" "VenusPoint" "voucher" "voucher-2" "voucher-3" "voucher-4" "Webmoney" "Webpay" "Webpay-2" "Webpay Card" "WeChat Pay" "XPay-P2P" "XPay-QR" "Yandex-money" "Zotapay" "Zimpler"
lastPaymentFrom
string <date-time>
lastPaymentTo
string <date-time>
isVip
boolean

Responses

Response samples

Content type
application/json
{
  • "type": "list",
  • "totalCount": 100,
  • "paginationMeta": {
    },
  • "data": [
    ]
}

Create a customer

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Request Body schema: application/json
required
firstName
string <= 45 characters
lastName
string <= 45 characters
organization
string or null <= 255 characters
email
string <email>
phoneNumber
string <= 10 characters
isEnhancedDueDiligenceRequired
boolean
Default: false
object

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "organization": "string",
  • "email": "[email protected]",
  • "phoneNumber": "string",
  • "isEnhancedDueDiligenceRequired": false,
  • "primaryAddress": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "message": "Bad request",
  • "details": "string"
}

Get customer details

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

customerId
required
string
Example: e7aa6809-6d8a-4e34-9bb0-d6897787fa9b
query Parameters
showTestData
boolean

Responses

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Update customer details

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

customerId
required
string
Example: e7aa6809-6d8a-4e34-9bb0-d6897787fa9b
Request Body schema: application/json
optional
name
string <= 91 characters
Deprecated
firstName
string <= 45 characters
lastName
string <= 45 characters
email
string <email>
phoneNumber
string <= 10 characters
organization
string or null <= 255 characters
tags
Array of strings (CustomerTag)
Items Enum: "discounted" "vip"
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "[email protected]",
  • "phoneNumber": "string",
  • "organization": "string",
  • "tags": [
    ],
  • "address": {
    },
  • "primaryPaymentInstrument": {
    }
}

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Upsert a customer

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

customerId
required
string
Example: e7aa6809-6d8a-4e34-9bb0-d6897787fa9b
Request Body schema: application/json
required
firstName
string <= 45 characters
lastName
string <= 45 characters
email
string <email>
phoneNumber
string <= 10 characters
organization
string or null <= 255 characters
isEnhancedDueDiligenceRequired
boolean
Default: false
object

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "[email protected]",
  • "phoneNumber": "string",
  • "organization": "string",
  • "isEnhancedDueDiligenceRequired": false,
  • "primaryAddress": {
    }
}

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

organization

create organization

Authorizations:
None
Request Body schema: application/json
required
organizationName
required
string <= 60 characters
website
required
string <= 65 characters
country
required
string (CountryCodeEnum)
Enum: "AF" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IL" "IT" "JM" "JP" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "SH" "KN" "LC" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "SC" "SL" "SG" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "AX" "BQ" "CW" "GG" "IM" "JE" "ME" "BL" "MF" "RS" "SX" "SS" "XK"
reportCurrency
required
string (CurrencyCodesEnum)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLE" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XCD" "XOF" "XPF" "YER" "ZAR" "ZMW" "ZWL"
cfWorkspaceHash
required
string
required
object (WebhookRegistrationMetadata)
required
object (WebhookRegistrationMetadata)

Responses

Request samples

Content type
application/json
{
  • "organizationName": "string",
  • "website": "string",
  • "country": "AF",
  • "reportCurrency": "AED",
  • "cfWorkspaceHash": "string",
  • "webhookMeta": {
    },
  • "sandboxWebhookMeta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

get organization details

Authorizations:
None
path Parameters
organizationId
required
string

Organization ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

payment-instruments

Get collection of payment instruments

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

customerId
required
string
Example: f70c64b0-a87d-4e66-9c19-8176c3284182
query Parameters
search
string
Example: search=John

Responses

Response samples

Content type
application/json
{
  • "id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "type": "payment-card",
  • "billingAddress": {
    },
  • "bankAccount": {
    },
  • "creditCard": {
    }
}

Create payment instrument for customer using token

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

customerId
required
string
Example: f70c64b0-a87d-4e66-9c19-8176c3284182
Request Body schema: application/json
required
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "type": "payment-card",
  • "billingAddress": {
    },
  • "bankAccount": {
    },
  • "creditCard": {
    }
}

Patch payment instrument

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

paymentInstrumentId
required
string
Example: 92dcc8b0-0872-4858-9f01-d6ecc724b4a9
Request Body schema: application/json
optional
object
object
stickyGatewaySlug
string (SupportedGatewaySlugEnum)
Enum: "default" "paypal" "klarna" "coinbase" "nmi" "stripe"
method
string (PaymentMethodEnum)
Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "Apple Pay" "AstroPay Card" "AstroPay-GO" "bank-transfer" "bank-transfer-2" "bank-transfer-3" "bank-transfer-4" "bank-transfer-5" "bank-transfer-6" "bank-transfer-7" "bank-transfer-8" "bank-transfer-9" "Beeline" "Belfius-direct-net" "bitcoin" "Boleto" "Boleto-2" "Boleto-3" "cash-deposit" "CASHlib" "CashToCode" "CCAvenue" "China UnionPay" "CODVoucher" "Conekta-oxxo" "Conekta-spei" "cryptocurrency" "Cupon-de-pagos" "CyberSource" "domestic-cards" "echeck" "ecoPayz" "ecoVoucher" "EPS" "ePay.bg" "Ethereum" "e-wallet" "ezyEFT" "eZeeWallet" "Flexepin" "Giropay" "GooglePay" "Gpaysafe" "iDebit" "iDEAL" "ING-homepay" "INOVAPAY-pin" "INOVAPAY-wallet" "InstaDebit" "instant-bank-transfer" "Interac-online" "Interac-eTransfer" "Interac-express-connect" "Interac" "invoice" "iWallet" "Jeton" "jpay" "Khelocard" "Klarna" "Litecoin" "loonie" "LPG-online" "LPG-payment-card" "Megafon" "MiFinity-eWallet" "miscellaneous" "Bancontact" "MTS" "MuchBetter" "MyFatoorah" "Neosurf" "Netbanking" "Neteller" "Nordea-Solo" "OchaPay" "online-bank-transfer" "Onlineueberweisen" "oriental-wallet" "OXXO" "PagoEffectivo" "Pagsmile-lottery" "Pagsmile-deposit-express" "PayCash" "Payeer" "PaymentAsia-crypto" "Paysafecard" "PayTabs" "Pay4Fun" "Paymero" "Paymero-QR" "PayULatam" "Perfect-money" "Piastrix" "PIX" "PinPay" "phone" "PhonePe" "POLi" "PostFinance-card" "PostFinance-e-finance" "Przelewy24" "QIWI" "QQPay" "Resurs" "SEPA" "Siirto" "Skrill" "Skrill Rapid Transfer" "SMSVoucher" "Sofort" "SparkPay" "swift-dbt" "Tele2" "Terminaly-RF" "Tether" "ToditoCash-card" "Trustly" "TWINT" "UniCrypt" "UPayCard" "UPI" "VCreditos" "VenusPoint" "voucher" "voucher-2" "voucher-3" "voucher-4" "Webmoney" "Webpay" "Webpay-2" "Webpay Card" "WeChat Pay" "XPay-P2P" "XPay-QR" "Yandex-money" "Zotapay" "Zimpler"
useAsBackup
boolean

Responses

Request samples

Content type
application/json
{
  • "billingAddress": {
    },
  • "creditCard": {
    },
  • "stickyGatewaySlug": "default",
  • "method": "payment-card",
  • "useAsBackup": true
}

Response samples

Content type
application/json
{
  • "id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "type": "payment-card",
  • "billingAddress": {
    },
  • "bankAccount": {
    },
  • "creditCard": {
    }
}

Delete payment instrument

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

paymentInstrumentId
required
string
Example: 92dcc8b0-0872-4858-9f01-d6ecc724b4a9

Responses

Response samples

Content type
application/json
{
  • "id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "type": "payment-card",
  • "billingAddress": {
    },
  • "bankAccount": {
    },
  • "creditCard": {
    }
}

plans

Get plans list

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

query Parameters
limit
integer [ 0 .. 100 ]
Default: 20
Example: limit=20

pagination limit

offset
number <integer> >= 0
Example: offset=1
sortDirection
string
Enum: "asc" "desc"
Example: sortDirection=asc
sortBy
string
Enum: "createdAt" "updatedAt"
search
string
Example: search=John
updatedFrom
string <date-time>
updatedTo
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "type": "list",
  • "totalCount": 100,
  • "paginationMeta": {
    },
  • "data": [
    ]
}

Create a plan

Authorizations:
None
path Parameters
organizationId
required
string

Organization ID

Request Body schema: application/json
required
name
string
currency
string (CurrencyCodesEnum)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLE" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XCD" "XOF" "XPF" "YER" "ZAR" "ZMW" "ZWL"
productId
string
object (Pricing)
description
string
richDescription
string
productOptions
object (ProductOptions)
currencySign
string
object (Setup)
isActive
boolean
revision
number
isTrialOnly
boolean
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currency": "AED",
  • "productId": "string",
  • "pricing": {
    },
  • "description": "string",
  • "richDescription": "string",
  • "productOptions": { },
  • "currencySign": "string",
  • "setup": {
    },
  • "isActive": true,
  • "revision": 0,
  • "isTrialOnly": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "message": "Bad request",
  • "details": "string"
}

Get organization plan by ID

Authorizations:
None
path Parameters
organizationId
required
string

Organization ID

planId
required
string

plan ID

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "currency": "AED",
  • "productId": "string",
  • "pricing": {
    },
  • "description": "string",
  • "richDescription": "string",
  • "productOptions": { },
  • "currencySign": "string",
  • "setup": {
    },
  • "isActive": true,
  • "revision": 0,
  • "isTrialOnly": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete plan by ID

Authorizations:
None
path Parameters
organizationId
required
string

Organization ID

planId
required
string

plan ID

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "message": "Bad request",
  • "details": "string"
}

Upsert a plan

Authorizations:
None
path Parameters
organizationId
required
string

Organization ID

planId
required
string

plan ID

Request Body schema: application/json
required
name
string
currency
string (CurrencyCodesEnum)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLE" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XCD" "XOF" "XPF" "YER" "ZAR" "ZMW" "ZWL"
productId
string
object (Pricing)
description
string
richDescription
string
productOptions
object (ProductOptions)
currencySign
string
object (Setup)
isActive
boolean
revision
number
isTrialOnly
boolean
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currency": "AED",
  • "productId": "string",
  • "pricing": {
    },
  • "description": "string",
  • "richDescription": "string",
  • "productOptions": { },
  • "currencySign": "string",
  • "setup": {
    },
  • "isActive": true,
  • "revision": 0,
  • "isTrialOnly": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "message": "Bad request",
  • "details": "string"
}

products

Get products list

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

query Parameters
limit
integer [ 0 .. 100 ]
Default: 20
Example: limit=20

pagination limit

offset
number <integer> >= 0
Example: offset=1
sortDirection
string
Enum: "asc" "desc"
Example: sortDirection=asc
sortBy
string
Enum: "createdAt" "updatedAt"
search
string
Example: search=John
updatedFrom
string <date-time>
updatedTo
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "type": "list",
  • "totalCount": 100,
  • "paginationMeta": {
    },
  • "data": [
    ]
}

Create product

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Request Body schema: application/json
required
required
object (Product)
id
string
name
string
unitLabel
string
description
string or null
requiresShipping
boolean
options
Array of strings
taxCategoryId
string or null
accountingCode
string or null
object (Recognition)
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "type": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "unitLabel": "string",
  • "description": "string",
  • "requiresShipping": true,
  • "options": [
    ],
  • "taxCategoryId": "string",
  • "accountingCode": "string",
  • "recognition": {
    },
  • "createdAt": "string",
  • "updatedAt": "string"
}

Get organization product by ID

Authorizations:
None
path Parameters
organizationId
required
string

Organization ID

productId
required
string

product ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "unitLabel": "string",
  • "description": "string",
  • "requiresShipping": true,
  • "options": [
    ],
  • "taxCategoryId": "string",
  • "accountingCode": "string",
  • "recognition": {
    },
  • "createdAt": "string",
  • "updatedAt": "string"
}

Upsert a product

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

productId
required
string

product ID

Request Body schema: application/json
required
required
object (Product)
id
string
name
string
unitLabel
string
description
string or null
requiresShipping
boolean
options
Array of strings
taxCategoryId
string or null
accountingCode
string or null
object (Recognition)
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "type": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "unitLabel": "string",
  • "description": "string",
  • "requiresShipping": true,
  • "options": [
    ],
  • "taxCategoryId": "string",
  • "accountingCode": "string",
  • "recognition": {
    },
  • "createdAt": "string",
  • "updatedAt": "string"
}

Delete a product

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

productId
required
string

product ID

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "message": "Bad request",
  • "details": "string"
}

public-keys

Get public key for organization

Authorizations:
NoneNone
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Responses

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

ready-to-pay

Get list of available payment methods

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Responses

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

transactions

Get transactions list

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

query Parameters
limit
integer [ 0 .. 100 ]
Default: 20
Example: limit=20

pagination limit

offset
number <integer> >= 0
Example: offset=1
sortDirection
string
Enum: "asc" "desc"
Example: sortDirection=asc
sortBy
string
Enum: "createdAt" "updatedAt" "title" "customerName" "date" "paymentType" "gatewayName"
combinedStatuses
Array of strings (CombinedStatus)
Items Enum: "abandoned" "canceled" "declined" "completed" "refunded" "voided" "partially-refunded" "waiting" "timeout" "not-sent" "disputed" "sending" "offsite"
paymentMethods
Array of strings (PaymentMethodEnum)
Items Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "Apple Pay" "AstroPay Card" "AstroPay-GO" "bank-transfer" "bank-transfer-2" "bank-transfer-3" "bank-transfer-4" "bank-transfer-5" "bank-transfer-6" "bank-transfer-7" "bank-transfer-8" "bank-transfer-9" "Beeline" "Belfius-direct-net" "bitcoin" "Boleto" "Boleto-2" "Boleto-3" "cash-deposit" "CASHlib" "CashToCode" "CCAvenue" "China UnionPay" "CODVoucher" "Conekta-oxxo" "Conekta-spei" "cryptocurrency" "Cupon-de-pagos" "CyberSource" "domestic-cards" "echeck" "ecoPayz" "ecoVoucher" "EPS" "ePay.bg" "Ethereum" "e-wallet" "ezyEFT" "eZeeWallet" "Flexepin" "Giropay" "GooglePay" "Gpaysafe" "iDebit" "iDEAL" "ING-homepay" "INOVAPAY-pin" "INOVAPAY-wallet" "InstaDebit" "instant-bank-transfer" "Interac-online" "Interac-eTransfer" "Interac-express-connect" "Interac" "invoice" "iWallet" "Jeton" "jpay" "Khelocard" "Klarna" "Litecoin" "loonie" "LPG-online" "LPG-payment-card" "Megafon" "MiFinity-eWallet" "miscellaneous" "Bancontact" "MTS" "MuchBetter" "MyFatoorah" "Neosurf" "Netbanking" "Neteller" "Nordea-Solo" "OchaPay" "online-bank-transfer" "Onlineueberweisen" "oriental-wallet" "OXXO" "PagoEffectivo" "Pagsmile-lottery" "Pagsmile-deposit-express" "PayCash" "Payeer" "PaymentAsia-crypto" "Paysafecard" "PayTabs" "Pay4Fun" "Paymero" "Paymero-QR" "PayULatam" "Perfect-money" "Piastrix" "PIX" "PinPay" "phone" "PhonePe" "POLi" "PostFinance-card" "PostFinance-e-finance" "Przelewy24" "QIWI" "QQPay" "Resurs" "SEPA" "Siirto" "Skrill" "Skrill Rapid Transfer" "SMSVoucher" "Sofort" "SparkPay" "swift-dbt" "Tele2" "Terminaly-RF" "Tether" "ToditoCash-card" "Trustly" "TWINT" "UniCrypt" "UPayCard" "UPI" "VCreditos" "VenusPoint" "voucher" "voucher-2" "voucher-3" "voucher-4" "Webmoney" "Webpay" "Webpay-2" "Webpay Card" "WeChat Pay" "XPay-P2P" "XPay-QR" "Yandex-money" "Zotapay" "Zimpler"
search
string
Example: search=John
showTestData
boolean
subscriptionId
string
Example: subscriptionId=bafe3272-c3e1-43be-9ea1-8d48ca204254
customerId
string
Example: customerId=bafe3272-c3e1-43be-9ea1-8d48ca204254
amountMin
number >= 0
Example: amountMin=1.99
amountMax
number >= 0
Example: amountMax=1.99
dateFrom
string <date-time>
dateTo
string <date-time>
paymentType
string (PaymentTypeEnum)
Enum: "one-time-payment" "subscription-payment"
Example: paymentType=one-time-payment
currencies
Array of strings[ items = 3 characters ]
Example: currencies=USD
gateways
Array of strings (SupportedGatewaySlugEnum)
Items Enum: "default" "paypal" "klarna" "coinbase" "nmi" "stripe"

Responses

Response samples

Content type
application/json
{
  • "type": "list",
  • "totalCount": 100,
  • "paginationMeta": {
    },
  • "data": [
    ]
}

Create transaction

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Request Body schema: application/json
required
amount
number
customerId
string <= 50 characters
currency
string (CurrencyCodesEnum)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLE" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XCD" "XOF" "XPF" "YER" "ZAR" "ZMW" "ZWL"
object or object
redirectUrl
string <url> <= 1024 characters
type
string
Enum: "sale" "authorize" "setup"

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "customerId": "string",
  • "currency": "AED",
  • "paymentInstruction": {
    },
  • "redirectUrl": "string",
  • "type": "sale"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get one transaction by id

path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

transaction ID
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

transaction ID

query Parameters
showTestData
boolean

Responses

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Get transaction logs

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

transaction ID
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

transaction ID

query Parameters
showTestData
boolean

Responses

Response samples

Content type
application/json
{
  • "type": "array",
  • "totalCount": 100,
  • "data": [
    ]
}

Refund transaction

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

transactionId
required
string

Transaction ID

Request Body schema: application/json
optional
amount
number <float>

Responses

Request samples

Content type
application/json
{
  • "amount": 0.1
}

Response samples

Content type
application/json
{
  • "type": "array",
  • "data": {
    }
}

subscription-one-time-orders

Create one-time-order

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Request Body schema: application/json
required
customerId
string <= 50 characters

Responses

Request samples

Content type
application/json
{
  • "customerId": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Upsert one time order

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

subscriptions

Get subscriptions list

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

query Parameters
limit
integer [ 0 .. 100 ]
Default: 20
Example: limit=20

pagination limit

offset
number <integer> >= 0
Example: offset=1
sortDirection
string
Enum: "asc" "desc"
Example: sortDirection=asc
sortBy
string
Enum: "createdAt" "nextCharge" "isAutoPay" "price" "customerName"
search
string
Example: search=John
createdFrom
string <date-time>
createdTo
string <date-time>
nextChargeTo
string <date-time>
nextChargeFrom
string <date-time>
renewability
string
Enum: "automatic" "manual"
customerId
string
Example: customerId=bafe3272-c3e1-43be-9ea1-8d48ca204254
statuses
Array of strings
Example: statuses=[object Object]
currencies
Array of strings[ items = 3 characters ]
Example: currencies=USD
amountMin
number >= 0
Example: amountMin=1.99
amountMax
number >= 0
Example: amountMax=1.99
showTestData
boolean

Responses

Response samples

Content type
application/json
{
  • "type": "list",
  • "totalCount": 100,
  • "paginationMeta": {
    },
  • "data": [
    ]
}

Create subscription

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Request Body schema: application/json
required
customerId
string <= 50 characters
isTrialOnly
boolean
Array of objects
paymentInstrumentId
string <= 50 characters
renewalTime
string <date-time>
startAt
string <date-time>
object (TrialSubscription)

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "isTrialOnly": true,
  • "items": [
    ],
  • "paymentInstrumentId": "string",
  • "renewalTime": "2019-08-24T14:15:22Z",
  • "startAt": "2019-08-24T14:15:22Z",
  • "trial": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get subscription details

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

subscriptionId
required
string <uuid>
Example: e7aa6809-6d8a-4e34-9bb0-d6897787fa9b
query Parameters
showTestData
boolean

Responses

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Upsert subscription

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete pending order

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "message": "Bad request",
  • "details": "string"
}

subscriptions-cancellations

Get list of subscriptions cancellations

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

query Parameters
limit
integer [ 0 .. 100 ]
Default: 20
Example: limit=20

pagination limit

offset
number <integer> >= 0
Example: offset=1
sortDirection
string
Enum: "asc" "desc"
Example: sortDirection=asc
sortBy
string
Enum: "createdAt" "updatedAt" "cancelledAt" "churnedAt"
showTestData
boolean
statuses
Array of strings (SubscriptionsCancellationsStatusesEnum)
Items Enum: "draft" "confirmed" "completed" "revoked"
createdFrom
string <date-time>
createdTo
string <date-time>
reasons
Array of strings (SubscriptionsCancellationsReasonsEnum)
Items Enum: "did-not-use" "did-not-want" "missing-features" "bugs-or-problems" "do-not-remember" "risk-warning" "contract-expired" "too-expensive" "other" "billing-failure"
cancelledBy
string (SubscriptionsCancellationsCancelledByEnum)
Enum: "customer" "merchant" "system"

Responses

Response samples

Content type
application/json
{
  • "totalCount": 100,
  • "paginationMeta": {
    },
  • "data": [
    ]
}

Create subscription cancellation

path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Request Body schema: application/json
required
reason
string (SubscriptionsCancellationsReasonsEnum)
Enum: "did-not-use" "did-not-want" "missing-features" "bugs-or-problems" "do-not-remember" "risk-warning" "contract-expired" "too-expensive" "other" "billing-failure"
cancelAt
string <date-time>
description
string <= 255 characters
status
string (SubscriptionsCancellationsStatusesEnum)
Enum: "draft" "confirmed" "completed" "revoked"

Responses

Request samples

Content type
application/json
{
  • "reason": "did-not-use",
  • "cancelAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "status": "draft"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "message": "Bad request",
  • "details": "string"
}

Get one subscription cancellation

path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

subscriptionCancellationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Subscription cancellation ID

query Parameters
showTestData
boolean

Responses

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Update subscription cancellation

path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

subscriptionCancellationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Subscription cancellation ID

Request Body schema: application/json
required
subscriptionId
string

Subscription id

description
string <= 255 characters
reason
string (SubscriptionsCancellationsReasonsEnum)
Enum: "did-not-use" "did-not-want" "missing-features" "bugs-or-problems" "do-not-remember" "risk-warning" "contract-expired" "too-expensive" "other" "billing-failure"
prorated
boolean
churnedAt
string <date-time>
churnTimePolicy
string (SubscriptionsCancellationsChurnTimePolicyEnum)
Enum: null "now" "at-next-renewal"

Responses

Request samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "description": "string",
  • "reason": "did-not-use",
  • "prorated": true,
  • "churnedAt": "2019-08-24T14:15:22Z",
  • "churnTimePolicy": null
}

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Delete subscription cancellation

path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

subscriptionCancellationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Subscription cancellation ID

Responses

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

subscription-pauses

Get list of subscription pauses

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

query Parameters
limit
integer [ 0 .. 100 ]
Default: 20
Example: limit=20

pagination limit

offset
number <integer> >= 0
Example: offset=1
sortDirection
string
Enum: "asc" "desc"
Example: sortDirection=asc
sortBy
string
Enum: "createdAt" "updatedAt"
createdFrom
string <date-time>
createdTo
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "totalCount": 100,
  • "paginationMeta": {
    },
  • "data": [
    ]
}

Create subscription pause

path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Request Body schema: application/json
required
subscriptionId
string <= 50 characters

Subscription id

pausedBy
string (SubscriptionsPausePausedByEnum)
Enum: "customer" "merchant"
description
string or null <= 255 characters
effectiveAt
string or null <date-time>
endAt
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "pausedBy": "customer",
  • "description": "string",
  • "effectiveAt": "2019-08-24T14:15:22Z",
  • "endAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Get subscription pause by Id

path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

subscriptionPauseId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Subscription pause ID

Responses

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Update subscription pause

path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

subscriptionPauseId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Subscription pause ID

Request Body schema: application/json
required
subscriptionId
string <= 50 characters

Subscription id

pausedBy
string (SubscriptionsPausePausedByEnum)
Enum: "customer" "merchant"
description
string or null <= 255 characters
effectiveAt
string or null <date-time>
endAt
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "pausedBy": "customer",
  • "description": "string",
  • "effectiveAt": "2019-08-24T14:15:22Z",
  • "endAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Delete subscription pause

path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

subscriptionPauseId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Subscription pause ID

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "message": "Bad request",
  • "details": "string"
}

subscription-reactivations

Get list of subscription reactivations

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

query Parameters
limit
integer [ 0 .. 100 ]
Default: 20
Example: limit=20

pagination limit

offset
number <integer> >= 0
Example: offset=1
sortDirection
string
Enum: "asc" "desc"
Example: sortDirection=asc
sortBy
string
Enum: "createdAt" "updatedAt"
createdFrom
string <date-time>
createdTo
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "totalCount": 100,
  • "paginationMeta": {
    },
  • "data": [
    ]
}

Create subscription reactivation

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

Request Body schema: application/json
required
subscriptionId
string <= 50 characters

Subscription id

description
string or null <= 255 characters
effectiveAt
string or null <date-time>
renewalAt
string or null <date-time>
paymentInstrumentId
string

Responses

Request samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "description": "string",
  • "effectiveAt": "2019-08-24T14:15:22Z",
  • "renewalAt": "2019-08-24T14:15:22Z",
  • "paymentInstrumentId": "string"
}

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Get one subscription reactivation

Authorizations:
None
path Parameters
organizationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Organization ID

subscriptionReactivationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Subscription reactivation ID

Responses

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

webhooks

Get webhook destinations

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "type": "list",
  • "data": [
    ]
}

Create webhook destination

Authorizations:
None
Request Body schema: application/json
required
url
required
string <url>
object

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "auth": {
    }
}

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": {
    }
}

Get webhook destination

Authorizations:
None
path Parameters
webhookDestinationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Webhook destination ID

Responses

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": [
    ]
}

Update webhook destination

Authorizations:
None
path Parameters
webhookDestinationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Webhook destination ID

Request Body schema: application/json
required
url
string <url>
object

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "auth": {
    }
}

Response samples

Content type
application/json
{
  • "type": "object",
  • "data": [
    ]
}

Delete webhook destination

Authorizations:
None
path Parameters
webhookDestinationId
required
string
Example: 46da78a6-034d-48d3-a28f-870d20b0ba00

Webhook destination ID

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "message": "Bad request",
  • "details": "string"
}