Create SWIFT payment

Create Swift payment

curl --request POST \
  --url https://api.pgw-sandbox.finventi.com/v2/transactions/swift \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 1050299,
  "charges": {
    "agentBic": "CHRGBICXXXX",
    "amount": 2550,
    "bearer": "DEBT",
    "currency": "EUR"
  },
  "clearingChannel": "RTGS",
  "creditor": {
    "agentBic": "INVELT2XXXX",
    "name": "Creditor Company Incorporated",
    "otherAccount": {
      "id": "9876543210",
      "issuer": "DEUTDEFF",
      "scheme": "BBAN"
    }
  },
  "currency": "EUR",
  "debtor": {
    "iban": "LT121000011101001000",
    "name": "Debtor Company Limited"
  },
  "endToEndId": "TXN123456789012345",
  "priority": "HIGH",
  "remittance": "Payment for invoice #INV-2025-001234",
  "serviceLevel": "URGP",
  "settlement": {
    "bic": "DEUTDEFFXXX",
    "date": "2025-07-04",
    "iban": "GB29NWBK60161331926819",
    "method": "INDA"
  }
}
'

import requests

url = "https://api.pgw-sandbox.finventi.com/v2/transactions/swift"

payload = {
    "amount": 1050299,
    "charges": {
        "agentBic": "CHRGBICXXXX",
        "amount": 2550,
        "bearer": "DEBT",
        "currency": "EUR"
    },
    "clearingChannel": "RTGS",
    "creditor": {
        "agentBic": "INVELT2XXXX",
        "name": "Creditor Company Incorporated",
        "otherAccount": {
            "id": "9876543210",
            "issuer": "DEUTDEFF",
            "scheme": "BBAN"
        }
    },
    "currency": "EUR",
    "debtor": {
        "iban": "LT121000011101001000",
        "name": "Debtor Company Limited"
    },
    "endToEndId": "TXN123456789012345",
    "priority": "HIGH",
    "remittance": "Payment for invoice #INV-2025-001234",
    "serviceLevel": "URGP",
    "settlement": {
        "bic": "DEUTDEFFXXX",
        "date": "2025-07-04",
        "iban": "GB29NWBK60161331926819",
        "method": "INDA"
    }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 1050299,
    charges: {agentBic: 'CHRGBICXXXX', amount: 2550, bearer: 'DEBT', currency: 'EUR'},
    clearingChannel: 'RTGS',
    creditor: {
      agentBic: 'INVELT2XXXX',
      name: 'Creditor Company Incorporated',
      otherAccount: {id: '9876543210', issuer: 'DEUTDEFF', scheme: 'BBAN'}
    },
    currency: 'EUR',
    debtor: {iban: 'LT121000011101001000', name: 'Debtor Company Limited'},
    endToEndId: 'TXN123456789012345',
    priority: 'HIGH',
    remittance: 'Payment for invoice #INV-2025-001234',
    serviceLevel: 'URGP',
    settlement: {
      bic: 'DEUTDEFFXXX',
      date: '2025-07-04',
      iban: 'GB29NWBK60161331926819',
      method: 'INDA'
    }
  })
};

fetch('https://api.pgw-sandbox.finventi.com/v2/transactions/swift', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pgw-sandbox.finventi.com/v2/transactions/swift",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 1050299,
    'charges' => [
        'agentBic' => 'CHRGBICXXXX',
        'amount' => 2550,
        'bearer' => 'DEBT',
        'currency' => 'EUR'
    ],
    'clearingChannel' => 'RTGS',
    'creditor' => [
        'agentBic' => 'INVELT2XXXX',
        'name' => 'Creditor Company Incorporated',
        'otherAccount' => [
                'id' => '9876543210',
                'issuer' => 'DEUTDEFF',
                'scheme' => 'BBAN'
        ]
    ],
    'currency' => 'EUR',
    'debtor' => [
        'iban' => 'LT121000011101001000',
        'name' => 'Debtor Company Limited'
    ],
    'endToEndId' => 'TXN123456789012345',
    'priority' => 'HIGH',
    'remittance' => 'Payment for invoice #INV-2025-001234',
    'serviceLevel' => 'URGP',
    'settlement' => [
        'bic' => 'DEUTDEFFXXX',
        'date' => '2025-07-04',
        'iban' => 'GB29NWBK60161331926819',
        'method' => 'INDA'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pgw-sandbox.finventi.com/v2/transactions/swift"

	payload := strings.NewReader("{\n  \"amount\": 1050299,\n  \"charges\": {\n    \"agentBic\": \"CHRGBICXXXX\",\n    \"amount\": 2550,\n    \"bearer\": \"DEBT\",\n    \"currency\": \"EUR\"\n  },\n  \"clearingChannel\": \"RTGS\",\n  \"creditor\": {\n    \"agentBic\": \"INVELT2XXXX\",\n    \"name\": \"Creditor Company Incorporated\",\n    \"otherAccount\": {\n      \"id\": \"9876543210\",\n      \"issuer\": \"DEUTDEFF\",\n      \"scheme\": \"BBAN\"\n    }\n  },\n  \"currency\": \"EUR\",\n  \"debtor\": {\n    \"iban\": \"LT121000011101001000\",\n    \"name\": \"Debtor Company Limited\"\n  },\n  \"endToEndId\": \"TXN123456789012345\",\n  \"priority\": \"HIGH\",\n  \"remittance\": \"Payment for invoice #INV-2025-001234\",\n  \"serviceLevel\": \"URGP\",\n  \"settlement\": {\n    \"bic\": \"DEUTDEFFXXX\",\n    \"date\": \"2025-07-04\",\n    \"iban\": \"GB29NWBK60161331926819\",\n    \"method\": \"INDA\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pgw-sandbox.finventi.com/v2/transactions/swift")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1050299,\n  \"charges\": {\n    \"agentBic\": \"CHRGBICXXXX\",\n    \"amount\": 2550,\n    \"bearer\": \"DEBT\",\n    \"currency\": \"EUR\"\n  },\n  \"clearingChannel\": \"RTGS\",\n  \"creditor\": {\n    \"agentBic\": \"INVELT2XXXX\",\n    \"name\": \"Creditor Company Incorporated\",\n    \"otherAccount\": {\n      \"id\": \"9876543210\",\n      \"issuer\": \"DEUTDEFF\",\n      \"scheme\": \"BBAN\"\n    }\n  },\n  \"currency\": \"EUR\",\n  \"debtor\": {\n    \"iban\": \"LT121000011101001000\",\n    \"name\": \"Debtor Company Limited\"\n  },\n  \"endToEndId\": \"TXN123456789012345\",\n  \"priority\": \"HIGH\",\n  \"remittance\": \"Payment for invoice #INV-2025-001234\",\n  \"serviceLevel\": \"URGP\",\n  \"settlement\": {\n    \"bic\": \"DEUTDEFFXXX\",\n    \"date\": \"2025-07-04\",\n    \"iban\": \"GB29NWBK60161331926819\",\n    \"method\": \"INDA\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pgw-sandbox.finventi.com/v2/transactions/swift")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 1050299,\n  \"charges\": {\n    \"agentBic\": \"CHRGBICXXXX\",\n    \"amount\": 2550,\n    \"bearer\": \"DEBT\",\n    \"currency\": \"EUR\"\n  },\n  \"clearingChannel\": \"RTGS\",\n  \"creditor\": {\n    \"agentBic\": \"INVELT2XXXX\",\n    \"name\": \"Creditor Company Incorporated\",\n    \"otherAccount\": {\n      \"id\": \"9876543210\",\n      \"issuer\": \"DEUTDEFF\",\n      \"scheme\": \"BBAN\"\n    }\n  },\n  \"currency\": \"EUR\",\n  \"debtor\": {\n    \"iban\": \"LT121000011101001000\",\n    \"name\": \"Debtor Company Limited\"\n  },\n  \"endToEndId\": \"TXN123456789012345\",\n  \"priority\": \"HIGH\",\n  \"remittance\": \"Payment for invoice #INV-2025-001234\",\n  \"serviceLevel\": \"URGP\",\n  \"settlement\": {\n    \"bic\": \"DEUTDEFFXXX\",\n    \"date\": \"2025-07-04\",\n    \"iban\": \"GB29NWBK60161331926819\",\n    \"method\": \"INDA\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "amount": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "creditor": {
    "agentBic": "<string>",
    "clearingSystemMemberId": {
      "clearingSystemIdentificationCode": "<string>",
      "memberIdentification": "<string>"
    },
    "company": {
      "bic": "<string>",
      "id": "<string>",
      "issuer": "<string>",
      "lei": "<string>",
      "scheme": {
        "code": "<string>",
        "proprietary": "<string>"
      }
    },
    "iban": "<string>",
    "name": "<string>",
    "otherAccount": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme": "<string>"
    },
    "person": {
      "birthInfo": {
        "city": "<string>",
        "country": "<string>",
        "date": "2023-12-25",
        "province": "<string>"
      },
      "id": "<string>",
      "issuer": "<string>",
      "scheme": {
        "code": "<string>",
        "proprietary": "<string>"
      }
    }
  },
  "currency": "<string>",
  "debtor": {
    "agentBic": "<string>",
    "company": {
      "bic": "<string>",
      "id": "<string>",
      "issuer": "<string>",
      "lei": "<string>",
      "scheme": {
        "code": "<string>",
        "proprietary": "<string>"
      }
    },
    "iban": "<string>",
    "name": "<string>",
    "otherAccount": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme": "<string>"
    },
    "person": {
      "birthInfo": {
        "city": "<string>",
        "country": "<string>",
        "date": "2023-12-25",
        "province": "<string>"
      },
      "id": "<string>",
      "issuer": "<string>",
      "scheme": {
        "code": "<string>",
        "proprietary": "<string>"
      }
    }
  },
  "endToEndId": "<string>",
  "method": "SEPA",
  "settlementDate": "2023-12-25",
  "status": "<string>",
  "transactionId": 123,
  "remittance": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

POST

transactions

swift

Create Swift payment

curl --request POST \
  --url https://api.pgw-sandbox.finventi.com/v2/transactions/swift \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 1050299,
  "charges": {
    "agentBic": "CHRGBICXXXX",
    "amount": 2550,
    "bearer": "DEBT",
    "currency": "EUR"
  },
  "clearingChannel": "RTGS",
  "creditor": {
    "agentBic": "INVELT2XXXX",
    "name": "Creditor Company Incorporated",
    "otherAccount": {
      "id": "9876543210",
      "issuer": "DEUTDEFF",
      "scheme": "BBAN"
    }
  },
  "currency": "EUR",
  "debtor": {
    "iban": "LT121000011101001000",
    "name": "Debtor Company Limited"
  },
  "endToEndId": "TXN123456789012345",
  "priority": "HIGH",
  "remittance": "Payment for invoice #INV-2025-001234",
  "serviceLevel": "URGP",
  "settlement": {
    "bic": "DEUTDEFFXXX",
    "date": "2025-07-04",
    "iban": "GB29NWBK60161331926819",
    "method": "INDA"
  }
}
'

import requests

url = "https://api.pgw-sandbox.finventi.com/v2/transactions/swift"

payload = {
    "amount": 1050299,
    "charges": {
        "agentBic": "CHRGBICXXXX",
        "amount": 2550,
        "bearer": "DEBT",
        "currency": "EUR"
    },
    "clearingChannel": "RTGS",
    "creditor": {
        "agentBic": "INVELT2XXXX",
        "name": "Creditor Company Incorporated",
        "otherAccount": {
            "id": "9876543210",
            "issuer": "DEUTDEFF",
            "scheme": "BBAN"
        }
    },
    "currency": "EUR",
    "debtor": {
        "iban": "LT121000011101001000",
        "name": "Debtor Company Limited"
    },
    "endToEndId": "TXN123456789012345",
    "priority": "HIGH",
    "remittance": "Payment for invoice #INV-2025-001234",
    "serviceLevel": "URGP",
    "settlement": {
        "bic": "DEUTDEFFXXX",
        "date": "2025-07-04",
        "iban": "GB29NWBK60161331926819",
        "method": "INDA"
    }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 1050299,
    charges: {agentBic: 'CHRGBICXXXX', amount: 2550, bearer: 'DEBT', currency: 'EUR'},
    clearingChannel: 'RTGS',
    creditor: {
      agentBic: 'INVELT2XXXX',
      name: 'Creditor Company Incorporated',
      otherAccount: {id: '9876543210', issuer: 'DEUTDEFF', scheme: 'BBAN'}
    },
    currency: 'EUR',
    debtor: {iban: 'LT121000011101001000', name: 'Debtor Company Limited'},
    endToEndId: 'TXN123456789012345',
    priority: 'HIGH',
    remittance: 'Payment for invoice #INV-2025-001234',
    serviceLevel: 'URGP',
    settlement: {
      bic: 'DEUTDEFFXXX',
      date: '2025-07-04',
      iban: 'GB29NWBK60161331926819',
      method: 'INDA'
    }
  })
};

fetch('https://api.pgw-sandbox.finventi.com/v2/transactions/swift', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pgw-sandbox.finventi.com/v2/transactions/swift",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 1050299,
    'charges' => [
        'agentBic' => 'CHRGBICXXXX',
        'amount' => 2550,
        'bearer' => 'DEBT',
        'currency' => 'EUR'
    ],
    'clearingChannel' => 'RTGS',
    'creditor' => [
        'agentBic' => 'INVELT2XXXX',
        'name' => 'Creditor Company Incorporated',
        'otherAccount' => [
                'id' => '9876543210',
                'issuer' => 'DEUTDEFF',
                'scheme' => 'BBAN'
        ]
    ],
    'currency' => 'EUR',
    'debtor' => [
        'iban' => 'LT121000011101001000',
        'name' => 'Debtor Company Limited'
    ],
    'endToEndId' => 'TXN123456789012345',
    'priority' => 'HIGH',
    'remittance' => 'Payment for invoice #INV-2025-001234',
    'serviceLevel' => 'URGP',
    'settlement' => [
        'bic' => 'DEUTDEFFXXX',
        'date' => '2025-07-04',
        'iban' => 'GB29NWBK60161331926819',
        'method' => 'INDA'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pgw-sandbox.finventi.com/v2/transactions/swift"

	payload := strings.NewReader("{\n  \"amount\": 1050299,\n  \"charges\": {\n    \"agentBic\": \"CHRGBICXXXX\",\n    \"amount\": 2550,\n    \"bearer\": \"DEBT\",\n    \"currency\": \"EUR\"\n  },\n  \"clearingChannel\": \"RTGS\",\n  \"creditor\": {\n    \"agentBic\": \"INVELT2XXXX\",\n    \"name\": \"Creditor Company Incorporated\",\n    \"otherAccount\": {\n      \"id\": \"9876543210\",\n      \"issuer\": \"DEUTDEFF\",\n      \"scheme\": \"BBAN\"\n    }\n  },\n  \"currency\": \"EUR\",\n  \"debtor\": {\n    \"iban\": \"LT121000011101001000\",\n    \"name\": \"Debtor Company Limited\"\n  },\n  \"endToEndId\": \"TXN123456789012345\",\n  \"priority\": \"HIGH\",\n  \"remittance\": \"Payment for invoice #INV-2025-001234\",\n  \"serviceLevel\": \"URGP\",\n  \"settlement\": {\n    \"bic\": \"DEUTDEFFXXX\",\n    \"date\": \"2025-07-04\",\n    \"iban\": \"GB29NWBK60161331926819\",\n    \"method\": \"INDA\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pgw-sandbox.finventi.com/v2/transactions/swift")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1050299,\n  \"charges\": {\n    \"agentBic\": \"CHRGBICXXXX\",\n    \"amount\": 2550,\n    \"bearer\": \"DEBT\",\n    \"currency\": \"EUR\"\n  },\n  \"clearingChannel\": \"RTGS\",\n  \"creditor\": {\n    \"agentBic\": \"INVELT2XXXX\",\n    \"name\": \"Creditor Company Incorporated\",\n    \"otherAccount\": {\n      \"id\": \"9876543210\",\n      \"issuer\": \"DEUTDEFF\",\n      \"scheme\": \"BBAN\"\n    }\n  },\n  \"currency\": \"EUR\",\n  \"debtor\": {\n    \"iban\": \"LT121000011101001000\",\n    \"name\": \"Debtor Company Limited\"\n  },\n  \"endToEndId\": \"TXN123456789012345\",\n  \"priority\": \"HIGH\",\n  \"remittance\": \"Payment for invoice #INV-2025-001234\",\n  \"serviceLevel\": \"URGP\",\n  \"settlement\": {\n    \"bic\": \"DEUTDEFFXXX\",\n    \"date\": \"2025-07-04\",\n    \"iban\": \"GB29NWBK60161331926819\",\n    \"method\": \"INDA\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pgw-sandbox.finventi.com/v2/transactions/swift")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 1050299,\n  \"charges\": {\n    \"agentBic\": \"CHRGBICXXXX\",\n    \"amount\": 2550,\n    \"bearer\": \"DEBT\",\n    \"currency\": \"EUR\"\n  },\n  \"clearingChannel\": \"RTGS\",\n  \"creditor\": {\n    \"agentBic\": \"INVELT2XXXX\",\n    \"name\": \"Creditor Company Incorporated\",\n    \"otherAccount\": {\n      \"id\": \"9876543210\",\n      \"issuer\": \"DEUTDEFF\",\n      \"scheme\": \"BBAN\"\n    }\n  },\n  \"currency\": \"EUR\",\n  \"debtor\": {\n    \"iban\": \"LT121000011101001000\",\n    \"name\": \"Debtor Company Limited\"\n  },\n  \"endToEndId\": \"TXN123456789012345\",\n  \"priority\": \"HIGH\",\n  \"remittance\": \"Payment for invoice #INV-2025-001234\",\n  \"serviceLevel\": \"URGP\",\n  \"settlement\": {\n    \"bic\": \"DEUTDEFFXXX\",\n    \"date\": \"2025-07-04\",\n    \"iban\": \"GB29NWBK60161331926819\",\n    \"method\": \"INDA\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "amount": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "creditor": {
    "agentBic": "<string>",
    "clearingSystemMemberId": {
      "clearingSystemIdentificationCode": "<string>",
      "memberIdentification": "<string>"
    },
    "company": {
      "bic": "<string>",
      "id": "<string>",
      "issuer": "<string>",
      "lei": "<string>",
      "scheme": {
        "code": "<string>",
        "proprietary": "<string>"
      }
    },
    "iban": "<string>",
    "name": "<string>",
    "otherAccount": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme": "<string>"
    },
    "person": {
      "birthInfo": {
        "city": "<string>",
        "country": "<string>",
        "date": "2023-12-25",
        "province": "<string>"
      },
      "id": "<string>",
      "issuer": "<string>",
      "scheme": {
        "code": "<string>",
        "proprietary": "<string>"
      }
    }
  },
  "currency": "<string>",
  "debtor": {
    "agentBic": "<string>",
    "company": {
      "bic": "<string>",
      "id": "<string>",
      "issuer": "<string>",
      "lei": "<string>",
      "scheme": {
        "code": "<string>",
        "proprietary": "<string>"
      }
    },
    "iban": "<string>",
    "name": "<string>",
    "otherAccount": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme": "<string>"
    },
    "person": {
      "birthInfo": {
        "city": "<string>",
        "country": "<string>",
        "date": "2023-12-25",
        "province": "<string>"
      },
      "id": "<string>",
      "issuer": "<string>",
      "scheme": {
        "code": "<string>",
        "proprietary": "<string>"
      }
    }
  },
  "endToEndId": "<string>",
  "method": "SEPA",
  "settlementDate": "2023-12-25",
  "status": "<string>",
  "transactionId": 123,
  "remittance": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

Overview

This endpoint creates SWIFT payments for international wire transfers. The payment is validated and submitted to the correspondent banking network.

Idempotent Endpoint

This endpoint supports idempotency to prevent duplicate transactions.

How to Use

Include an Idempotency-Key header with a unique value (UUID recommended)
The API returns the existing transaction when you reuse the same key
Retry requests safely without creating duplicates

Key Features

Supports multiple currencies
Handles correspondent bank routing
Validates BIC codes and account formats
Provides transaction tracking

Amounts and currency precision

Send amount and charges.amount as integers in the selected currency’s minor units. Do not include a decimal point. The number of minor units in one major unit follows ISO 4217:

Currency examples	Fraction digits	Integer value sent to the API	Monetary value
JPY, KRW	0	`1234`	1234
EUR, USD	2	`1234`	12.34
BHD, IQD, JOD, KWD, LYD, OMR, TND	3	`1234`	1.234

For charges, use the fraction digits of charges.currency, which may differ from the payment currency. The API supports ISO 4217 currencies with 0 to 3 fraction digits. The supported 3-decimal currencies are BHD, IQD, JOD, KWD, LYD, OMR, and TND. It rejects currencies with more than 3 fraction digits, including CLF, and codes without a defined minor unit, including XAU and XAG. An unsupported payment or charge currency returns a 400 validation error stating that the currency must have 0-3 fraction digits.

Maximum amount length

CBPR+ accepts at most 14 digits in an amount, counting both the integer and fractional parts. Keep the integer sent in amount to 14 digits or fewer. The API currently accepts longer integers, but SWIFT rejects the resulting payment with a VAL error. For example, these 15-digit amounts exceed the SWIFT limit:

123456789012345 with KWD represents 123456789012.345 KWD.
123456789012345 with EUR represents 1234567890123.45 EUR.

Reading minor-unit amounts

Payment response amounts remain integers in minor units:

GET /v2/transactions/search returns currency_fraction_digits for each transaction.
GET /v3/payments/{id} returns instructedCurrencyFractionDigits for instructedAmount and instructedCurrency.
GET /v3/payments does not return a fraction-digits field.

Headers

Idempotency-Key

string

required

Unique identifier in scope of payment creation endpoints required to prevent unintended duplicate payments

Body

application/json

SWIFT payment request for creating cross-border payments

amount

integer

required

Transaction amount in minor currency units

Example:

10102

creditor

object

required

Creditor (beneficiary) information

Show child attributes

currency

string

required

Currency code (ISO 4217, 3-letter uppercase). Must have 0 to 3 fraction digits. Unsupported: codes with no defined minor unit (XAU, XAG, XPT, XPD, XDR, XSU, XUA, XTS, XXX, XBA, XBB, XBC, XBD, XFO, XFU) and codes with more than 3 fraction digits.

Minimum string length: 1

Pattern: ^[A-Z]{3}$

Example:

"EUR"

debtor

object

required

Debtor (payer) information

Show child attributes

priority

enum<string>

required

Instruction priority: NORM (normal), HIGH (high)

Available options:

NORM,

HIGH

settlement

object

required

Settlement information

Show child attributes

categoryPurposeCode

enum<string> | null

Category purpose code. Indicates the high-level purpose of the payment at a business level for accounting inside the payer/beneficiary company and for interbank and regulatory interpretation. Mutually exclusive with categoryPurposeProprietary.

Available options:

BONU,

CASH,

CBLK,

CCRD,

CORT,

DCRD,

DIVI,

DVPM,

EPAY,

FCIN,

FCOL,

GOVT,

HEDG,

ICCP,

IDCP,

INTC,

INTE,

LOAN,

MP2B,

MP2P,

OTHR,

PENS,

RPRE,

RRCT,

RVPM,

SALA,

SECU,

SSBE,

SUPP,

TAXS,

TRAD,

TREA,

VATX,

WHLD

categoryPurposeProprietary

string | null

Category purpose proprietary value. Free text alternative to categoryPurposeCode for non-standard category purposes. Mutually exclusive with categoryPurposeCode. Must contain at least one non-whitespace character. Maximum length is 35 characters.

Maximum string length: 35

Pattern: (\s*[^\s]\s*)+

charges

object | null

Charge information (optional)

Show child attributes

clearingChannel

enum<string> | null

Clearing channel: BOOK (book transfer), MPNS (mass payment net system), RTGS (real-time gross settlement), RTNS (real-time net settlement) (optional)

Available options:

BOOK,

MPNS,

RTGS,

RTNS

endToEndId

string | null

End-to-end identification assigned by the initiating party; transliterated to the CBPR+ restricted character set (optional, defaults to NOTPROVIDED if not provided)

Required string length: 1 - 35

metadata

string[]

For linking the payment to your internal records, for example a billing run, order, or customer ID. Set at creation only and cannot be changed afterwards. Stored only in the payment gateway: never included in any outgoing SEPA or SWIFT (MX/MT) message and never visible to the counterparty. Returned in transaction details and filterable in Transactions list v2 using exact match on the full value. Do not store sensitive personal data, card numbers, or secrets here. Examples: ["billing-run-2026-07"] or ["salary", "executive", "vacation"].

Maximum array length: 10

Maximum string length: 140

Example:

["billing-run-2026-07"]

purposeCode

enum<string> | null

Category purpose code. Allowed values: 'ADVA' - Advance payment, 'TAXS' - Tax payment,
'CSDB' - Cash Disbursement/Cash Management,
'GDSV' - Purchase Sale Of Goods And Services, 'GSCB' - Purchase Sale Of Goods And Services With Cash Back,
'COMP' - Compensation Payment, 'FEES' - Payment Of Fees, 'ICCP' - Irrevocable Credit Card Payment,
'IDCP' - Irrevocable Debit Card Payment, 'REFU' - Refund, 'RRCT' - Reimbursement Received Credit Transfer,
'RRTP' - Related Request To Pay, 'GVEA' - Austrian Government Employees Category A,
'GVEB' - Austrian Government Employees Category B, 'GVEC' - Austrian Government Employees Category C,
'GVED' - Austrian Government Employees Category D

Available options:

ADVA,

TAXS,

CSDB,

GDSV,

GSCB,

COMP,

FEES,

ICCP,

IDCP,

REFU,

RRCT,

RRTP,

GVEA,

GVEB,

GVEC,

GVED

remittance

string | null

Unstructured remittance information (payment details)

Maximum string length: 140

serviceLevel

enum<string> | null

Service level code: BKTR (book transfer), NUGP (non-urgent priority), NURG (non-urgent), SDVA (same day value), URGP (urgent payment), URNS (urgent net settlement) (optional)

Available options:

BKTR,

NUGP,

NURG,

SDVA,

URGP,

URNS

Response

A new SWIFT payment has been created

SWIFT payment creation response

amount

integer

required

Transaction amount in minor currency units

createdAt

string<date-time>

required

Transaction creation timestamp

creditor

object

required

Creditor information

Show child attributes

currency

string

required

Currency code

debtor

object

required

Debtor information

Show child attributes

endToEndId

string

required

End-to-end identification

method

enum<string>

required

Transaction method (always SWIFT)

Available options:

SEPA,

INST,

SDD,

SWIFT,

T2,

VIBER

settlementDate

string<date>

required

Settlement date

status

string

required

Transaction status

transactionId

integer<int64>

required

Unique transaction identifier

remittance

string | null

Remittance information

Last modified on September 23, 2026

Getting Started

Integration Guide

Account Management

SEPA Instant/SCT

SEPA Direct Debit

SWIFT Payments

Payment Information

Investigations (Preview)

Liquidity management

Bank Information

Webhooks

Overview

Idempotent Endpoint

How to Use

Key Features

Amounts and currency precision

Maximum amount length

Reading minor-unit amounts

Headers

Body

Response

​Overview

​Idempotent Endpoint

​How to Use

​Key Features

​Amounts and currency precision

​Maximum amount length

​Reading minor-unit amounts

Headers

Body

Response

Overview

Idempotent Endpoint

How to Use

Key Features

Amounts and currency precision

Maximum amount length

Reading minor-unit amounts