Built-in Functions

PayScript offers built-in functions as the interface to interact with banking systems, as well as other utilities. This is the comprehensive list of functions available, and the data types used in them.

Account Functions

boolean accountExists(AccountIdentifier accountIdentifier)

Checks whether an account exists.

boolean checkAccountFunds(AccountIdentifier accountIdentifier, BigDecimal amount)

Checks whether an account has the required funds available.

BalanceInfo getBalance(AccountIdentifier accountIdentifier)

Shows the total balance and available balance for an account.

List<RelatedAccountInfo> getRelatedAccountIds(AccountIdentifier accountIdentifier)

Retrieve the number of accounts related to a specified account.

ConsentStatus getConsent(AccountIdentifier giverAccountId, AccountIdentifier holderAccountId, ConsentType type)

Retrieve consent status for a particular account.

Payment Functions

String createPayment(PaymentInfo paymentInfo)

Creates a payment based on paymentInfo.

UUID requestPayment(String payerAccountNumber, String payeeAccountNumber, BigDecimal amount, String purpose)

Sends a payment request from one account to another.

Payment getPaymentInfo(String paymentId)

Retrieve payment information for payment with paymentId.

UUID requestPayment(PaymentInfo paymentInfo)

Sends a request for paymentInfo.

Lock Functions

String createLock(LockInfo lockInfo)

Creates a lock based on the data object LockInfo, returning the ID of the created lock.

String getLockStatus(String lockId)

Returns the status of the lock with id lockId

Lock getLockInfo(String lockId)

Returns the Lock object with lockId

void releaseLock(String lockId)

Releases the funds from the lock lock with lockId

List<LockInfo> getAccountLocks(AccountIdentifier accountIdentifier)

Return a list of LockInfo representing all the locks which belong to the account identified by accountIdentifier

Reserve Functions

Reserve reserve createReserve(Reserve reserve)

Creates a reserve based on the Reserve object provided

List<reserveInfo> getAccountReserves(AccountIdentifier accountIdentifier)

Gets the list of all account reserves.

ReserveInfo reserve getReserveInfo(String reserveId)

Get a reserve’s details.

UUID reserveTransactionId moveFundsBetweenReserves(String fromReserve, String toReserve,BigDecimal amount, String reference)

Move funds from one reserve to another.

List<ReserveTransaction> transactions getReserveTransactions(UUID reserveId, ReserveTransactionsFilter filter, Integer offset, Integer limit)

Get the list of reserve’s transactions, based on specified filters, ordered by date (latest transactions first in the list)

Integer totalTransactions getReserveTransactionsCount(UUID reserveId, ReserveTransactionsFilter filter)

Get total number of a reserve’s transactions, based on specified filters

UUID reserveTransactionId addFundsToReserve(String fromAccount, String toReserve, decimal amount, String reference)

Sets aside an amount of funds from the account fromAccount into the reserve toReserve. The transaction reference used is the text reference.

UUID reserveTransactionId withdrawFundsFromReserve(fromReserve, toAccount, amount, reference);

Withdraws an amount of funds into the account toAccount from the reserve fromReserve. The transaction reference used is the text reference.

UUID reserveId editReserve(UpdateReserveInfo updateReserveInfo)

Applies the update defined in the object updateReserveInfo.

void deleteReserve(UUID reserveId)

Deletes the reserve with ID reserveId.

Utility Functions

Object callScript(String scriptId, List<Map<String, Object>>... params)

Triggers a script which has trigger type “sub_script”, passing params as its list of map of parameter names to parameters.

void logMessage(String message)

Logs the messages inside the script

Data Objects

Data objects are used as parameters in some built-in functions. Their attributes can be accessed by default getters and setters. The data objects can be instantiated through the builder pattern. For example:

def payment = PaymentInfo.builder()
        .payer(AccountInfo.builder()
                .type(AccountIdentifierType.SCAN)
                .identifier(payer)
                .build())
        .payee(AccountInfo.builder()
                .type(AccountIdentifierType.SCAN)
                .identifier(payee)
                .build())
        .amountInfo(AmountInfo.builder()
                .currency(CurrencyEnum.GBP)
                .amount(amount)
                .build())
        .paymentReference("This is a payment.")
        .build();

BalanceInfo

Attributes:
BigDecimal totalBalance: A total balance of funds in an account, which includes funds in locks and reserves.
BigDecimal availableBalance: The balance of funds in an account which is not committed to locks or reserves.

PaymentInfo

Attributes:
UUID id: The unique identifier of the payment
AccountInfo payer: The account providing funds
AccountInfo payee: The account receiving funds
AmountInfo amount: Amount of funds being transferred
String purpose: Text that should provide context for the payment
PaymentStatus status:
Instant createdAt:
Instant updatedAt:

UpdateReserveInfo

Creates an object containing values to use to update a reserve’s attributes. See an example of reserve update.
Attributes:
String reserveId: The UUID of the existing reserve
String name: The name to be applied with the update
Integer priority: The priority number to be applied with the update
BigInteger SavingGoal: The goal of savings to be applied with the update
String description: The description to be applied with the update

GetAmountInfoResponse

Attributes:
Amount totalBalance
Amount availableBalance

LockInfo

Attributes:
UUID lockId: The global ID of the lock
OffsetDateTime createdAt: The Instant representing the time at which the Lock was created
BigDecimal amount: The amount of funds that are locked by this Lock
String currency: The currency of the funds locked by this lock
UUID to: Whom the funds locked by this lock have been locked to
OffsetDateTime expiryDate: An Instant representing the time from which the lock will expire
String description: A descriptive text about the lock
String status: Status of the lock

SCAN

The account identifiers used within the UK Domestic Banking System. Attributes:
String sortCode
String accountNumber

PAN

The Primary Account Number, or Payment Card Number, used as the identifier of payment cards, as defined in ISO/IEC 7812-1:2017 Identification cards — Identification of issuers
Attributes:
String pan

IBAN

The International Bank Account Number, used as a standard in cross-border payments within participating countries, as defined in ISO 13616-1:2020 Financial services — International bank account number (IBAN)
Attributes:
String iban

BicSwift

The Business Identifier Code (BIC), used in a Swift network as defined in ISO 9362:2022 Banking — Banking telecommunication messages — Business identifier code (BIC)
Attributes:
String bic String swift

RelatedAccountInfo

Attributes:
AccountIdentifier accountIdentifier AccountIdentifierType type

AccountIdentifierType

Enum values:
{ SCAN,IBAN,PAN, BICSWIFT}

ConsentStatus

Enum values:
{GIVEN, NOT_GIVEN, REQUESTED }

LockStatus

Enum values:
{ACTIVE, PROCESSING, RELEASE_FAILED}

AmountInfo

Enum currency Bigdecimal amount

Reserve

Attributes:
AccountIdentifier accountIdentifier String name Integer priority BigDecimal savingGoal String description