PaymentsAI API (0.0.1)

Download OpenAPI specification:Download

Public API documentation for Payments AI

session

Get url that redirects to payments ai

Authorizations:

None

query Parameters

accountId

required

string

Example: accountId=24ad6837-d38b-487e-a4d8-8c7131001c17

Request Body schema: application/json
optional

organizationId	string
cfWorkspaceHash	string
	object (WebhookMetadata)
	object (WebhookMetadata)

Responses

Request samples

Payload

Content type

application/json

{"organizationId": "string",
"cfWorkspaceHash": "string",
"webhookMeta": {"url": "string",
"eventTypes": ["string"
],
"taxCategoryId": "string",
"accountingCode": "string",
"recognition": {"debitAccountId": "string",
"creditAccountId": "string"
},
"createdAt": "string",
"updatedAt": "string"
},
"sandboxWebhookMeta": {"url": "string",
"eventTypes": ["string"
],
"taxCategoryId": "string",
"accountingCode": "string",
"recognition": {"debitAccountId": "string",
"creditAccountId": "string"
},
"createdAt": "string",
"updatedAt": "string"
}
}

Response samples

200
400
401
500

Content type

application/json

{"data": {"redirectUrl": "https://example.com/dashboard?sessionToken=123",
"organizationId": "59092f9a-97ce-46ad-97b1-78a4ad808184"
},
"type": "object"
}

Redeem session for jwt token

Authorizations:

None

query Parameters

sessionToken

required

string

Example: sessionToken=24ad6837d38b487ea4d88c7131001c17

Responses

customers

Get list of organization customers

Authorizations:

NoneNone

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 Example: [email protected]
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

200
400
401
403
500

Content type

application/json

{"type": "list",
"totalCount": 100,
"paginationMeta": {"limit": 10,
"offset": 10
},
"data": [{"id": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "[email protected]",
"origin": "US",
"language": "Polish",
"organization": "Important Org",
"address": {"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"lifetimeRevenue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"averageValue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"paymentCount": 92.23,
"primaryPaymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"lastPaymentTime": "2019-08-24T14:15:22Z",
"tags": ["discounted"
]
}
]
}

Create a customer

Authorizations:

NoneNone

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

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"organization": "string",
"email": "[email protected]",
"phoneNumber": "string",
"isEnhancedDueDiligenceRequired": false,
"primaryAddress": {"address1": "string",
"address2": "string",
"country": "st",
"city": "string",
"region": "string",
"zip": "string",
"dateOfBirth": "2019-08-24T14:15:22Z",
"jobTitle": "string"
}
}

Response samples

400
401
500

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"message": "Bad request",
"details": "string"
}

Get customer details

Authorizations:

NoneNone

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": {"id": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "[email protected]",
"origin": "US",
"language": "Polish",
"organization": "Important Org",
"address": {"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"lifetimeRevenue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"averageValue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"paymentCount": 92.23,
"primaryPaymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"lastPaymentTime": "2019-08-24T14:15:22Z",
"tags": ["discounted"
]
}
}

Update customer details

Authorizations:

NoneNone

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

Payload

Content type

application/json

{"name": "string",
"firstName": "string",
"lastName": "string",
"email": "[email protected]",
"phoneNumber": "string",
"organization": "string",
"tags": ["discounted"
],
"address": {"country": "string",
"address1": "string",
"address2": "string",
"city": "string",
"region": "string",
"zip": "string"
},
"primaryPaymentInstrument": {"method": "payment-card",
"id": "92dcc8b0-0872-4858-9f01-d6ecc724b4a9"
}
}

Response samples

Content type

application/json

{"type": "object",
"data": {"id": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "[email protected]",
"origin": "US",
"language": "Polish",
"organization": "Important Org",
"address": {"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"lifetimeRevenue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"averageValue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"paymentCount": 92.23,
"primaryPaymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"lastPaymentTime": "2019-08-24T14:15:22Z",
"tags": ["discounted"
]
}
}

Upsert a customer

Authorizations:

NoneNone

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

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"email": "[email protected]",
"phoneNumber": "string",
"organization": "string",
"isEnhancedDueDiligenceRequired": false,
"primaryAddress": {"address1": "string",
"address2": "string",
"country": "st",
"city": "string",
"region": "string",
"zip": "string",
"dateOfBirth": "2019-08-24T14:15:22Z",
"jobTitle": "string"
}
}

Response samples

201
400
401
500

Content type

application/json

{"type": "object",
"data": {"id": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "[email protected]",
"origin": "US",
"language": "Polish",
"organization": "Important Org",
"address": {"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"lifetimeRevenue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"averageValue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"paymentCount": 92.23,
"primaryPaymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"lastPaymentTime": "2019-08-24T14:15:22Z",
"tags": ["discounted"
]
}
}

Get collection of payment instruments. Payment instrument has a field isPrimaryInstrument

Authorizations:

NoneNone

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": {"firstName": "John",
"lastName": "Mock",
"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"bankAccount": {"bankName": "pko",
"lastFourDigits": "1234"
},
"creditCard": {"creditCardLastFourDigits": "1234",
"brand": "Visa",
"expireYear": 2034,
"expireMonth": 12,
"expireDate": "12/34",
"stickyGatewaySlug": "default"
}
}

Create payment instrument for customer using token

Authorizations:

NoneNone

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

Payload

Content type

application/json

{"token": "string"
}

Response samples

200
400
401
403
500

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": {"firstName": "John",
"lastName": "Mock",
"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"bankAccount": {"bankName": "pko",
"lastFourDigits": "1234"
},
"creditCard": {"creditCardLastFourDigits": "1234",
"brand": "Visa",
"expireYear": 2034,
"expireMonth": 12,
"expireDate": "12/34",
"stickyGatewaySlug": "default"
}
}

organization

get organization details

Authorizations:

NoneNone

path Parameters

organizationId

required

string

Organization ID

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"data": {"id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"accountId": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"isBillingConnected": false,
"canDownloadGatewayReports": false,
"isRegistered": false,
"registeredAt": "2021-06-07T10:54:17.387Z",
"business": {"name": "Masterborn",
"dba": "MasterBorn sp. z o.o.",
"type": "PRIVATE_ORGANIZATION",
"public": false,
"email": "[email protected]",
"address": "Krupnicza",
"city": "Wrocław",
"state": "Lower Silesian Voivodeship",
"zip": "50-075",
"phone": {"countryCode": "48",
"number": "123456789"
},
"website": "https://example.com"
},
"member": {"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1990-06-07",
"phone": {"countryCode": "48",
"number": "123456789"
},
"email": "[email protected]",
"address": "Krupnicza",
"city": "Wrocław",
"state": "Lower Silesian Voivodeship",
"zip": "50-075"
},
"account": {"bankState": "CA",
"method": "CORPORATE_CHECKING",
"reportCurrency": "string",
"minimalPayoutAmount": 100000,
"refundReserve": 100000,
"numberLastFour": 1234,
"payoutSchedule": "daily"
},
"createdAt": "2021-06-07T10:54:17.387Z",
"updatedAt": "2021-06-07T10:54:17.387Z",
"deletedAt": "2021-06-07T10:54:17.387Z",
"isTaxJarConnected": true,
"taxJarApiKeyLastFour": "1234",
"defaultGatewayRegion": "string",
"defaultGatewaySlug": "None",
"websiteId": "string",
"hostedOnboardingFormStatus": "not-started"
}
}

paymentInstruments

Get collection of payment instruments. Payment instrument has a field isPrimaryInstrument

Authorizations:

NoneNone

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": {"firstName": "John",
"lastName": "Mock",
"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"bankAccount": {"bankName": "pko",
"lastFourDigits": "1234"
},
"creditCard": {"creditCardLastFourDigits": "1234",
"brand": "Visa",
"expireYear": 2034,
"expireMonth": 12,
"expireDate": "12/34",
"stickyGatewaySlug": "default"
}
}

Create payment instrument for customer using token

Authorizations:

NoneNone

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

Payload

Content type

application/json

{"token": "string"
}

Response samples

200
400
401
403
500

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": {"firstName": "John",
"lastName": "Mock",
"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"bankAccount": {"bankName": "pko",
"lastFourDigits": "1234"
},
"creditCard": {"creditCardLastFourDigits": "1234",
"brand": "Visa",
"expireYear": 2034,
"expireMonth": 12,
"expireDate": "12/34",
"stickyGatewaySlug": "default"
}
}

plans

Get plans list

Authorizations:

NoneNone

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

200
400
401
500

Content type

application/json

{"type": "list",
"totalCount": 100,
"paginationMeta": {"limit": 10,
"offset": 10
},
"data": [{"name": "string",
"currency": "AED",
"productId": "string",
"pricing": {"price": 0,
"formula": "string"
},
"description": "string",
"richDescription": "string",
"productOptions": { },
"currencySign": "string",
"setup": {"approvalLink": "string",
"price": 0
},
"isActive": true,
"revision": 0,
"isTrialOnly": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Create a plan

Authorizations:

NoneNone

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

Payload

Content type

application/json

{"name": "string",
"currency": "AED",
"productId": "string",
"pricing": {"price": 0,
"formula": "string"
},
"description": "string",
"richDescription": "string",
"productOptions": { },
"currencySign": "string",
"setup": {"approvalLink": "string",
"price": 0
},
"isActive": true,
"revision": 0,
"isTrialOnly": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

400
401
500

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"message": "Bad request",
"details": "string"
}

Get organization plan by ID

Authorizations:

NoneNone

path Parameters

organizationId required	string Organization ID
planId required	string plan ID

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"name": "string",
"currency": "AED",
"productId": "string",
"pricing": {"price": 0,
"formula": "string"
},
"description": "string",
"richDescription": "string",
"productOptions": { },
"currencySign": "string",
"setup": {"approvalLink": "string",
"price": 0
},
"isActive": true,
"revision": 0,
"isTrialOnly": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete plan by ID

Authorizations:

NoneNone

path Parameters

organizationId required	string Organization ID
planId required	string plan ID

Responses

Response samples

400
401
409
500

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"message": "Bad request",
"details": "string"
}

Upsert a plan

Authorizations:

NoneNone

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

Payload

Content type

application/json

{"name": "string",
"currency": "AED",
"productId": "string",
"pricing": {"price": 0,
"formula": "string"
},
"description": "string",
"richDescription": "string",
"productOptions": { },
"currencySign": "string",
"setup": {"approvalLink": "string",
"price": 0
},
"isActive": true,
"revision": 0,
"isTrialOnly": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

400
401
404
500

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"message": "Bad request",
"details": "string"
}

products

Get products list

Authorizations:

NoneNone

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

200
400
401
500

Content type

application/json

{"type": "list",
"totalCount": 100,
"paginationMeta": {"limit": 10,
"offset": 10
},
"data": [{"id": "string",
"name": "string",
"unitLabel": "string",
"description": "string",
"requiresShipping": true,
"options": ["string"
],
"taxCategoryId": "string",
"accountingCode": "string",
"recognition": {"debitAccountId": "string",
"creditAccountId": "string"
},
"createdAt": "string",
"updatedAt": "string"
}
]
}

Create product

Authorizations:

NoneNone

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

Payload

Content type

application/json

{"type": {"id": "string",
"name": "string",
"unitLabel": "string",
"description": "string",
"requiresShipping": true,
"options": ["string"
],
"taxCategoryId": "string",
"accountingCode": "string",
"recognition": {"debitAccountId": "string",
"creditAccountId": "string"
},
"createdAt": "string",
"updatedAt": "string"
}
}

Response samples

201
400
401
500

Content type

application/json

{"id": "string",
"name": "string",
"unitLabel": "string",
"description": "string",
"requiresShipping": true,
"options": ["string"
],
"taxCategoryId": "string",
"accountingCode": "string",
"recognition": {"debitAccountId": "string",
"creditAccountId": "string"
},
"createdAt": "string",
"updatedAt": "string"
}

Get organization product by ID

Authorizations:

NoneNone

path Parameters

organizationId required	string Organization ID
productId required	string product ID

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"id": "string",
"name": "string",
"unitLabel": "string",
"description": "string",
"requiresShipping": true,
"options": ["string"
],
"taxCategoryId": "string",
"accountingCode": "string",
"recognition": {"debitAccountId": "string",
"creditAccountId": "string"
},
"createdAt": "string",
"updatedAt": "string"
}

Upsert a product

Authorizations:

NoneNone

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

Payload

Content type

application/json

{"type": {"id": "string",
"name": "string",
"unitLabel": "string",
"description": "string",
"requiresShipping": true,
"options": ["string"
],
"taxCategoryId": "string",
"accountingCode": "string",
"recognition": {"debitAccountId": "string",
"creditAccountId": "string"
},
"createdAt": "string",
"updatedAt": "string"
}
}

Response samples

201
400
401
500

Content type

application/json

{"id": "string",
"name": "string",
"unitLabel": "string",
"description": "string",
"requiresShipping": true,
"options": ["string"
],
"taxCategoryId": "string",
"accountingCode": "string",
"recognition": {"debitAccountId": "string",
"creditAccountId": "string"
},
"createdAt": "string",
"updatedAt": "string"
}

Delete a product

Authorizations:

NoneNone

path Parameters

organizationId required	string Example: 46da78a6-034d-48d3-a28f-870d20b0ba00 Organization ID
productId required	string product ID

Responses

Response samples

400
401
409
500

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

200
400
401
403
500

Content type

application/json

{"type": "object",
"data": {"value": "sdfuy56432asdfhtgw4ytq"
}
}

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": {"paymentMethods": ["payment-card"
],
"creditCardBrand": ["Visa"
]
}
}

transactions

Get transactions list

Authorizations:

NoneNone

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

200
400
401
403
500

Content type

application/json

{"type": "list",
"totalCount": 100,
"paginationMeta": {"limit": 10,
"offset": 10
},
"data": [{"id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"amount": 92.23,
"refundAmount": 92.23,
"refundableAmount": 92.23,
"currency": "USD",
"status": "completed",
"result": "abandoned",
"combinedStatus": "abandoned",
"customer": {"name": "John Mock",
"email": "[email protected]",
"origin": "US",
"language": "en-GB"
},
"date": "2019-08-24T14:15:22Z",
"type": "3ds-authentication",
"paymentType": "one-time-payment",
"paymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"invoices": [{"date": "2021-06-07T10:54:17.387Z",
"amount": 92.23,
"currency": "USD"
}
],
"gatewayName": "Bluesnap",
"subscriptionId": "98e1f1ba-92cb-45e3-bd7d-7f116decc09f",
"paymentLink": "https://sandbox-portal.secure-payments.app/payment/",
"redirectUrl": "string",
"permissionsBundle": {"isRefundable": false
}
}
]
}

Create transaction

Authorizations:

NoneNone

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

Payload

Content type

application/json

{"amount": 0,
"customerId": "string",
"currency": "AED",
"paymentInstruction": {"token": "string"
},
"redirectUrl": "string",
"type": "sale"
}

Response samples

201
400
401
500

Content type

application/json

{"data": {"id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"amount": 92.23,
"refundAmount": 92.23,
"refundableAmount": 92.23,
"currency": "USD",
"status": "completed",
"result": "abandoned",
"combinedStatus": "abandoned",
"customer": {"name": "John Mock",
"email": "[email protected]",
"origin": "US",
"language": "en-GB"
},
"date": "2019-08-24T14:15:22Z",
"type": "3ds-authentication",
"paymentType": "one-time-payment",
"paymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"invoices": [{"date": "2021-06-07T10:54:17.387Z",
"amount": 92.23,
"currency": "USD"
}
],
"gatewayName": "Bluesnap",
"subscriptionId": "98e1f1ba-92cb-45e3-bd7d-7f116decc09f",
"paymentLink": "https://sandbox-portal.secure-payments.app/payment/",
"redirectUrl": "string",
"permissionsBundle": {"isRefundable": false
}
}
}

subscriptions-cancellations

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

200
400
401
403
500

Content type

application/json

{"type": "object",
"data": {"id": "sub_cnl_2432e-4e94-b8ba-1658ef3258e2",
"organizationId": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"subscriptionId": "sub_2432e-4e94-b8ba-1658ef3258e2",
"proratedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"appliedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"cancelledBy": "customer",
"reason": "did-not-use",
"description": "string",
"prorated": true,
"status": "draft",
"cancelledAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"churnedAt": "2019-08-24T14:15:22Z",
"churnTimePolicy": null,
"lineItems": [{"type": "debit",
"description": "string",
"unitPriceAmount": 0,
"unitPriceCurrency": "AED",
"quantity": 0,
"periodStartsAt": "2019-08-24T14:15:22Z",
"periodEndsAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"lineItemsSubtotal": {"amount": 0,
"currency": "AED"
}
}
}

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

Payload

Content type

application/json

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

Response samples

200
400
401
403
500

Content type

application/json

{"type": "object",
"data": {"id": "sub_cnl_2432e-4e94-b8ba-1658ef3258e2",
"organizationId": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"subscriptionId": "sub_2432e-4e94-b8ba-1658ef3258e2",
"proratedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"appliedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"cancelledBy": "customer",
"reason": "did-not-use",
"description": "string",
"prorated": true,
"status": "draft",
"cancelledAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"churnedAt": "2019-08-24T14:15:22Z",
"churnTimePolicy": null,
"lineItems": [{"type": "debit",
"description": "string",
"unitPriceAmount": 0,
"unitPriceCurrency": "AED",
"quantity": 0,
"periodStartsAt": "2019-08-24T14:15:22Z",
"periodEndsAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"lineItemsSubtotal": {"amount": 0,
"currency": "AED"
}
}
}

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": {"id": "sub_cnl_2432e-4e94-b8ba-1658ef3258e2",
"organizationId": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"subscriptionId": "sub_2432e-4e94-b8ba-1658ef3258e2",
"proratedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"appliedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"cancelledBy": "customer",
"reason": "did-not-use",
"description": "string",
"prorated": true,
"status": "draft",
"cancelledAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"churnedAt": "2019-08-24T14:15:22Z",
"churnTimePolicy": null,
"lineItems": [{"type": "debit",
"description": "string",
"unitPriceAmount": 0,
"unitPriceCurrency": "AED",
"quantity": 0,
"periodStartsAt": "2019-08-24T14:15:22Z",
"periodEndsAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"lineItemsSubtotal": {"amount": 0,
"currency": "AED"
}
}
}

Create subscription cancellation

path Parameters

organizationId required	string Example: 46da78a6-034d-48d3-a28f-870d20b0ba00 Organization ID
subscriptionId required	string Example: 46da78a6-034d-48d3-a28f-870d20b0ba00 Subscription 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

Responses

Request samples

Payload

Content type

application/json

{"reason": "did-not-use",
"cancelAt": "2019-08-24T14:15:22Z",
"description": "string"
}

Response samples

400
401
500

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"message": "Bad request",
"details": "string"
}

Get list of subscriptions cancellations

Authorizations:

NoneNone

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

200
400
401
403
500

Content type

application/json

{"totalCount": 100,
"paginationMeta": {"limit": 10,
"offset": 10
},
"data": [{"id": "sub_cnl_2432e-4e94-b8ba-1658ef3258e2",
"organizationId": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"subscriptionId": "sub_2432e-4e94-b8ba-1658ef3258e2",
"proratedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"appliedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"cancelledBy": "customer",
"reason": "did-not-use",
"description": "string",
"prorated": true,
"status": "draft",
"cancelledAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"churnedAt": "2019-08-24T14:15:22Z",
"churnTimePolicy": null,
"lineItems": [{"type": "debit",
"description": "string",
"unitPriceAmount": 0,
"unitPriceCurrency": "AED",
"quantity": 0,
"periodStartsAt": "2019-08-24T14:15:22Z",
"periodEndsAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"lineItemsSubtotal": {"amount": 0,
"currency": "AED"
}
}
]
}

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

200
400
401
403
500

Content type

application/json

{"type": "object",
"data": {"id": "sub_cnl_2432e-4e94-b8ba-1658ef3258e2",
"organizationId": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"subscriptionId": "sub_2432e-4e94-b8ba-1658ef3258e2",
"proratedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"appliedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"cancelledBy": "customer",
"reason": "did-not-use",
"description": "string",
"prorated": true,
"status": "draft",
"cancelledAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"churnedAt": "2019-08-24T14:15:22Z",
"churnTimePolicy": null,
"lineItems": [{"type": "debit",
"description": "string",
"unitPriceAmount": 0,
"unitPriceCurrency": "AED",
"quantity": 0,
"periodStartsAt": "2019-08-24T14:15:22Z",
"periodEndsAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"lineItemsSubtotal": {"amount": 0,
"currency": "AED"
}
}
}

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

Payload

Content type

application/json

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

Response samples

200
400
401
403
500

Content type

application/json

{"type": "object",
"data": {"id": "sub_cnl_2432e-4e94-b8ba-1658ef3258e2",
"organizationId": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"subscriptionId": "sub_2432e-4e94-b8ba-1658ef3258e2",
"proratedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"appliedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"cancelledBy": "customer",
"reason": "did-not-use",
"description": "string",
"prorated": true,
"status": "draft",
"cancelledAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"churnedAt": "2019-08-24T14:15:22Z",
"churnTimePolicy": null,
"lineItems": [{"type": "debit",
"description": "string",
"unitPriceAmount": 0,
"unitPriceCurrency": "AED",
"quantity": 0,
"periodStartsAt": "2019-08-24T14:15:22Z",
"periodEndsAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"lineItemsSubtotal": {"amount": 0,
"currency": "AED"
}
}
}

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": {"id": "sub_cnl_2432e-4e94-b8ba-1658ef3258e2",
"organizationId": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"subscriptionId": "sub_2432e-4e94-b8ba-1658ef3258e2",
"proratedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"appliedInvoiceId": "inv_2432e-4e94-b8ba-1658ef3258e2",
"cancelledBy": "customer",
"reason": "did-not-use",
"description": "string",
"prorated": true,
"status": "draft",
"cancelledAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"churnedAt": "2019-08-24T14:15:22Z",
"churnTimePolicy": null,
"lineItems": [{"type": "debit",
"description": "string",
"unitPriceAmount": 0,
"unitPriceCurrency": "AED",
"quantity": 0,
"periodStartsAt": "2019-08-24T14:15:22Z",
"periodEndsAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"lineItemsSubtotal": {"amount": 0,
"currency": "AED"
}
}
}

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

200
400
401
403
500

Content type

application/json

{"type": "list",
"totalCount": 100,
"paginationMeta": {"limit": 10,
"offset": 10
},
"data": [{"id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"organizationId": "7830dd74-86d9-4027-b110-5dfb0b749392",
"price": 92.23,
"currency": "USD",
"status": "connected",
"name": "Premium membership plan",
"customer": {"id": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "[email protected]",
"origin": "US",
"language": "Polish",
"organization": "Important Org",
"address": {"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"lifetimeRevenue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"averageValue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"paymentCount": 92.23,
"primaryPaymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"lastPaymentTime": "2019-08-24T14:15:22Z",
"tags": ["discounted"
]
},
"bilingCycle": {"unit": "days",
"length": 7
},
"isAutoPay": true,
"nextCharge": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"delinquencyPeriod": "string",
"renewalRemindersSentAt": ["2019-08-24T14:15:22Z"
],
"items": [{"price": 92.23,
"quantity": 93,
"formula": "fixed-fee",
"currency": "AED",
"planId": "string",
"planName": "string",
"bilingCycle": {"unit": "days",
"length": 7
}
}
]
}
]
}

Create subscription

Authorizations:

None

path Parameters

organizationId

required

string

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

Organization ID

Request Body schema: application/json
required

autopay	boolean
customerId	string <= 50 characters
isTrialOnly	boolean
paymentInstrumentId	string <= 50 characters
renewalTime	string <date-time>
startAt	string <date-time>
	object (TrialSubscription)

Responses

Request samples

Payload

Content type

application/json

{"autopay": true,
"customerId": "string",
"isTrialOnly": true,
"paymentInstrumentId": "string",
"renewalTime": "2019-08-24T14:15:22Z",
"startAt": "2019-08-24T14:15:22Z",
"trial": {"enabled": true,
"endAt": "2019-08-24T14:15:22Z"
}
}

Response samples

201
400
401
403
500

Content type

application/json

{"data": {"id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"organizationId": "7830dd74-86d9-4027-b110-5dfb0b749392",
"price": 92.23,
"currency": "USD",
"status": "connected",
"name": "Premium membership plan",
"customer": {"id": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "[email protected]",
"origin": "US",
"language": "Polish",
"organization": "Important Org",
"address": {"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"lifetimeRevenue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"averageValue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"paymentCount": 92.23,
"primaryPaymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"lastPaymentTime": "2019-08-24T14:15:22Z",
"tags": ["discounted"
]
},
"bilingCycle": {"unit": "days",
"length": 7
},
"isAutoPay": true,
"nextCharge": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"delinquencyPeriod": "string",
"renewalRemindersSentAt": ["2019-08-24T14:15:22Z"
],
"items": [{"price": 92.23,
"quantity": 93,
"formula": "fixed-fee",
"currency": "AED",
"planId": "string",
"planName": "string",
"bilingCycle": {"unit": "days",
"length": 7
}
}
]
}
}

Upsert subscription

Authorizations:

None

path Parameters

organizationId

required

string

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

Organization ID

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"data": {"id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"organizationId": "7830dd74-86d9-4027-b110-5dfb0b749392",
"price": 92.23,
"currency": "USD",
"status": "connected",
"name": "Premium membership plan",
"customer": {"id": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "[email protected]",
"origin": "US",
"language": "Polish",
"organization": "Important Org",
"address": {"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"lifetimeRevenue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"averageValue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"paymentCount": 92.23,
"primaryPaymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"lastPaymentTime": "2019-08-24T14:15:22Z",
"tags": ["discounted"
]
},
"bilingCycle": {"unit": "days",
"length": 7
},
"isAutoPay": true,
"nextCharge": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"delinquencyPeriod": "string",
"renewalRemindersSentAt": ["2019-08-24T14:15:22Z"
],
"items": [{"price": 92.23,
"quantity": 93,
"formula": "fixed-fee",
"currency": "AED",
"planId": "string",
"planName": "string",
"bilingCycle": {"unit": "days",
"length": 7
}
}
]
}
}

Delete pending order

Authorizations:

None

path Parameters

organizationId

required

string

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

Organization ID

Responses

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"message": "Bad request",
"details": "string"
}

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

Payload

Content type

application/json

{"customerId": "string"
}

Response samples

201
400
401
403
500

Content type

application/json

{"data": {"id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"organizationId": "7830dd74-86d9-4027-b110-5dfb0b749392",
"price": 92.23,
"currency": "USD",
"status": "connected",
"name": "Premium membership plan",
"customer": {"id": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "[email protected]",
"origin": "US",
"language": "Polish",
"organization": "Important Org",
"address": {"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"lifetimeRevenue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"averageValue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"paymentCount": 92.23,
"primaryPaymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"lastPaymentTime": "2019-08-24T14:15:22Z",
"tags": ["discounted"
]
},
"bilingCycle": {"unit": "days",
"length": 7
},
"isAutoPay": true,
"nextCharge": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"delinquencyPeriod": "string",
"renewalRemindersSentAt": ["2019-08-24T14:15:22Z"
],
"items": [{"price": 92.23,
"quantity": 93,
"formula": "fixed-fee",
"currency": "AED",
"planId": "string",
"planName": "string",
"bilingCycle": {"unit": "days",
"length": 7
}
}
]
}
}

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

200
400
401
403
500

Content type

application/json

{"type": "object",
"data": {"id": "c114b68a-432e-4e94-b8ba-1658ef3258e2",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"organizationId": "7830dd74-86d9-4027-b110-5dfb0b749392",
"price": 92.23,
"currency": "USD",
"status": "connected",
"name": "Premium membership plan",
"customer": {"id": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "[email protected]",
"origin": "US",
"language": "Polish",
"organization": "Important Org",
"address": {"country": "DE",
"address1": "Blue st 1",
"address2": "Blue st 2",
"city": "Berlin",
"zip": "99-123"
},
"lifetimeRevenue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"averageValue": {"currency": "USD",
"amount": 92.23,
"amountUSD": 92.23
},
"paymentCount": 92.23,
"primaryPaymentInstrument": {"id": "381ea960-bc9a-4800-8c02-7815f91bfd40",
"method": "payment-card",
"creditCardLastFourDigits": "303472df-f169-4fb3-8600-1a916ebb7e9b",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"name": "John Mock",
"firstName": "John",
"lastName": "Mock",
"email": "1234",
"brand": "Visa",
"expireDate": "21/12"
},
"lastPaymentTime": "2019-08-24T14:15:22Z",
"tags": ["discounted"
]
},
"bilingCycle": {"unit": "days",
"length": 7
},
"isAutoPay": true,
"nextCharge": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"delinquencyPeriod": "string",
"renewalRemindersSentAt": ["2019-08-24T14:15:22Z"
],
"items": [{"price": 92.23,
"quantity": 93,
"formula": "fixed-fee",
"currency": "AED",
"planId": "string",
"planName": "string",
"bilingCycle": {"unit": "days",
"length": 7
}
}
]
}
}

Create subscription cancellation

path Parameters

organizationId required	string Example: 46da78a6-034d-48d3-a28f-870d20b0ba00 Organization ID
subscriptionId required	string Example: 46da78a6-034d-48d3-a28f-870d20b0ba00 Subscription 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

Responses

Request samples

Payload

Content type

application/json

{"reason": "did-not-use",
"cancelAt": "2019-08-24T14:15:22Z",
"description": "string"
}

Response samples

400
401
500

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"message": "Bad request",
"details": "string"
}

webhooks

Get webhook destinations

Authorizations:

None

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"type": "list",
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"url": "string",
"auth": {"type": "basic",
"username": "string",
"password": "string"
}
}
]
}

Create webhook destination

Authorizations:

None

Request Body schema: application/json
required

url required	string <url>
	object

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"auth": {"type": "basic",
"username": "string",
"password": "string"
}
}

Response samples

201
400
401
403
500

Content type

application/json

{"type": "object",
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"url": "string",
"auth": {"type": "basic",
"username": "string",
"password": "string"
}
}
}

Get webhook destination

Authorizations:

None

path Parameters

webhookDestinationId

required

string

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

Webhook destination ID

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"type": "object",
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"url": "string",
"auth": {"type": "basic",
"username": "string",
"password": "string"
}
}
]
}

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

Payload

Content type

application/json

{"url": "string",
"auth": {"type": "basic",
"username": "string",
"password": "string"
}
}

Response samples

200
400
401
403
500

Content type

application/json

{"type": "object",
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"url": "string",
"auth": {"type": "basic",
"username": "string",
"password": "string"
}
}
]
}

Delete webhook destination

Authorizations:

None

path Parameters

webhookDestinationId

required

string

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

Webhook destination ID

Responses

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"message": "Bad request",
"details": "string"
}

PaymentsAI API (0.0.1)

session

Get url that redirects to payments ai

Authorizations:

query Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Redeem session for jwt token

Authorizations:

query Parameters

Responses

customers

Get list of organization customers

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Create a customer

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get customer details

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Update customer details

Authorizations:

path Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Upsert a customer

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get collection of payment instruments. Payment instrument has a field isPrimaryInstrument

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Create payment instrument for customer using token

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

organization

get organization details

Authorizations:

path Parameters

Responses

Response samples

paymentInstruments

Get collection of payment instruments. Payment instrument has a field isPrimaryInstrument

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Create payment instrument for customer using token

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required