Alpha's Payments APIs enable you to create and submit payment requests to the Alpha conveniently. You can initiate a payment request to transfer funds to your own accounts, or to an external individual or company beneficiary.

The APIs provide you with the ability to pre-validate a payment request before submitting the request to reduce the chance of validation failure during payment creation.

Finally, the API provides you with the ability to retrieve the details of an existing payment and retrieve payment confirmation documents for a submitted payment.

Validate a payment

Before creating a payment request, you can ensure that the payment details are correct using the POST validate payment endpoint. The endpoint validates the payment details, without creating a record of the payment.

💭 While this step is not mandatory in the payment creation process, we recommend you validate the payment details first as it will reduce the risk of failure.

You must specify AccountID PaymentDate Amount and Currency in the request.

Create a payment

Create a single payment using the POST Payments endpoint.

The payments created using this endpoint must be in the same currency as the recipients' account.

The payment can be sent to an existing, pre-validated beneficiary using the CreditorAccountID field or, you can add new beneficiary instructions in the payment request under CreditorAccount.

You must specify AccountID PaymentDate Amount and Currency in the request.

For Alternative Banking Solutions entities, if the payment in related to a trade, you will also be able to provide the TradeId to link the payment to the trade.

You can retrieve the earliest payment value date using the GET payments/earliest-settlement endpoint.

🚫 Alternative Banking Solutions entities will need to have funds on account to initiate a payment request. If there are insufficient funds the payment status will be Rejected.

⏱️ Risk Management entities do not need to have funds on account to initiate a payment request. If there are insufficient funds the payment status will be Pending until the funds are received.

Retrieve payment details

Get the details for an individual payment using the GET payment endpoint. You will need to provide the paymentIdin the request.

The paymentIdwill be provided in the response after successfully creating a payment.

Retrieve all payments details

Get details for all payments for a specific entity using the GET payments endpoint.

Filter your results by sending the following parameters in your request.

Status,FromOrderDate, To OrderDate,FromValueDate, ToValueDate,SearchText orBeneficiaryID

The response will be a filtered list based on the parameters provided.

Retrieve a payment confirmation document

Get a payment confirmation document for a specific payment using the GET Payment Confirmation Document endpoint.

You will need to pass the paymentId in the request.

The response will contain a representation of the document which can be converted to a pdf.

Should there be a linked trade to the payment, the confirmation document will also contain the trade details.

Retrieve Purpose of Payment

Utilise the GET Purpose of Payment endpoint to verify if a purpose code is required to make a payment. The list of available codes will be returned in the response if a purpose code is required.

You will need to include in your request the CountryCode and CurrencyCode.

For the technical implementation details, please see the Payments API reference.