Single Currency Payments
Create, validate and retrieve single currency payments
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.
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. If the payment in relation 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.
Retrieve payment details
Get the details for a particular payment using the paymentId
.
The paymentId
will be provided in the response after successfully creating a payment.
To retrieve details for multiple payments, you can use the GET Transactions
endpoint, where you will be able to filter results by multiple parameters.
Retrieve a payment confirmation document
Get a payment confirmation document for a specific payment.
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.
For the technical implementation details, please see the Payments API reference.
Updated 17 days ago