Create SEPA payment

curl --request POST \
  --url https://api.pgw-sandbox.finventi.com/v3/payments/sepa \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 12550,
  "creditor": {
    "account": {
      "iban": "LT029990200000000001"
    },
    "name": "Recipient Ltd"
  },
  "currencyCode": "EUR",
  "debtor": {
    "account": {
      "iban": "LT409990100000000001"
    },
    "address": {
      "country": "LT",
      "structured": {
        "buildingName": "Quadrum North",
        "buildingNumber": "5",
        "countrySubDivision": "Vilniaus apskritis",
        "postCode": "08303",
        "street": "Upes g."
      },
      "town": "Vilnius"
    },
    "name": "Payer Ltd"
  },
  "instant": false
}
'

{
  "createdAt": "2025-11-21T12:46:54.321667Z",
  "creditor": {
    "account": {
      "iban": "<string>",
      "other": {
        "id": "<string>",
        "issuer": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        }
      }
    },
    "agent": {
      "bic": "DEMOLT1XXXX",
      "name": "<string>"
    },
    "address": {
      "country": "LT",
      "line": "<string>",
      "structured": {
        "buildingName": "<string>",
        "buildingNumber": "<string>",
        "countrySubDivision": "<string>",
        "department": "<string>",
        "districtName": "<string>",
        "floor": "<string>",
        "postBox": "<string>",
        "postCode": "<string>",
        "room": "<string>",
        "street": "<string>",
        "subDepartment": "<string>",
        "townLocationName": "<string>"
      },
      "town": "Vilnius"
    },
    "name": "<string>",
    "organisationIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "bic": "<string>",
      "lei": "<string>"
    },
    "privateIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "<string>",
        "province": "<string>"
      }
    }
  },
  "debtor": {
    "account": {
      "iban": "<string>",
      "other": {
        "id": "<string>",
        "issuer": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        }
      }
    },
    "agent": {
      "bic": "DEMOLT1XXXX",
      "name": "<string>"
    },
    "address": {
      "country": "LT",
      "line": "<string>",
      "structured": {
        "buildingName": "<string>",
        "buildingNumber": "<string>",
        "countrySubDivision": "<string>",
        "department": "<string>",
        "districtName": "<string>",
        "floor": "<string>",
        "postBox": "<string>",
        "postCode": "<string>",
        "room": "<string>",
        "street": "<string>",
        "subDepartment": "<string>",
        "townLocationName": "<string>"
      },
      "town": "Vilnius"
    },
    "name": "<string>",
    "organisationIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "bic": "<string>",
      "lei": "<string>"
    },
    "privateIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "<string>",
        "province": "<string>"
      }
    }
  },
  "direction": "OUTBOUND",
  "endToEndId": "<string>",
  "id": 10300007,
  "instructedAmount": 100,
  "instructedCurrency": "EUR",
  "metadata": [
    "<string>"
  ],
  "scheme": "SEPA_CT",
  "sddActionOptions": [
    {
      "reasons": [
        {
          "available": true,
          "code": "MD06",
          "deadline": "2026-10-15T11:15:00+03:00"
        }
      ],
      "type": "RETURN",
      "deadline": "2026-08-27T11:15:00+03:00",
      "settlementDate": "2023-12-25",
      "windowEndDate": "2026-12-25"
    }
  ],
  "settlementAmount": 100,
  "settlementCurrency": "EUR",
  "status": "COMPLETED",
  "type": "PAYMENT",
  "categoryPurposeCode": "BONU",
  "categoryPurposeProprietary": "<string>",
  "chargesAndAdjustments": {
    "compensation": 25,
    "returnCharges": 50,
    "unaccountedTax": 123
  },
  "creditTransferType": "CUSTOMER",
  "directDebit": {
    "amendmentIndicator": true,
    "amendmentInformationDetails": {
      "originalCreditorSchemeId": "<string>",
      "originalDebtorAccount": "<string>",
      "originalMandateId": "<string>"
    },
    "esignature": "<string>",
    "mandateId": "MANDATE-2026-001",
    "sequenceType": "RCUR",
    "signatureDate": "2026-01-15"
  },
  "instructionId": "<string>",
  "messageId": "<string>",
  "originBic": "<string>",
  "originName": "<string>",
  "originReasonCode": "AC04",
  "originReasonInfo": "<string>",
  "parentPaymentId": 123,
  "parentTransactionAmount": 123,
  "purpose": "Invoice #12345",
  "purposeCode": "<string>",
  "settlementDate": "2023-12-25",
  "statusReason": {
    "code": "ACSC",
    "message": "Accepted settlement completed"
  },
  "structuredReference": {
    "issuer": "ISO",
    "reference": "RF123456"
  },
  "swift": {
    "businessMessageId": "BIZ-MSG-001",
    "charges": {
      "items": [
        {
          "amount": 50,
          "currency": "EUR",
          "bic": "<string>"
        }
      ],
      "bearer": "SHAR"
    },
    "messageDefinition": "pacs.008.001.08",
    "receiverBic": "<string>",
    "senderBic": "<string>",
    "settlementAccount": {
      "currency": "EUR",
      "iban": "<string>",
      "other": {
        "id": "<string>",
        "issuer": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        }
      }
    },
    "settlementMethod": "INDA",
    "uetr": "<string>"
  },
  "t2": {
    "priority": "HIGH",
    "uetr": "a1b2c3d4-1111-4222-8333-000000000001"
  },
  "ultimateCreditor": {
    "name": "<string>",
    "organisationIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "bic": "<string>",
      "lei": "<string>"
    },
    "privateIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "<string>",
        "province": "<string>"
      }
    }
  },
  "ultimateDebtor": {
    "name": "<string>",
    "organisationIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "bic": "<string>",
      "lei": "<string>"
    },
    "privateIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "<string>",
        "province": "<string>"
      }
    }
  },
  "updatedAt": "2025-11-21T12:46:54.612954Z"
}

{
  "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

payments

sepa

curl --request POST \
  --url https://api.pgw-sandbox.finventi.com/v3/payments/sepa \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 12550,
  "creditor": {
    "account": {
      "iban": "LT029990200000000001"
    },
    "name": "Recipient Ltd"
  },
  "currencyCode": "EUR",
  "debtor": {
    "account": {
      "iban": "LT409990100000000001"
    },
    "address": {
      "country": "LT",
      "structured": {
        "buildingName": "Quadrum North",
        "buildingNumber": "5",
        "countrySubDivision": "Vilniaus apskritis",
        "postCode": "08303",
        "street": "Upes g."
      },
      "town": "Vilnius"
    },
    "name": "Payer Ltd"
  },
  "instant": false
}
'

{
  "createdAt": "2025-11-21T12:46:54.321667Z",
  "creditor": {
    "account": {
      "iban": "<string>",
      "other": {
        "id": "<string>",
        "issuer": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        }
      }
    },
    "agent": {
      "bic": "DEMOLT1XXXX",
      "name": "<string>"
    },
    "address": {
      "country": "LT",
      "line": "<string>",
      "structured": {
        "buildingName": "<string>",
        "buildingNumber": "<string>",
        "countrySubDivision": "<string>",
        "department": "<string>",
        "districtName": "<string>",
        "floor": "<string>",
        "postBox": "<string>",
        "postCode": "<string>",
        "room": "<string>",
        "street": "<string>",
        "subDepartment": "<string>",
        "townLocationName": "<string>"
      },
      "town": "Vilnius"
    },
    "name": "<string>",
    "organisationIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "bic": "<string>",
      "lei": "<string>"
    },
    "privateIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "<string>",
        "province": "<string>"
      }
    }
  },
  "debtor": {
    "account": {
      "iban": "<string>",
      "other": {
        "id": "<string>",
        "issuer": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        }
      }
    },
    "agent": {
      "bic": "DEMOLT1XXXX",
      "name": "<string>"
    },
    "address": {
      "country": "LT",
      "line": "<string>",
      "structured": {
        "buildingName": "<string>",
        "buildingNumber": "<string>",
        "countrySubDivision": "<string>",
        "department": "<string>",
        "districtName": "<string>",
        "floor": "<string>",
        "postBox": "<string>",
        "postCode": "<string>",
        "room": "<string>",
        "street": "<string>",
        "subDepartment": "<string>",
        "townLocationName": "<string>"
      },
      "town": "Vilnius"
    },
    "name": "<string>",
    "organisationIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "bic": "<string>",
      "lei": "<string>"
    },
    "privateIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "<string>",
        "province": "<string>"
      }
    }
  },
  "direction": "OUTBOUND",
  "endToEndId": "<string>",
  "id": 10300007,
  "instructedAmount": 100,
  "instructedCurrency": "EUR",
  "metadata": [
    "<string>"
  ],
  "scheme": "SEPA_CT",
  "sddActionOptions": [
    {
      "reasons": [
        {
          "available": true,
          "code": "MD06",
          "deadline": "2026-10-15T11:15:00+03:00"
        }
      ],
      "type": "RETURN",
      "deadline": "2026-08-27T11:15:00+03:00",
      "settlementDate": "2023-12-25",
      "windowEndDate": "2026-12-25"
    }
  ],
  "settlementAmount": 100,
  "settlementCurrency": "EUR",
  "status": "COMPLETED",
  "type": "PAYMENT",
  "categoryPurposeCode": "BONU",
  "categoryPurposeProprietary": "<string>",
  "chargesAndAdjustments": {
    "compensation": 25,
    "returnCharges": 50,
    "unaccountedTax": 123
  },
  "creditTransferType": "CUSTOMER",
  "directDebit": {
    "amendmentIndicator": true,
    "amendmentInformationDetails": {
      "originalCreditorSchemeId": "<string>",
      "originalDebtorAccount": "<string>",
      "originalMandateId": "<string>"
    },
    "esignature": "<string>",
    "mandateId": "MANDATE-2026-001",
    "sequenceType": "RCUR",
    "signatureDate": "2026-01-15"
  },
  "instructionId": "<string>",
  "messageId": "<string>",
  "originBic": "<string>",
  "originName": "<string>",
  "originReasonCode": "AC04",
  "originReasonInfo": "<string>",
  "parentPaymentId": 123,
  "parentTransactionAmount": 123,
  "purpose": "Invoice #12345",
  "purposeCode": "<string>",
  "settlementDate": "2023-12-25",
  "statusReason": {
    "code": "ACSC",
    "message": "Accepted settlement completed"
  },
  "structuredReference": {
    "issuer": "ISO",
    "reference": "RF123456"
  },
  "swift": {
    "businessMessageId": "BIZ-MSG-001",
    "charges": {
      "items": [
        {
          "amount": 50,
          "currency": "EUR",
          "bic": "<string>"
        }
      ],
      "bearer": "SHAR"
    },
    "messageDefinition": "pacs.008.001.08",
    "receiverBic": "<string>",
    "senderBic": "<string>",
    "settlementAccount": {
      "currency": "EUR",
      "iban": "<string>",
      "other": {
        "id": "<string>",
        "issuer": "<string>",
        "scheme": {
          "code": "<string>",
          "proprietary": "<string>"
        }
      }
    },
    "settlementMethod": "INDA",
    "uetr": "<string>"
  },
  "t2": {
    "priority": "HIGH",
    "uetr": "a1b2c3d4-1111-4222-8333-000000000001"
  },
  "ultimateCreditor": {
    "name": "<string>",
    "organisationIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "bic": "<string>",
      "lei": "<string>"
    },
    "privateIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "<string>",
        "province": "<string>"
      }
    }
  },
  "ultimateDebtor": {
    "name": "<string>",
    "organisationIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "bic": "<string>",
      "lei": "<string>"
    },
    "privateIdentification": {
      "otherIdentifications": [
        {
          "id": "<string>",
          "issuer": "<string>",
          "scheme": {
            "code": "<string>",
            "proprietary": "<string>"
          }
        }
      ],
      "birthInformation": {
        "city": "<string>",
        "country": "<string>",
        "date": "<string>",
        "province": "<string>"
      }
    }
  },
  "updatedAt": "2025-11-21T12:46:54.612954Z"
}

{
  "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>"
}

Set instant to true for a SEPA Instant payment. Omit it or set it to false for a SEPA Credit Transfer.

Idempotency

Send a UUID v4 in the Idempotency-Key header. If you need to retry the request, reuse the same key. The API returns the original payment instead of creating a duplicate.

Remittance information

Send either purpose for unstructured remittance information or structuredReference for a structured creditor reference. Do not send both fields in the same request. The API returns 400 Bad Request when both are present.

Financial category purposes

When you set categoryPurposeCode to FCIN, FCOL, or INTE:

Set structuredReference.reference.
Set debtor.organisationIdentification.bic and creditor.organisationIdentification.bic.
Omit purpose, ultimateDebtor, and ultimateCreditor.

The API returns 400 Bad Request when these requirements are not met.

Address formats

You can omit an address. When you provide one, include country and town, then choose one of these formats:

Fully structured: Set structured and omit line.
Hybrid: Set one line and omit structured.

EPC SR2026 requires structured or hybrid addresses from November 15, 2026. It no longer permits fully unstructured addresses, so PGW rejects an address without country or town and rejects requests containing both line and structured.

Fully structured address

{
  "instant": false,
  "amount": 12550,
  "currencyCode": "EUR",
  "debtor": {
    "name": "Payer Ltd",
    "account": { "iban": "LT961010012345678901" },
    "address": {
      "country": "LT",
      "town": "Vilnius",
      "structured": {
        "street": "Upes g.",
        "buildingNumber": "5",
        "buildingName": "Quadrum North",
        "postCode": "08303",
        "countrySubDivision": "Vilniaus apskritis"
      }
    }
  },
  "creditor": {
    "name": "Recipient Ltd",
    "account": { "iban": "LT123450010000000004" }
  }
}

Hybrid address

{
  "instant": true,
  "amount": 10657,
  "currencyCode": "EUR",
  "debtor": {
    "name": "Sender Name",
    "account": { "iban": "LT543210010000000003" }
  },
  "creditor": {
    "name": "Janis Berzins",
    "account": { "iban": "LV06PERF0000000000001" },
    "address": {
      "country": "LV",
      "town": "Riga",
      "line": "Brivibas iela 1-2, LV-1010"
    }
  }
}

The API accepts one hybrid line of up to 140 characters and preserves it as one line in the payment resource. In the outgoing clearing message, PGW splits it into at most two lines of 70 characters each.

Migrate from v0

Replace POST /gateway/createSepaPmt with POST /v3/payments/sepa and map the request as follows:

Legacy `createSepaPmt` field	v3 field
`inst: true`	`instant: true`
`dr_amount` / `cr_amount` pair	`amount`
`dr_ccy_isocode` / `cr_ccy_isocode`	Single `currencyCode`
`dr_acc`	`debtor.account.iban`
`dr_name`	`debtor.name`
`dr_bank_bic`	`debtor.agent.bic`
`dr_address`	`debtor.address.line` (hybrid, maximum 140 characters) or `debtor.address.structured.*`
`dr_address_city` / `dr_address_country`	`debtor.address.town` / `debtor.address.country`
`dr_code_person` + `dr_code_issuer`	`debtor.privateIdentification.otherIdentifications[0]`
`dr_code_company` + `dr_code_issuer`	`debtor.organisationIdentification.otherIdentifications[0]`
`dr_alt_code_company` + `dr_alt_code_company_issuer`	`debtor.organisationIdentification.otherIdentifications[1]` (stored and returned by PGW, but not forwarded to clearing, matching legacy behavior)
`dr_bic_company`	`debtor.organisationIdentification.bic`
`cr_*` (same set)	`creditor.`, with the same mapping as `dr_` to `debtor.*`
`trx_purpose`	`purpose`
`trx_purpose_information`	`purposeCode`
`trx_purpose_structured_ref` / `trx_purpose_structured_issuer`	`structuredReference.reference` / `structuredReference.issuer`
`ctgy_purp_cd`	`categoryPurposeCode`
`ctgy_purp_prtry`	`categoryPurposeProprietary`
`end_to_end_id`	`endToEndId`
`trx_settlement_date`	`settlementDate`
`metadata`	`metadata`
`udr_name` / `ucr_name`	`ultimateDebtor.name` / `ultimateCreditor.name`
`udr_id_type` (`1` = company, `2` = person)	Select `organisationIdentification` or `privateIdentification`
`udr_identification` + `udr_issuer` + `udr_scheme_code` / `udr_scheme_proprietary`	`ultimateDebtor` identification `otherIdentifications[0]` (`id`, `issuer`, and `scheme`)
`udr_organisation_bic`	`ultimateDebtor.organisationIdentification.bic`
`udr_address` / `udr_address_city` / `udr_address_country`	Not carried over because the legacy endpoint accepts but does not use these fields; they are dropped before clearing and remain absent from responses
`udr_private_birth` / `_city` / `_country` / `_province`	`ultimateDebtor.privateIdentification.birthInformation` (`date`, `city`, `country`, and `province`)

Send a UUID v4 as the Idempotency-Key. The v3 endpoint returns 201 Created with the same complete payment representation as GET /v3/payments/{id}, instead of the legacy result.id and result.status response.

Headers

Idempotency-Key

string

required

UUID v4 used to return the same transaction for an idempotent retry

Body

application/json

SEPA Credit Transfer or SEPA Instant payment creation request

amount

integer | null

required

Payment amount in minor currency units

Example:

12550

creditor

object | null

required

Show child attributes

currencyCode

string | null

required

Payment currency. SEPA payments support EUR only

Pattern: EUR

Example:

"EUR"

debtor

object | null

required

Show child attributes

categoryPurposeCode

enum<string> | null

ISO 20022 category purpose code. FCIN, FCOL, and INTE require structuredReference.reference and organisation BICs for both debtor and creditor. For these codes, omit purpose, ultimateDebtor, and ultimateCreditor.

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

Proprietary category purpose

Required string length: 1 - 35

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

endToEndId

string | null

End-to-end identifier; defaults to NOTPROVIDED

Required string length: 1 - 35

instant

boolean

default:false

Creates a SEPA Instant payment when true; otherwise creates a SEPA Credit Transfer

metadata

string[]

Maximum array length: 10

Maximum string length: 140

purpose

string | null

Unstructured remittance information. Mutually exclusive with structuredReference

Required string length: 1 - 140

purposeCode

enum<string> | null

ISO 20022 purpose code

Available options:

ADVA,

TAXS,

CSDB,

GDSV,

GSCB,

COMP,

FEES,

ICCP,

IDCP,

REFU,

RRCT,

RRTP,

GVEA,

GVEB,

GVEC,

GVED

settlementDate

string<date> | null

Requested settlement date. For Instant it must be omitted or today

structuredReference

object | null

Structured remittance reference. Mutually exclusive with purpose

Show child attributes

ultimateCreditor

object | null

Show child attributes

ultimateDebtor

object | null

Show child attributes

Response

Payment created

createdAt

string<date-time>

required

Time and date when the payment was created (UTC)

Example:

"2025-11-21T12:46:54.321667Z"

creditor

object

required

Creditor (recipient) party information

Show child attributes

debtor

object

required

Debtor (sender) party information

Show child attributes

direction

enum<string>

required

Payment direction

Available options:

OUTBOUND,

INBOUND

Example:

"OUTBOUND"

endToEndId

string

required

End-to-end identifier assigned by the originator

integer<int64>

required

Unique payment identifier

Example:

10300007

instructedAmount

integer

required

Instructed payment amount in minor currency units (cents)

Example:

100

instructedCurrency

string

required

Instructed payment currency ISO code

Example:

"EUR"

metadata

string[]

required

Client-defined metadata values assigned when the payment was created

scheme

enum<string>

required

Payment scheme. SEPA_CT — SEPA Credit Transfer, SEPA_INST — SEPA Instant Credit Transfer, SEPA_DD — SEPA Direct Debit, SWIFT — SWIFT cross-border payment.

Available options:

SEPA_CT,

SEPA_INST,

SEPA_DD,

SWIFT,

T2

Example:

"SEPA_CT"

sddActionOptions

object[]

required

R-transactions a client may raise against this payment right now. Empty for anything but a received SEPA direct debit collection. Informational: the action endpoints do not enforce these windows.

Show child attributes

settlementAmount

integer

required

Settlement amount in minor currency units (cents)

Example:

100

settlementCurrency

string

required

Settlement currency ISO code

Example:

"EUR"

status

enum<string>

required

Current payment status

Available options:

CREATED,

TO_SIGN,

SIGNED,

SENT_TO_CLEAR,

COMPLETED,

CANCELLED,

REJECTED,

ACCEPTED,

SOME_PROBLEMS,

PENDING_CONFIRMATION

Example:

"COMPLETED"

type

enum<string>

required

Payment type

Available options:

PAYMENT,

PAYMENT_CANCELLATION,

PAYMENT_RETURN,

REVERSE_PAYMENT,

CSM_FEES,

ADJUSTMENT

Example:

"PAYMENT"

categoryPurposeCode

enum<string> | null

Category purpose code (e.g. SALA, TAXS, GOVT)

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

Proprietary category purpose

chargesAndAdjustments

object | null

Return-only charges and adjustments. Populated only for payment_return / payment_cancellation transactions; absent otherwise.

Show child attributes

creditTransferType

enum<string> | null

Credit transfer type for T2 payments

Available options:

CUSTOMER,

FINANCIAL_INSTITUTION

directDebit

object | null

SEPA direct debit fields, present only for SDD payments

Show child attributes

instructionId

string | null

Instruction identifier

messageId

string | null

Message identifier

originBic

string | null

Return / rejection originator BIC

originName

string | null

Return / rejection originator name

originReasonCode

string | null

Return / rejection reason code

Example:

"AC04"

originReasonInfo

string | null

Return / rejection reason information

parentPaymentId

integer<int64> | null

Parent payment identifier, present for returns / reversals / cancellations

parentTransactionAmount

integer | null

Original (parent) transaction amount in minor currency units (cents)

purpose

string | null

Unstructured remittance information (free text)

Example:

"Invoice #12345"

purposeCode

string | null

ISO 20022 purpose code or proprietary purpose value (e.g. SUPP, SALA, TAXS)

settlementDate

string<date> | null

Settlement date

statusReason

object | null

Reason for the current status

Show child attributes

structuredReference

object | null

Structured remittance reference

Show child attributes

swift

object | null

SWIFT-specific fields, present only for SWIFT payments

Show child attributes

object | null

T2-specific fields, present only for T2 payments

Show child attributes

ultimateCreditor

object | null

Ultimate creditor party information

Show child attributes

ultimateDebtor

object | null

Ultimate debtor party information

Show child attributes

updatedAt

string<date-time> | null

Time and date when the payment was last updated (UTC)

Example:

"2025-11-21T12:46:54.612954Z"

Last modified on August 26, 2026

Getting Started

Integration Guide

Account Management

SEPA Instant/SCT

SEPA Direct Debit

SWIFT Payments

Payment Information

Investigations (Preview)

Nostro Accounts

Bank Information

Webhooks

Idempotency

Remittance information

Financial category purposes

Address formats

Fully structured address

Hybrid address

Migrate from v0

Headers

Body

Response

​Idempotency

​Remittance information

​Financial category purposes

​Address formats

​Fully structured address

​Hybrid address

​Migrate from v0

Headers

Body

Response

Idempotency

Remittance information

Financial category purposes

Address formats

Fully structured address

Hybrid address

Migrate from v0