QuickPayments

Create a one-time payment link.

SecurityBearer or Bearer or Bearer or Bearer
Request
header Parameters
x-api-version
string
Request Body schema: application/json

The one-time payment link creation request.

amount
number <double>

Amount should be greater than 0.

referenceId
string or null

ReferenceId maximum length is 100 symbols.

customerId
string or null <uuid>
Responses
200

Success

post/pay-int-api/quick-payments/one-time
Request samples
application/json
{
  • "amount": 0,
  • "referenceId": "string",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get list of one-time links.

SecurityBearer or Bearer or Bearer or Bearer
Request
query Parameters
page
integer <int32>
pageSize
integer <int32>
orderBy
string
asc
boolean
search
string
header Parameters
x-api-version
string
Responses
200

Success

get/pay-int-api/quick-payments/one-time
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get details of a one-time link.

SecurityBearer or Bearer or Bearer or Bearer
Request
path Parameters
quickPaymentId
required
string <uuid>

The unique identifier of the one-time payment link to retrieve.

header Parameters
x-api-version
string
Responses
200

Success

get/pay-int-api/quick-payments/one-time/{quickPaymentId}
Request samples
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 0,
  • "referenceId": "string",
  • "status": 1,
  • "shortUrl": "string",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "customerName": "string",
  • "createdOn": "2019-08-24T14:15:22Z"
}

Activate payment link.

SecurityBearer or Bearer or Bearer or Bearer
Request
path Parameters
quickPaymentId
required
string <uuid>

The unique identifier of the payment link.

header Parameters
x-api-version
string
Responses
200

Success

post/pay-int-api/quick-payments/{quickPaymentId}/activate
Request samples

Deactivate payment link.

SecurityBearer or Bearer or Bearer or Bearer
Request
path Parameters
quickPaymentId
required
string <uuid>

The unique identifier of the payment link.

header Parameters
x-api-version
string
Responses
200

Success

post/pay-int-api/quick-payments/{quickPaymentId}/deactivate
Request samples

Send link by SMS.

Customer concent and phone number are required.

SecurityBearer or Bearer or Bearer or Bearer
Request
path Parameters
quickPaymentId
required
string <uuid>

The unique identifier of a payment link.

header Parameters
x-api-version
string
Request Body schema: application/json

The request containing the details for the SMS notification.

phoneNumber
string or null
customerConsent
boolean
Responses
200

Success

post/pay-int-api/quick-payments/{quickPaymentId}/send-sms-notification
Request samples
application/json
{
  • "phoneNumber": "string",
  • "customerConsent": true
}

Create a reusable payment link.

SecurityBearer or Bearer or Bearer or Bearer
Request
header Parameters
x-api-version
string
Request Body schema: application/json

The payment link creation request.

amount
number <double>

Amount should be greater than 0.

Responses
200

Success

post/pay-int-api/quick-payments/reusable
Request samples
application/json
{
  • "amount": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get list of reusable links.

SecurityBearer or Bearer or Bearer or Bearer
Request
query Parameters
page
integer <int32>
pageSize
integer <int32>
orderBy
string
asc
boolean
status
integer <int32> (PaymentIntegrations.Contracts.Enums.QuickPaymentStatus)

Payment link status

Possible values:

  • 1 - Active:
  • 2 - Inactive:
  • 3 - Expired:
  • 4 - Completed:
Enum: 1 2 3 4
header Parameters
x-api-version
string
Responses
200

Success

get/pay-int-api/quick-payments/reusable
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "total": 0
}

Get details of a reusable link.

SecurityBearer or Bearer or Bearer or Bearer
Request
path Parameters
quickPaymentId
required
string <uuid>

The unique identifier of the reusable payment link to retrieve.

header Parameters
x-api-version
string
Responses
200

Success

get/pay-int-api/quick-payments/reusable/{quickPaymentId}
Request samples
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 0,
  • "status": 1,
  • "shortUrl": "string",
  • "totalTransactionsAmount": 0,
  • "totalTransactionsCount": 0,
  • "createdOn": "2019-08-24T14:15:22Z"
}