Skip to main content
Documentation Powered by Redocly

Payments and Invoices Public APIs (0.1)

Download OpenAPI specification:Download

Payments and Invoices Public APIs

Create a draft payment, which you can later proces

Create a draft payment, which you can later process by its id

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id
Request Body schema: application/json
invoiceRefNumber
required
string

Reference number for your payment. Due to restrictions on reference length in most banks this field is limited to 12 characters and can only contain letters, numbers and dashes

amount
required
string
customerName
string
dueDate
object

JavaScript Date Object

attachmentUrl
string
customerEmail
string
customerEmailCC
string
customRedirectUrl
string

A custom redirect URL only for the current payment

type
string (PaymentTypes)
Enum: "link" "qr" "mobile"

Responses

Request samples

Content type
application/json
{
  • "invoiceRefNumber": "string",
  • "amount": "string",
  • "customerName": "string",
  • "dueDate": { },
  • "attachmentUrl": "string",
  • "customerEmail": "string",
  • "customerEmailCC": "string",
  • "customRedirectUrl": "string",
  • "type": "link"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Create and process payment

Create and process payment

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id
Request Body schema: application/json
invoiceRefNumber
required
string

Reference number for your payment. Due to restrictions on reference length in most banks this field is limited to 12 characters and can only contain letters, numbers and dashes

amount
required
string
customerName
string
dueDate
object

JavaScript Date Object

attachmentUrl
string
customerEmail
string
customerEmailCC
string
customRedirectUrl
string

A custom redirect URL only for the current payment

type
string (PaymentTypes)
Enum: "link" "qr" "mobile"

Responses

Request samples

Content type
application/json
{
  • "invoiceRefNumber": "string",
  • "amount": "string",
  • "customerName": "string",
  • "dueDate": { },
  • "attachmentUrl": "string",
  • "customerEmail": "string",
  • "customerEmailCC": "string",
  • "customRedirectUrl": "string",
  • "type": "link"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Get payment data

Get payment data

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Get list of all payments

Get list of all payments

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Edit payment data

Edit payment data

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id
Request Body schema: application/json
_id
required
string

Mongoose Object ID

invoiceRefNumber
string
amount
string
customerName
string
dueDate
object

JavaScript Date Object

attachmentUrl
string
customerEmail
string
customerEmailCC
string
customRedirectUrl
string

A custom redirect URL only for the current payment

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "invoiceRefNumber": "string",
  • "amount": "string",
  • "customerName": "string",
  • "dueDate": { },
  • "attachmentUrl": "string",
  • "customerEmail": "string",
  • "customerEmailCC": "string",
  • "customRedirectUrl": "string"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Process payment

Process payment

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Delete payment

Delete payment

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Create invoice

Create invoice

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id
Request Body schema: application/json
invoiceRefNumber
required
string

Reference number for your invoice. Due to restrictions on reference length in most banks this field is limited to 12 characters and can only contain letters, numbers and dashes

amount
required
string
customerName
string
dueDate
object

JavaScript Date Object

attachmentUrl
string
customerEmail
string
customerEmailCC
string
customRedirectUrl
string

A custom redirect URL only for the current invoice

Responses

Request samples

Content type
application/json
{
  • "invoiceRefNumber": "string",
  • "amount": "string",
  • "customerName": "string",
  • "dueDate": { },
  • "attachmentUrl": "string",
  • "customerEmail": "string",
  • "customerEmailCC": "string",
  • "customRedirectUrl": "string"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Save and send invoice

Save and send invoice

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id
Request Body schema: application/json
invoiceRefNumber
required
string

Reference number for your invoice. Due to restrictions on reference length in most banks this field is limited to 12 characters and can only contain letters, numbers and dashes

amount
required
string
customerName
string
dueDate
object

JavaScript Date Object

attachmentUrl
string
customerEmail
string
customerEmailCC
string
customRedirectUrl
string

A custom redirect URL only for the current invoice

Responses

Request samples

Content type
application/json
{
  • "invoiceRefNumber": "string",
  • "amount": "string",
  • "customerName": "string",
  • "dueDate": { },
  • "attachmentUrl": "string",
  • "customerEmail": "string",
  • "customerEmailCC": "string",
  • "customRedirectUrl": "string"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Get invoice data

Get invoice data

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Get list of all payments

Get list of all payments

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Edit payment

Edit payment

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id
Request Body schema: application/json
invoiceRefNumber
required
string

Reference number for your invoice. Due to restrictions on reference length in most banks this field is limited to 12 characters and can only contain letters, numbers and dashes

amount
required
string
customerName
string
dueDate
object

JavaScript Date Object

attachmentUrl
string
customerEmail
string
customerEmailCC
string
customRedirectUrl
string

A custom redirect URL only for the current invoice

Responses

Request samples

Content type
application/json
{
  • "invoiceRefNumber": "string",
  • "amount": "string",
  • "customerName": "string",
  • "dueDate": { },
  • "attachmentUrl": "string",
  • "customerEmail": "string",
  • "customerEmailCC": "string",
  • "customRedirectUrl": "string"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Send invoice

Send invoice

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Delete invoice

Delete invoice

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret-key
string
Example: secret-key
integration-id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Get list of all accepted providers

Get list of all accepted providers

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Initiate payment

Initiate payment

Request Body schema: application/json
type
string

'invoice' or 'payment'

id
string

Hashed ID from the payment link (the one after i?= or p?=)

provider
string

Selected provider

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "id": "string",
  • "provider": "string"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Create recurring payments

Create recurring payments

header Parameters
secret_key
string
Example: secret-key
integration_id
string
Example: integration-id
Request Body schema: application/json
reference
required
string <= 12 characters ^[a-z0-9-]+$
recurringAmount
required
string^[0-9]*.[0-9]{2}$

The amount of money that will come to your bank account from the client during the active period of regular payments

recurringPaymentDate
required
string

Javascript date. First payment date of recurring payment. Note: Due to banks requirements , the first payment date must be 3 working days in the future.

numberOfPayments
required
integer

Expected number of payments. Set 0 for indefinite

frequency
required
string
Enum: "one_week" "one_month" "three_months" "one_year"

Time interval between payments.

initialPaymentAmount
string^[0-9]*.[0-9]{2}$

Set if you want to request single immediate payment

customerName
string
customerEmail
string
customerEmailCC
string

Responses

Request samples

Content type
application/json
{
  • "reference": "12345abc",
  • "recurringAmount": "0.50",
  • "recurringPaymentDate": "2022-12-24T00:00:00Z",
  • "numberOfPayments": 0,
  • "frequency": "one_week",
  • "initialPaymentAmount": "0.50",
  • "customerName": "string",
  • "customerEmail": "string",
  • "customerEmailCC": "string"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Save and send recurring payments

Save and send recurring payments

header Parameters
secret_key
string
Example: secret-key
integration_id
string
Example: integration-id
Request Body schema: application/json
reference
required
string <= 12 characters ^[a-z0-9-]+$
recurringAmount
required
string^[0-9]*.[0-9]{2}$

The amount of money that will come to your bank account from the client during the active period of regular payments

recurringPaymentDate
required
string

Javascript date. First payment date of recurring payment. Note: Due to banks requirements , the first payment date must be 3 working days in the future.

numberOfPayments
required
integer

Expected number of payments. Set 0 for indefinite

frequency
required
string
Enum: "one_week" "one_month" "three_months" "one_year"

Time interval between payments.

initialPaymentAmount
string^[0-9]*.[0-9]{2}$

Set if you want to request single immediate payment

customerName
string
customerEmail
string
customerEmailCC
string

Responses

Request samples

Content type
application/json
{
  • "reference": "12345abc",
  • "recurringAmount": "0.50",
  • "recurringPaymentDate": "2022-12-24T00:00:00Z",
  • "numberOfPayments": 0,
  • "frequency": "one_week",
  • "initialPaymentAmount": "0.50",
  • "customerName": "string",
  • "customerEmail": "string",
  • "customerEmailCC": "string"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Get recurring payments data

Get recurring payments data

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret_key
string
Example: secret-key
integration_id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Get list of all recurring payments

Get list of all recurring payments

header Parameters
secret_key
string
Example: secret-key
integration_id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Edit recurring payments

Edit recurring payments

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret_key
string
Example: secret-key
integration_id
string
Example: integration-id
Request Body schema: application/json
reference
required
string <= 12 characters ^[a-z0-9-]+$
recurringAmount
required
string^[0-9]*.[0-9]{2}$

The amount of money that will come to your bank account from the client during the active period of regular payments

recurringPaymentDate
required
string

Javascript date. First payment date of recurring payment. Note: Due to banks requirements , the first payment date must be 3 working days in the future.

numberOfPayments
required
integer

Expected number of payments. Set 0 for indefinite

frequency
required
string
Enum: "one_week" "one_month" "three_months" "one_year"

Time interval between payments.

initialPaymentAmount
string^[0-9]*.[0-9]{2}$

Set if you want to request single immediate payment

customerName
string
customerEmail
string
customerEmailCC
string

Responses

Request samples

Content type
application/json
{
  • "reference": "12345abc",
  • "recurringAmount": "0.50",
  • "recurringPaymentDate": "2022-12-24T00:00:00Z",
  • "numberOfPayments": 0,
  • "frequency": "one_week",
  • "initialPaymentAmount": "0.50",
  • "customerName": "string",
  • "customerEmail": "string",
  • "customerEmailCC": "string"
}

Response samples

Content type
application/json; charset=utf-8
No sample

Send recurring payment

Send recurring payment

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret_key
string
Example: secret-key
integration_id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Delete recurring payments

Delete recurring payments

path Parameters
id
required
string

Mongoose Object ID

header Parameters
secret_key
string
Example: secret-key
integration_id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample

Get list of payments of recurring payment

Get list of payments of recurring payment

header Parameters
secret_key
string
Example: secret-key
integration_id
string
Example: integration-id

Responses

Response samples

Content type
application/json; charset=utf-8
No sample