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
amount required	string
customerName	string
dueDate	object JavaScript Date Object
attachmentUrl	string
customerEmail	string
customerEmailCC	string
type	string (PaymentTypes) Enum: "link" "qr" "mobile"

Responses

Request samples

Payload

Content type

application/json

{"invoiceRefNumber": "string",
"amount": "string",
"customerName": "string",
"dueDate": { },
"attachmentUrl": "string",
"customerEmail": "string",
"customerEmailCC": "string",
"type": "link"
}

Response samples

200
401

Content type

application/json; charset=utf-8

No sample

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
amount required	string
customerName	string
dueDate	object JavaScript Date Object
attachmentUrl	string
customerEmail	string
customerEmailCC	string
type	string (PaymentTypes) Enum: "link" "qr" "mobile"

Responses

Request samples

Payload

Content type

application/json

{"invoiceRefNumber": "string",
"amount": "string",
"customerName": "string",
"dueDate": { },
"attachmentUrl": "string",
"customerEmail": "string",
"customerEmailCC": "string",
"type": "link"
}

Response samples

200
401

Content type

application/json; charset=utf-8

No sample

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

200
401

Content type

application/json; charset=utf-8

No sample

Get list of all payments

header Parameters

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

Responses

Response samples

200
401

Content type

application/json; charset=utf-8

No sample

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

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"invoiceRefNumber": "string",
"amount": "string",
"customerName": "string",
"dueDate": { },
"attachmentUrl": "string",
"customerEmail": "string",
"customerEmailCC": "string"
}

Response samples

200
401

Content type

application/json; charset=utf-8

No sample

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

200
401

Content type

application/json; charset=utf-8

No sample

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

200
401

Content type

application/json; charset=utf-8

No sample

Create invoice

header Parameters

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

Request Body schema: application/json

invoiceRefNumber required	string
amount required	string
customerName	string
dueDate	object JavaScript Date Object
attachmentUrl	string
customerEmail	string
customerEmailCC	string

Responses

Request samples

Payload

Content type

application/json

{"invoiceRefNumber": "string",
"amount": "string",
"customerName": "string",
"dueDate": { },
"attachmentUrl": "string",
"customerEmail": "string",
"customerEmailCC": "string"
}

Response samples

200
401

Content type

application/json; charset=utf-8

No sample

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
amount required	string
customerName	string
dueDate	object JavaScript Date Object
attachmentUrl	string
customerEmail	string
customerEmailCC	string

Responses

Request samples

Payload

Content type

application/json

{"invoiceRefNumber": "string",
"amount": "string",
"customerName": "string",
"dueDate": { },
"attachmentUrl": "string",
"customerEmail": "string",
"customerEmailCC": "string"
}

Response samples

200
401

Content type

application/json; charset=utf-8

No sample

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

200
401

Content type

application/json; charset=utf-8

No sample

Get list of all payments

header Parameters

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

Responses

Response samples

200
401

Content type

application/json; charset=utf-8

No sample

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
amount required	string
customerName	string
dueDate	object JavaScript Date Object
attachmentUrl	string
customerEmail	string
customerEmailCC	string

Responses

Request samples

Payload

Content type

application/json

{"invoiceRefNumber": "string",
"amount": "string",
"customerName": "string",
"dueDate": { },
"attachmentUrl": "string",
"customerEmail": "string",
"customerEmailCC": "string"
}

Response samples

200
401

Content type

application/json; charset=utf-8

No sample

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

200
401

Content type

application/json; charset=utf-8

No sample

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

200
401

Content type

application/json; charset=utf-8

No sample

Get list of all accepted providers

Responses

Response samples

200
401

Content type

application/json; charset=utf-8

No sample

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

Payload

Content type

application/json

{"type": "string",
"id": "string",
"provider": "string"
}

Response samples

200
401

Content type

application/json; charset=utf-8

No sample