All pages
Powered by GitBook
1 of 1

Loading...

Confirm payment

After initialising the payment, we need to confirm it to complete the payment.

Use case

Here, we will confirm a payment draft using the payment ID parameter.

Use case data
API parameters with values

The payment ID is taken from the response to the payment initialisation request.

An optional comment.

Sample API call

To confirm the payment, use the following endpoint:

Sample request

The sample request body is as follows:

{
"comment": "Confirm payment"
}
curl --location 'https://payment-api.sandbox.tuumplatform.com/api/v3/payments/PAYM-47356/confirm' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjQtMDItMDhUMTY6MTU6NTkiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHAiOjE3MDc0MDg5NTl9.9ra--2cschOt3BvgdMrq_yrKgVhZrPCiX6ea0IXkX08' \
--header 'Content-Type: application/json' \
--data '"comment": "Confirm payment"'

Sample response

Below you will find the response to the sample request:

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "paymentId": "PAYM-47356",
        "accountId": "ID-1002",
        "directionCode": "OUT",
        "statusCode": "WAITING_FOR_AML",
        "errorCode": null,
        "money": {
            "amount": 10.00,
            "currencyCode": "EUR"
        },
        "details": "Lunch payment",
        "referenceNumber": null,
        "source": null,
        "contractSource": null,
        "endToEndId": null,
        "valueDate": "2026-09-06",
        "postingDate": "2026-09-06",
        "insertedDateTime": "2024-02-08T14:36:47.339803Z",
        "paymentServiceProviderCode": "SEPA",
        "paymentTypeCode": "ACC2SEPA",
        "preferredPaymentScheme": null,
        "selectedPaymentScheme": "SEPA_INSTANT",
        "chargeBearer": null,
        "settlementStatusCode": null,
        "settlementErrorCode": null,
        "settlementDate": null,
        "settlementPaymentScheme": null,
        "returnStatusCode": null,
        "returnReason": null,
        "returnComment": null,
        "returnSettlementDate": null,
        "cancellationRequestStatusCode": null,
        "cancelRefuseReason": null,
        "cancelReason": null,
        "amlMonitoringEnabled": true,
        "lastStatusRequestDate": null,
        "residencyCountryCode": "FI",
        "counterpartyOriginalIban": null,
        "fxPaymentFlag": false,
        "fxPayment": null,
        "paymentParties": [
            {
                "paymentPartyId": "PAYM-115887",
                "typeCode": "OUR_PARTY",
                "name": "Damara Kai",
                "personTypeCode": "P",
                "givenName": "Damara",
                "surname": "Kai",
                "accountNumber": {
                    "value": "XX10XXXX99999000000000000000012",
                    "type": "IBAN"
                },
                "accountNumberCountryCode": "XX",
                "financialInstitutionId": {
                    "value": "ICECLOUDXXX",
                    "type": "BIC"
                },
                "address": {
                    "street1": "Fennstrasse 4",
                    "street2": "string",
                    "cityCounty": "Berlin",
                    "stateRegion": "Berlin",
                    "zip": "13347",
                    "countryCode": "DE",
                    "addressLine": "Fennstrasse 4, string, Berlin, DE, 13347"
                },
                "nationalIdentificationNumber": null,
                "roleCode": "PAYER"
            },
            {
                "paymentPartyId": "PAYM-115888",
                "typeCode": "COUNTERPARTY",
                "name": "Ben Eficiary",
                "personTypeCode": null,
                "givenName": null,
                "surname": null,
                "accountNumber": {
                    "value": "EE871275295834652820",
                    "type": "IBAN"
                },
                "accountNumberCountryCode": "EE",
                "financialInstitutionId": {
                    "value": "PARXEE22XXX",
                    "type": "BIC"
                },
                "address": null,
                "nationalIdentificationNumber": null,
                "roleCode": "BENEFICIARY"
            }
        ],
        "fees": [
            {
                "feeTypeCode": "ACC2SEPA_FEE",
                "feeMoney": {
                    "amount": 0.05,
                    "currencyCode": "EUR"
                },
                "deferredFee": false
            }
        ],
        "paymentSchemeElements": [],
        "fileImportLineNumber": null
    }
}

Result

The payment is confirmed with the statusCode WAITING_FOR_AML. You can check the AML-related information using the AML API. You can also manually approve or decline a payment detected by the AML monitoring system.

https://payment-api.sandbox.tuumplatform.com/api/v3/payments/PAYM-47356/confirm

Learn more about the endpoint in the Tuum developer portal.

".../PAYM-47356/confirm"
{ "comment": "Confirm payment" }
confirm payment