Create SEPA payment

Here, you can find one of the examples of how to create a draft payment using the initialise payment API endpoint.

Use case

In this scenario, we will create an outgoing SEPA payment - ACC2SEPA payment type.

Use case data	API parameters with values
Our party details gives the information about the sender of the payment. In this example, the payment is initialised from the Tuum account ID-4184.	"typeCode": "OUR_PARTY", "accountId": "ID-4184"
Counterparty details.	{ "typeCode": "COUNTERPARTY", "name": "Robert Receiver", "accountNumber": { "value": "EE871275295834652820", "type": "IBAN" }
Payment amount and currency.	"money": { "amount": "25", "currencyCode": "EUR" }
Payment details.	"details": "Test payment with our party accountId"
The payment also includes payment steering data, such as valueDate and ourFee. Note: the valueDate and ourFee parameters are optional.	"valueDate" : "2024-12-04", "ourFee": { "amount": 1.22, "currencyCode": "EUR"

Sample API call

To initialise the payment, use the following endpoint:

https://payment-api.sandbox.tuumplatform.com/api/v3/payments/initialise

Learn more about the initialise payment endpoint endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

JSON

{
    "paymentParties": [
        {
            "typeCode": "OUR_PARTY",
            "accountId": "ID-4184"
        },
        {
            "typeCode": "COUNTERPARTY",
            "name": "Robert Receiver",
            "accountNumber": {
                "value": "EE871275295834652820",
                "type": "IBAN"
            }
        }
    ],
    "money": {
        "amount": 25,
        "currencyCode": "EUR"
    },
    "details": "Test payment with our party accountId",
    "valueDate" : "2024-12-04",
    "ourFee": {
         "amount": 1.22,
         "currencyCode": "EUR"
  }
}

cURL

curl --location 'https://payment-api.sandbox.tuumplatform.com/api/v3/payments/initialise' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHBpcnlEVGltZSI6IjIwMjQtMTItMDRUMTQ6MjY6MTkiLCJleHAiOjE3MzMzMjIzNzksInJvbGVzIjpbIkFETUlOIl19.X1C4fpzVoXZnbicLPFW7izPPRLKGs-wGw6xoETGAypE' \
--header 'Content-Type: application/json' \
--data '{
    "paymentParties": [
        {
            "typeCode": "OUR_PARTY",
            "accountId": "ID-4184"
        },
        {
            "typeCode": "COUNTERPARTY",
            "name": "Robert Receiver",
            "accountNumber": {
                "value": "EE871275295834652820",
                "type": "IBAN"
            }
        }
    ],
    "money": {
        "amount": 25,
        "currencyCode": "EUR"
    },
    "details": "Test payment with our party accountId",
    "valueDate" : "2024-12-04",
    "ourFee": {
         "amount": 1.22,
         "currencyCode": "EUR"
  }
}'

Sample response

Below you will find the response to the sample request:

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "paymentId": "PAYM-32706",
        "accountId": "ID-4184",
        "directionCode": "OUT",
        "statusCode": "INSERTED",
        "errorCode": null,
        "money": {
            "amount": 25.00,
            "currencyCode": "EUR"
        },
        "details": "Test payment with our party accountId",
        "referenceNumber": null,
        "source": null,
        "contractSource": null,
        "endToEndId": null,
        "valueDate": "2024-12-04",
        "postingDate": "2024-12-04",
        "insertedDateTime": "2024-12-04T13:28:52.498788Z",
        "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,
        "amlDeclineReason": null,
        "amlMonitoringEnabled": null,
        "lastStatusRequestDate": null,
        "residencyCountryCode": "GB",
        "counterpartyOriginalIban": null,
        "fxPaymentFlag": false,
        "fxPayment": null,
        "paymentParties": [
            {
                "paymentPartyId": "PAYM-67504",
                "typeCode": "COUNTERPARTY",
                "name": "Robert Receiver",
                "personTypeCode": null,
                "givenName": null,
                "surname": null,
                "accountNumber": {
                    "value": "EE871275295834652820",
                    "type": "IBAN"
                },
                "accountNumberSubtype": null,
                "accountNumberCountryCode": "EE",
                "financialInstitutionId": {
                    "value": "PARXEE22XXX",
                    "type": "BIC"
                },
                "address": null,
                "roleCode": "BENEFICIARY",
                "partyIdentification": null
            },
            {
                "paymentPartyId": "PAYM-67505",
                "typeCode": "OUR_PARTY",
                "name": "Tuum Thomas",
                "personTypeCode": "P",
                "givenName": "Tuum",
                "surname": "Thomas",
                "accountNumber": {
                    "value": "XX20XXXX99999000000000000021075",
                    "type": "IBAN"
                },
                "accountNumberSubtype": null,
                "accountNumberCountryCode": "XX",
                "financialInstitutionId": {
                    "value": "ICECLOUDXXX",
                    "type": "BIC"
                },
                "address": {
                    "street1": "24 Botley Road",
                    "street2": null,
                    "cityCounty": "Middleton Hall",
                    "stateRegion": null,
                    "zip": "NE71 3LL",
                    "countryCode": "GB",
                    "addressLine": "24 Botley Road, Middleton Hall, GB, NE71 3LL",
                    "addressTypeCode": null
                },
                "roleCode": "PAYER",
                "partyIdentification": {
                    "identificationTypeCode": "NATIONAL_IDENTIFICATION_NUMBER",
                    "identificationValue": "DD654321C"
                }
            }
        ],
        "fees": [
            {
                "feeTypeCode": "ACC2SEPA_FEE",
                "feeMoney": {
                    "amount": 1.22,
                    "currencyCode": "EUR"
                },
                "deferredFee": false
            }
        ],
        "paymentSchemeElements": [],
        "fileImportLineNumber": null,
        "purposeCode": null,
        "labels": [
            "COUNTERPARTY_EE",
            "SEPA_INSTANT"
        ]
    }
}

Result

The draft payment has been created with a paymentId: PAYM-32706 and the statusCode: INSERTED.

Possible next steps

After creating a draft payment, you have the following options:

1. Change the draft payment - modify the draft payment.

2. Cancel the draft payment - discard the draft payment if it is no longer required.

3. Confirm the draft payment - complete payment to initiate further payment processing.