bbpay.one API (1.0.132)

Download OpenAPI specification:

License: Apache-2.0

Merchant API

Payments

Payments API

Get payments

Get a list of payments sorted by creation date (most recent first)

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.
created.gte	string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: created.gte=2025-10-12T10:26:18 Return only payments created at or after the specified time. Default is beginning of the current day.
created.lt	string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: created.lt=2025-10-13T10:39:34 If passed, return only payments created strictly before the specified time

Responses

Response samples

200
400
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"id": "91d27876e87f4b22b3ecd53924bf973d",
"created": "2025-10-25T10:11:12",
"updated": "2025-10-25T10:12:12",
"state": "PENDING",
"errorCode": "4.01 Insufficient Funds",
"type": "DEPOSIT",
"method": "BASIC_CARD",
"description": "Deposit via TEST shop",
"referenceId": "payment-123",
"parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
"startRecurring": true,
"recurringToken": "string",
"preAuth": true,
"merchantId": 0,
"merchantName": "string",
"shopId": 0,
"shopName": "string",
"providerId": 0,
"providerName": "string",
"terminalId": 0,
"terminalName": "string",
"externalId": "string",
"externalResultCode": "42",
"amount": 11.12,
"refundedAmount": 11.12,
"currency": "EUR",
"baseAmount": 15,
"customerAmount": 15,
"customerCurrency": "USD",
"shopBaseAmount": 15,
"shopBaseCurrency": "USD",
"customerReferenceId": "customer_123",
"customerAccountNumber": "string",
"customerCitizenshipCountryCode": "AU",
"customerFirstName": "John",
"customerLastName": "Smith",
"customerDateOfBirth": "2001-12-03",
"customerEmail": "[email protected]",
"customerPhone": "357 123123123",
"customerRoutingGroup": "John",
"customerIp": "127.0.0.1",
"customerIpCountryCode": "CY",
"billingCountryCode": "CY",
"billingPostalCode": "4141",
"billingCity": "Limassol",
"billingState": "CA",
"billingAddressLine1": "7, Sunny street",
"billingAddressLine2": "Office 3",
"cardholderName": "John Smith",
"cardBrand": "VISA",
"cardType": "CREDIT",
"cardCountryCode": "CY",
"cardIssuingOrganization": "BANK OF CYPRUS PUBLIC COMPANY LIMITED"
}
]
}

Operations

Payment operations API

Get payment operations

Get a list of payment operations sorted by completion date (most recent first)

Authorizations:

BasicAuth

query Parameters

offset	integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0.
limit	integer [ 1 .. 10000 ] The numbers of items to return. Default is 50.
completed.gte	string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: completed.gte=2025-10-12T10:26:18 Return only operations completed at or after the specified time. Default is beginning of the current day.
completed.lt	string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: completed.lt=2025-10-13T10:39:34 If passed, return only operations completed strictly before the specified time
operation.in	string Example: operation.in=CREATE_PAYMENT,CHECKOUT,CANCEL Comma-separated list of operations
paymentState.in	string Example: paymentState.in=CHECKOUT,COMPLETED,DECLINED Comma-separated list of payment states after operation completion

Responses

Response samples

200
400
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"hasMore": true,
"result": [{"id": 0,
"paymentId": "91d27876e87f4b22b3ecd53924bf973d",
"operation": "CREATE_PAYMENT",
"paymentState": "PENDING",
"started": "2025-10-25T10:12:12",
"completed": "2025-10-25T10:12:13",
"rawPaymentData": "string",
"terminalId": 0,
"terminalName": "string",
"paymentCreated": "2025-10-25T10:11:12",
"paymentType": "DEPOSIT",
"paymentMethod": "BASIC_CARD",
"paymentDescription": "Deposit via TEST shop",
"paymentReferenceId": "payment-123",
"paymentAmount": 11.12,
"paymentCurrency": "EUR",
"paymentBaseAmount": 15,
"parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
"merchantId": 0,
"merchantName": "string",
"shopId": 0,
"shopName": "string",
"providerId": 0,
"providerName": "string",
"errorCode": "4.01 Insufficient Funds",
"externalResultCode": "42",
"externalId": "string"
}
]
}

Terminals

Terminals API

Get terminal balance

Get terminal balance by terminal Id

Authorizations:

BasicAuth

path Parameters

terminalId

required

integer

Terminal Id

Responses

Response samples

200
401
404

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"result": {"available": [{"currency": "EUR",
"amount": 11.12
}
],
"reserved": [{"currency": "EUR",
"amount": 11.12
}
]
}
}

Balances

Balances API

Get balances

Get the list of all merchant balances

Authorizations:

BasicAuth

Responses

Response samples

200
400
401

Content type

application/json

{"timestamp": "2025-10-07T13:36:32.595+00:00",
"status": 200,
"result": [{"id": 123,
"accountType": "PROCESSING",
"name": "Processing Balance(EUR) of shop \"my-shop\" terminal \"payvision [payin]\"",
"currency": "EUR",
"amount": 1020.12
}
]
}