In this scenario, we will initialise an outgoing SWIFT (cross border) payment to a counterparty account with an IBAN and some sample data - ACC2SWIFT payment type.
Our party details gives the information about the sender of the payment. In this example, the payment is initialised from the Tuum account ID-1887.
Counterparty details.
Payment amount.
Payment details.
The payment also includes additional transferable data, such as chargeBearer and endToEndId. Note: the chargeBearer and endToEndId parameters are optional.
To initialise the payment, use the following endpoint:
The sample request body is as follows:
Below you will find the response to the sample request:
The draft payment has been created with a paymentId: PAYM-21846 and the statusCode: INSERTED.
After creating a draft payment, you have the following options:
https://payment-api.sandbox.tuumplatform.com/api/v3/payments/initialise
Learn more about the endpoint in the Tuum developer portal.
- modify the draft payment.
- discard the draft payment if it is no longer required.
- complete payment to initiate further payment processing.
In this section, you will find instructions on how to create the following types of outgoing payments:
In this scenario, we will create an outgoing SEPA payment - ACC2SEPA payment type.
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.
Counterparty details.
Payment amount and currency.
Payment details.
The payment also includes payment steering data, such as valueDate and ourFee. Note: the valueDate and ourFee parameters are optional.
To initialise the payment, use the following endpoint:
The sample request body is as follows:
Below you will find the response to the sample request:
The draft payment has been created with a paymentId: PAYM-32706 and the statusCode: INSERTED.
After creating a draft payment, you have the following options:
https://payment-api.sandbox.tuumplatform.com/api/v3/payments/initialise
Learn more about the endpoint endpoint in the Tuum developer portal.
- modify the draft payment.
- discard the draft payment if it is no longer required.
- complete payment to initiate further payment processing.
Here, you can find one of the examples of how to create a draft payment using the .
Here, you can find one of the examples of how to create a draft payment using the .
In this scenario, we will create a domestic UK payment from Tuum BC (Banking Circle) UK account to another UK account. In this case, the payment will be created with the ACC2LOCAL payment type.
Our party details give the information about the sender of the payment.
In this example, the payment is initialised from the Tuum bank account with 21824474 BBAN.
The payer's account country is the UK. Note: the payer's bank account financial institution id is the bank's sort code.
Counterparty details.
The payment receiver account country is the UK. Note: the payment receiver financial institution id is the bank's sort code.
Payment amount and currency.
Payment details.
The payment also includes non-transferrable data, such as contractSource. Note: the contractSource parameter is optional.
The sample request body is as follows:
Below you will find the response to the sample request:
The draft payment has been created with a paymentId: PAYM-21826 and the statusCode: INSERTED.
After creating a draft payment, you have the following options:
Here, you can find one of the examples of how to create a draft payment using the .
To initialise the payment, use the following endpoint:
https://payment-api.sandbox.tuumplatform.com/api/v3/payments/initialise
Learn more about the endpoint endpoint in the Tuum developer portal.
- modify the draft payment.
- discard the draft payment if it is no longer required.
- complete payment to initiate further payment processing.
In this scenario, we will create a domestic US payment - ACC2LOCAL payment type.
The sample request body is as follows:
Below you will find the response to the sample request:
The draft payment has been created with a paymentId: PAYM-21726 and the statusCode: INSERTED.
After creating a draft payment, you have the following options:
To initialise the payment, use the following endpoint:
https://payment-api.sandbox.tuumplatform.com/api/v3/payments/initialise
Learn more about the endpoint endpoint in the Tuum developer portal.
- modify the draft payment.
- discard the draft payment if it is no longer required.
- complete payment to initiate further payment processing.
Our party details gives the information about the sender of the payment.
In this example, the payment is initialised from the Tuum bank account with 190021824474 BBAN.
The payer's account country is the USA. Note: the payer's bank account financial institution id is the ABA Routing number.
Counterparty details.
The payer's account country is the USA. Note: the payer's bank account financial institution id is the ABA Routing number.
Payment amount and currency.
Payment details.
The payment also includes payment steering data, such as usageLimitCode. Note: the usageLimitCode is an optional parameter.
Here, you can find one of the examples of how to create a draft payment using the .