Release Payment Hold
If your use case requires transactions to be held for a variable period of time, use this API. Work with Link Money to send generated payments to a holding state after they are decisioned(no funds debited or held in the customers account). Use the API to release the hold and create the payment when you are ready.
Headers
Content-Type String - (Required)
application-json
Accept String - (Required)
application-json
Authorization String - (Required)
Bearer {ACCESS_TOKEN} (See Authentication)
Parameters
Returns
clientReferenceId String
Unique merchant-generated ID that identifies this payment. This ID is the same value that was submitted with the payment request.
paymentId String
Link Money-generated payment-related ID
paymentStatus enum
AUTHORIZED or TERMINAL_FAILED - indicates whether payment was initiated successfully.
POST Request
PUT - /v1/payments/{TRANSACTION_ID}/release1curl --location --request POST '{API_BASE_URL}/v1/payments/{transactionId}/release' \
2--header 'Content-Type: application/json' \
3--header 'Accept: application/json' \
4--header 'Authorization: Bearer {ACCESS_TOKEN}'
Response Body
1{
2 "paymentId": "5914646d1-7ab5-9553-8389-db80c5c5dda",
3 "paymentStatus": "AUTHORIZED",
4 "clientReferenceId": "TXN-1234"
5}
1{
2 "paymentId": "5914646d1-7ab5-9553-8389-db80c5c5dda",
3 "paymentStatus": "TERMINAL_FAILED",
4 "clientReferenceId": "TXN-1234",
5 "errorDetails": {
6 "errorCode": "PAYMENT_DECLINED",
7 "errorMessage": "Transaction amount is greater than the limit."
8 }
9}