Post payments

Headers

Idempotent-Request-Key

string

Idempotent Request Key.

Timestamp

string<date-time>

Timestamp

Used-Mechanism

string

Type of the payment.

api-key

string

API Key to authorize the api.

Body

application/json

paymentInstructionReference

Payment instruction reference. · object

Show child attributes

paymentInstructionReference.identification

string

required

Unique identifier for the bank code of which the details are retreived.

Example:

"123456"

paymentInstructionReference.externalId

string

The external ID.

Example:

"123456"

paymentInstructionReference.reference

string

A tag/label issued by the initiator of the transaction in order to be able to refer to the respective transaction.

Example:

"reference"

paymentInstructionReference.description

string

Short description of the transaction.

Example:

"Bill payment."

paymentInstructionReference.usedMechanism

string

The payment mechanism the bank decides to use in the transaction to execute a payment instruction.

Example:

"US_DOMESTIC_WIRE_RET"

paymentInstructionReference.status

enum<string>

The status of the transaction.

Available options:

INITIATED,

CANCELLED,

CONFIRMED,

SUSPENDED,

PENDING,

COMPLETED,

RETURNED,

FAILED,

SCHEDULED

paymentInstructionReference.reason

string

Reason code that connecting system accepted/rejected the payment.

Example:

""

paymentInstructionReference.uetr

string

Universally unique identifier to provide an end-to-end reference of a payment transaction.

Example:

"UUIDv4"

paymentInstructionReference.etoeIdentification

string

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

Example:

""

Example:

{
  "reference": "reference",
  "reason": "",
  "identification": "123456",
  "uetr": "UUIDv4",
  "externalId": "123456",
  "description": "Bill payment.",
  "etoeIdentification": "",
  "usedMechanism": "US_DOMESTIC_WIRE_RET",
  "status": null
}

payerReference

Payer reference. · object

Show child attributes

payerReference.involvedParty

involved Party · object

Show child attributes

payerReference.involvedParty.partyInvolvementType

enum<string>

Role played by a party in the context of a payment.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT,

ULTIMATE_DEBTOR,

ULTIMATE_CREDITOR,

INITIATOR,

INTERMEDIARY_AGENT,

CORRESPONDEBT_AGNET

payerReference.involvedParty.partyType

enum<string>

Unique and unambiguous way to identify a party.

Available options:

PERSON,

ORGANISATION

payerReference.involvedParty.personIdentifications

Identification to support Know Your Customer (KYC) processes. · object[]

Identification to support Know Your Customer (KYC) processes.

Show child attributes

payerReference.involvedParty.personIdentifications.type

enum<string>

Type of the person identifications.

Available options:

ALIEN_REGISTRATION_NUMBER,

CUSTOMER_IDENTIFICATION_NUMBER,

EMPLOYEE_IDENTIFICATION_NUMBER,

NATIONAL_IDENTITY_NUMBER,

TAX_IDENTIFICATION_NUMBER,

SOCIAL_SECURITY_NUMBER,

DRIVERS_LICENSE_NUMBER,

PASSPORT_NUMBER,

IDENTITY_CARD_NUMBER,

EMPLOYER_IDENTIFICATION_NUMBER

payerReference.involvedParty.personIdentifications.id

string

Unique identifier of person identification.

Example:

"123456789"

payerReference.involvedParty.organisationIdentification

Organization identification. · object

Show child attributes

payerReference.involvedParty.organisationIdentification.type

enum<string>

type

Available options:

LEI,

ELF,

MICX,

BICFI,

DUNS,

BANK_PARTY_IDENTIFICATION,

CENTRAL_BANK_IDENTIFICATION_NUMBER,

CLEARING_IDENTIFICATION_NUMBER,

CERTIFICATE_OF_INCORPORATION_NUMBER,

COUNTRY_IDENTIFICATION_CODE,

CUSTOMER_NUMBER,

DATA_UNIVERSAL_NUMBERING_SYSTEM,

EMPLOYER_IDENTIFICATION_NUMBER,

GS1_GLN_IDENTIFIER,

SIREN,

SIRET,

TAX_IDENTIFICATION_NUMBER,

EAN_GLN,

BANK_BRANCH_CODE

payerReference.involvedParty.organisationIdentification.identificationNo

string

Identification number.

Example:

"12345"

Example:

{
  "identificationNo": "12345",
  "type": "LEI"
}

payerReference.involvedParty.partyName

string

Name of the payer account.

Example:

"David"

payerReference.involvedParty.address

Address. · object

Show child attributes

payerReference.involvedParty.address.type

enum<string>

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

payerReference.involvedParty.address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

payerReference.involvedParty.address.department

string

Identification of a division of a large organization or building.

Example:

"Department of Education"

payerReference.involvedParty.address.subDepartment

string

Identification of a sub-division of a large organization or building.

Example:

"Institute of Education Sciences"

payerReference.involvedParty.address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Example:

"John Smith 123 Main Street, Apt 4B Anytown, CA 12345"

payerReference.involvedParty.address.buildingNumber

string

Number that identifies the position of a building on a street.

Example:

"123"

payerReference.involvedParty.address.streetName

string

Name of a street or thoroughfare.

Example:

"Main Street"

payerReference.involvedParty.address.townName

string

Name of a built-up area, with defined boundaries, and a local government.

Example:

"Anytown"

payerReference.involvedParty.address.postalCode

string

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example:

"12345"

payerReference.involvedParty.address.countrySubDivision

string

Identifies name of a country subdivision such as state, region, county.

Example:

"CA"

payerReference.involvedParty.address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"US"

Example:

{
  "country": "US",
  "streetName": "Main Street",
  "townName": "Anytown",
  "countrySubDivision": "CA",
  "postalCode": "12345",
  "buildingNumber": "123",
  "subDepartment": "Institute of Education Sciences",
  "type": "POSTAL",
  "department": "Department of Education",
  "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
  "primary": true
}

payerReference.involvedParty.reference

string

Reference of the payer account.

Example:

"Ref-1"

Example:

{
  "reference": "Ref-1",
  "address": {
    "country": "US",
    "streetName": "Main Street",
    "townName": "Anytown",
    "countrySubDivision": "CA",
    "postalCode": "12345",
    "buildingNumber": "123",
    "subDepartment": "Institute of Education Sciences",
    "type": "POSTAL",
    "department": "Department of Education",
    "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
    "primary": true
  },
  "organisationIdentification": {
    "identificationNo": "12345",
    "type": "LEI"
  },
  "partyName": "David",
  "partyType": "PERSON",
  "partyInvolvementType": "DEBTOR",
  "personIdentifications": [
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    },
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    }
  ]
}

Example:

{
  "involvedParty": {
    "reference": "Ref-1",
    "address": {
      "country": "US",
      "streetName": "Main Street",
      "townName": "Anytown",
      "countrySubDivision": "CA",
      "postalCode": "12345",
      "buildingNumber": "123",
      "subDepartment": "Institute of Education Sciences",
      "type": "POSTAL",
      "department": "Department of Education",
      "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
      "primary": true
    },
    "organisationIdentification": {
      "identificationNo": "12345",
      "type": "LEI"
    },
    "partyName": "David",
    "partyType": "PERSON",
    "partyInvolvementType": "DEBTOR",
    "personIdentifications": [
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      },
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      }
    ]
  }
}

payerBankReference

Payer bank reference. · object

Show child attributes

payerBankReference.involvedParty

involved Party · object

Show child attributes

payerBankReference.involvedParty.partyInvolvementType

enum<string>

Role played by a party in the context of a payment.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT,

ULTIMATE_DEBTOR,

ULTIMATE_CREDITOR,

INITIATOR,

INTERMEDIARY_AGENT,

CORRESPONDEBT_AGNET

payerBankReference.involvedParty.partyType

enum<string>

Unique and unambiguous way to identify a party.

Available options:

PERSON,

ORGANISATION

payerBankReference.involvedParty.personIdentifications

Identification to support Know Your Customer (KYC) processes. · object[]

Identification to support Know Your Customer (KYC) processes.

Show child attributes

payerBankReference.involvedParty.personIdentifications.type

enum<string>

Type of the person identifications.

Available options:

ALIEN_REGISTRATION_NUMBER,

CUSTOMER_IDENTIFICATION_NUMBER,

EMPLOYEE_IDENTIFICATION_NUMBER,

NATIONAL_IDENTITY_NUMBER,

TAX_IDENTIFICATION_NUMBER,

SOCIAL_SECURITY_NUMBER,

DRIVERS_LICENSE_NUMBER,

PASSPORT_NUMBER,

IDENTITY_CARD_NUMBER,

EMPLOYER_IDENTIFICATION_NUMBER

payerBankReference.involvedParty.personIdentifications.id

string

Unique identifier of person identification.

Example:

"123456789"

payerBankReference.involvedParty.organisationIdentification

Organization identification. · object

Show child attributes

payerBankReference.involvedParty.organisationIdentification.type

enum<string>

type

Available options:

LEI,

ELF,

MICX,

BICFI,

DUNS,

BANK_PARTY_IDENTIFICATION,

CENTRAL_BANK_IDENTIFICATION_NUMBER,

CLEARING_IDENTIFICATION_NUMBER,

CERTIFICATE_OF_INCORPORATION_NUMBER,

COUNTRY_IDENTIFICATION_CODE,

CUSTOMER_NUMBER,

DATA_UNIVERSAL_NUMBERING_SYSTEM,

EMPLOYER_IDENTIFICATION_NUMBER,

GS1_GLN_IDENTIFIER,

SIREN,

SIRET,

TAX_IDENTIFICATION_NUMBER,

EAN_GLN,

BANK_BRANCH_CODE

payerBankReference.involvedParty.organisationIdentification.identificationNo

string

Identification number.

Example:

"12345"

Example:

{
  "identificationNo": "12345",
  "type": "LEI"
}

payerBankReference.involvedParty.partyName

string

Name of the payer account.

Example:

"David"

payerBankReference.involvedParty.address

Address. · object

Show child attributes

payerBankReference.involvedParty.address.type

enum<string>

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

payerBankReference.involvedParty.address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

payerBankReference.involvedParty.address.department

string

Identification of a division of a large organization or building.

Example:

"Department of Education"

payerBankReference.involvedParty.address.subDepartment

string

Identification of a sub-division of a large organization or building.

Example:

"Institute of Education Sciences"

payerBankReference.involvedParty.address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Example:

"John Smith 123 Main Street, Apt 4B Anytown, CA 12345"

payerBankReference.involvedParty.address.buildingNumber

string

Number that identifies the position of a building on a street.

Example:

"123"

payerBankReference.involvedParty.address.streetName

string

Name of a street or thoroughfare.

Example:

"Main Street"

payerBankReference.involvedParty.address.townName

string

Name of a built-up area, with defined boundaries, and a local government.

Example:

"Anytown"

payerBankReference.involvedParty.address.postalCode

string

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example:

"12345"

payerBankReference.involvedParty.address.countrySubDivision

string

Identifies name of a country subdivision such as state, region, county.

Example:

"CA"

payerBankReference.involvedParty.address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"US"

Example:

{
  "country": "US",
  "streetName": "Main Street",
  "townName": "Anytown",
  "countrySubDivision": "CA",
  "postalCode": "12345",
  "buildingNumber": "123",
  "subDepartment": "Institute of Education Sciences",
  "type": "POSTAL",
  "department": "Department of Education",
  "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
  "primary": true
}

payerBankReference.involvedParty.reference

string

Reference of the payer account.

Example:

"Ref-1"

Example:

{
  "reference": "Ref-1",
  "address": {
    "country": "US",
    "streetName": "Main Street",
    "townName": "Anytown",
    "countrySubDivision": "CA",
    "postalCode": "12345",
    "buildingNumber": "123",
    "subDepartment": "Institute of Education Sciences",
    "type": "POSTAL",
    "department": "Department of Education",
    "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
    "primary": true
  },
  "organisationIdentification": {
    "identificationNo": "12345",
    "type": "LEI"
  },
  "partyName": "David",
  "partyType": "PERSON",
  "partyInvolvementType": "DEBTOR",
  "personIdentifications": [
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    },
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    }
  ]
}

Example:

{
  "involvedParty": {
    "reference": "Ref-1",
    "address": {
      "country": "US",
      "streetName": "Main Street",
      "townName": "Anytown",
      "countrySubDivision": "CA",
      "postalCode": "12345",
      "buildingNumber": "123",
      "subDepartment": "Institute of Education Sciences",
      "type": "POSTAL",
      "department": "Department of Education",
      "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
      "primary": true
    },
    "organisationIdentification": {
      "identificationNo": "12345",
      "type": "LEI"
    },
    "partyName": "David",
    "partyType": "PERSON",
    "partyInvolvementType": "DEBTOR",
    "personIdentifications": [
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      },
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      }
    ]
  }
}

payerAccountReference

Payer account reference. · object

Show child attributes

payerAccountReference.paymentInstructionAccount

Payment instruction account. · object

Show child attributes

payerAccountReference.paymentInstructionAccount.accountId

string

required

Identification of the payer's account.

Example:

"12232"

payerAccountReference.paymentInstructionAccount.involvedAccountType

enum<string>

Type of the account.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT

payerAccountReference.paymentInstructionAccount.numberType

string

Describes the type of data held in the account identifier field.

Example:

"IBAN"

payerAccountReference.paymentInstructionAccount.accountType

enum<string>

Type of the payment instruction account.

Available options:

LOAN,

DEPOSIT

payerAccountReference.paymentInstructionAccount.accountSubType

enum<string>

Sub-type of the payment instruction account.

Available options:

CURRENT_ACCOUNT,

FIXED_DEPOSIT,

SAVINGS_PLAN,

DEBIT_ACCOUNT,

CREDIT_ACCOUNT,

PAYMENT_ACCOUNT,

SETTLEMENT_ACCOUNT,

SAVINGS_ACCOUNT

Example:

{
  "accountId": "12232",
  "numberType": "IBAN",
  "accountSubType": "CURRENT_ACCOUNT",
  "accountType": "LOAN",
  "involvedAccountType": "DEBTOR"
}

Example:

{
  "paymentInstructionAccount": {
    "accountId": "12232",
    "numberType": "IBAN",
    "accountSubType": "CURRENT_ACCOUNT",
    "accountType": "LOAN",
    "involvedAccountType": "DEBTOR"
  }
}

payeeReference

Payeee reference. · object

Show child attributes

payeeReference.involvedParty

involved Party · object

Show child attributes

payeeReference.involvedParty.partyInvolvementType

enum<string>

Role played by a party in the context of a payment.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT,

ULTIMATE_DEBTOR,

ULTIMATE_CREDITOR,

INITIATOR,

INTERMEDIARY_AGENT,

CORRESPONDEBT_AGNET

payeeReference.involvedParty.partyType

enum<string>

Unique and unambiguous way to identify a party.

Available options:

PERSON,

ORGANISATION

payeeReference.involvedParty.personIdentifications

Identification to support Know Your Customer (KYC) processes. · object[]

Identification to support Know Your Customer (KYC) processes.

Show child attributes

payeeReference.involvedParty.personIdentifications.type

enum<string>

Type of the person identifications.

Available options:

ALIEN_REGISTRATION_NUMBER,

CUSTOMER_IDENTIFICATION_NUMBER,

EMPLOYEE_IDENTIFICATION_NUMBER,

NATIONAL_IDENTITY_NUMBER,

TAX_IDENTIFICATION_NUMBER,

SOCIAL_SECURITY_NUMBER,

DRIVERS_LICENSE_NUMBER,

PASSPORT_NUMBER,

IDENTITY_CARD_NUMBER,

EMPLOYER_IDENTIFICATION_NUMBER

payeeReference.involvedParty.personIdentifications.id

string

Unique identifier of person identification.

Example:

"123456789"

payeeReference.involvedParty.organisationIdentification

Organization identification. · object

Show child attributes

payeeReference.involvedParty.organisationIdentification.type

enum<string>

type

Available options:

LEI,

ELF,

MICX,

BICFI,

DUNS,

BANK_PARTY_IDENTIFICATION,

CENTRAL_BANK_IDENTIFICATION_NUMBER,

CLEARING_IDENTIFICATION_NUMBER,

CERTIFICATE_OF_INCORPORATION_NUMBER,

COUNTRY_IDENTIFICATION_CODE,

CUSTOMER_NUMBER,

DATA_UNIVERSAL_NUMBERING_SYSTEM,

EMPLOYER_IDENTIFICATION_NUMBER,

GS1_GLN_IDENTIFIER,

SIREN,

SIRET,

TAX_IDENTIFICATION_NUMBER,

EAN_GLN,

BANK_BRANCH_CODE

payeeReference.involvedParty.organisationIdentification.identificationNo

string

Identification number.

Example:

"12345"

Example:

{
  "identificationNo": "12345",
  "type": "LEI"
}

payeeReference.involvedParty.partyName

string

Name of the payer account.

Example:

"David"

payeeReference.involvedParty.address

Address. · object

Show child attributes

payeeReference.involvedParty.address.type

enum<string>

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

payeeReference.involvedParty.address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

payeeReference.involvedParty.address.department

string

Identification of a division of a large organization or building.

Example:

"Department of Education"

payeeReference.involvedParty.address.subDepartment

string

Identification of a sub-division of a large organization or building.

Example:

"Institute of Education Sciences"

payeeReference.involvedParty.address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Example:

"John Smith 123 Main Street, Apt 4B Anytown, CA 12345"

payeeReference.involvedParty.address.buildingNumber

string

Number that identifies the position of a building on a street.

Example:

"123"

payeeReference.involvedParty.address.streetName

string

Name of a street or thoroughfare.

Example:

"Main Street"

payeeReference.involvedParty.address.townName

string

Name of a built-up area, with defined boundaries, and a local government.

Example:

"Anytown"

payeeReference.involvedParty.address.postalCode

string

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example:

"12345"

payeeReference.involvedParty.address.countrySubDivision

string

Identifies name of a country subdivision such as state, region, county.

Example:

"CA"

payeeReference.involvedParty.address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"US"

Example:

{
  "country": "US",
  "streetName": "Main Street",
  "townName": "Anytown",
  "countrySubDivision": "CA",
  "postalCode": "12345",
  "buildingNumber": "123",
  "subDepartment": "Institute of Education Sciences",
  "type": "POSTAL",
  "department": "Department of Education",
  "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
  "primary": true
}

payeeReference.involvedParty.reference

string

Reference of the payer account.

Example:

"Ref-1"

Example:

{
  "reference": "Ref-1",
  "address": {
    "country": "US",
    "streetName": "Main Street",
    "townName": "Anytown",
    "countrySubDivision": "CA",
    "postalCode": "12345",
    "buildingNumber": "123",
    "subDepartment": "Institute of Education Sciences",
    "type": "POSTAL",
    "department": "Department of Education",
    "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
    "primary": true
  },
  "organisationIdentification": {
    "identificationNo": "12345",
    "type": "LEI"
  },
  "partyName": "David",
  "partyType": "PERSON",
  "partyInvolvementType": "DEBTOR",
  "personIdentifications": [
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    },
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    }
  ]
}

Example:

{
  "involvedParty": {
    "reference": "Ref-1",
    "address": {
      "country": "US",
      "streetName": "Main Street",
      "townName": "Anytown",
      "countrySubDivision": "CA",
      "postalCode": "12345",
      "buildingNumber": "123",
      "subDepartment": "Institute of Education Sciences",
      "type": "POSTAL",
      "department": "Department of Education",
      "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
      "primary": true
    },
    "organisationIdentification": {
      "identificationNo": "12345",
      "type": "LEI"
    },
    "partyName": "David",
    "partyType": "PERSON",
    "partyInvolvementType": "DEBTOR",
    "personIdentifications": [
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      },
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      }
    ]
  }
}

payeeBankReference

Payeee bank reference. · object

Show child attributes

payeeBankReference.involvedParty

involved Party · object

Show child attributes

payeeBankReference.involvedParty.partyInvolvementType

enum<string>

Role played by a party in the context of a payment.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT,

ULTIMATE_DEBTOR,

ULTIMATE_CREDITOR,

INITIATOR,

INTERMEDIARY_AGENT,

CORRESPONDEBT_AGNET

payeeBankReference.involvedParty.partyType

enum<string>

Unique and unambiguous way to identify a party.

Available options:

PERSON,

ORGANISATION

payeeBankReference.involvedParty.personIdentifications

Identification to support Know Your Customer (KYC) processes. · object[]

Identification to support Know Your Customer (KYC) processes.

Show child attributes

payeeBankReference.involvedParty.personIdentifications.type

enum<string>

Type of the person identifications.

Available options:

ALIEN_REGISTRATION_NUMBER,

CUSTOMER_IDENTIFICATION_NUMBER,

EMPLOYEE_IDENTIFICATION_NUMBER,

NATIONAL_IDENTITY_NUMBER,

TAX_IDENTIFICATION_NUMBER,

SOCIAL_SECURITY_NUMBER,

DRIVERS_LICENSE_NUMBER,

PASSPORT_NUMBER,

IDENTITY_CARD_NUMBER,

EMPLOYER_IDENTIFICATION_NUMBER

payeeBankReference.involvedParty.personIdentifications.id

string

Unique identifier of person identification.

Example:

"123456789"

payeeBankReference.involvedParty.organisationIdentification

Organization identification. · object

Show child attributes

payeeBankReference.involvedParty.organisationIdentification.type

enum<string>

type

Available options:

LEI,

ELF,

MICX,

BICFI,

DUNS,

BANK_PARTY_IDENTIFICATION,

CENTRAL_BANK_IDENTIFICATION_NUMBER,

CLEARING_IDENTIFICATION_NUMBER,

CERTIFICATE_OF_INCORPORATION_NUMBER,

COUNTRY_IDENTIFICATION_CODE,

CUSTOMER_NUMBER,

DATA_UNIVERSAL_NUMBERING_SYSTEM,

EMPLOYER_IDENTIFICATION_NUMBER,

GS1_GLN_IDENTIFIER,

SIREN,

SIRET,

TAX_IDENTIFICATION_NUMBER,

EAN_GLN,

BANK_BRANCH_CODE

payeeBankReference.involvedParty.organisationIdentification.identificationNo

string

Identification number.

Example:

"12345"

Example:

{
  "identificationNo": "12345",
  "type": "LEI"
}

payeeBankReference.involvedParty.partyName

string

Name of the payer account.

Example:

"David"

payeeBankReference.involvedParty.address

Address. · object

Show child attributes

payeeBankReference.involvedParty.address.type

enum<string>

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

payeeBankReference.involvedParty.address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

payeeBankReference.involvedParty.address.department

string

Identification of a division of a large organization or building.

Example:

"Department of Education"

payeeBankReference.involvedParty.address.subDepartment

string

Identification of a sub-division of a large organization or building.

Example:

"Institute of Education Sciences"

payeeBankReference.involvedParty.address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Example:

"John Smith 123 Main Street, Apt 4B Anytown, CA 12345"

payeeBankReference.involvedParty.address.buildingNumber

string

Number that identifies the position of a building on a street.

Example:

"123"

payeeBankReference.involvedParty.address.streetName

string

Name of a street or thoroughfare.

Example:

"Main Street"

payeeBankReference.involvedParty.address.townName

string

Name of a built-up area, with defined boundaries, and a local government.

Example:

"Anytown"

payeeBankReference.involvedParty.address.postalCode

string

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example:

"12345"

payeeBankReference.involvedParty.address.countrySubDivision

string

Identifies name of a country subdivision such as state, region, county.

Example:

"CA"

payeeBankReference.involvedParty.address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"US"

Example:

{
  "country": "US",
  "streetName": "Main Street",
  "townName": "Anytown",
  "countrySubDivision": "CA",
  "postalCode": "12345",
  "buildingNumber": "123",
  "subDepartment": "Institute of Education Sciences",
  "type": "POSTAL",
  "department": "Department of Education",
  "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
  "primary": true
}

payeeBankReference.involvedParty.reference

string

Reference of the payer account.

Example:

"Ref-1"

Example:

{
  "reference": "Ref-1",
  "address": {
    "country": "US",
    "streetName": "Main Street",
    "townName": "Anytown",
    "countrySubDivision": "CA",
    "postalCode": "12345",
    "buildingNumber": "123",
    "subDepartment": "Institute of Education Sciences",
    "type": "POSTAL",
    "department": "Department of Education",
    "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
    "primary": true
  },
  "organisationIdentification": {
    "identificationNo": "12345",
    "type": "LEI"
  },
  "partyName": "David",
  "partyType": "PERSON",
  "partyInvolvementType": "DEBTOR",
  "personIdentifications": [
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    },
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    }
  ]
}

Example:

{
  "involvedParty": {
    "reference": "Ref-1",
    "address": {
      "country": "US",
      "streetName": "Main Street",
      "townName": "Anytown",
      "countrySubDivision": "CA",
      "postalCode": "12345",
      "buildingNumber": "123",
      "subDepartment": "Institute of Education Sciences",
      "type": "POSTAL",
      "department": "Department of Education",
      "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
      "primary": true
    },
    "organisationIdentification": {
      "identificationNo": "12345",
      "type": "LEI"
    },
    "partyName": "David",
    "partyType": "PERSON",
    "partyInvolvementType": "DEBTOR",
    "personIdentifications": [
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      },
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      }
    ]
  }
}

payeeAccountReference

Payee account reference. · object

Show child attributes

payeeAccountReference.paymentInstructionAccount

Payment instruction account. · object

Show child attributes

payeeAccountReference.paymentInstructionAccount.accountId

string

required

Identification of the payer's account.

Example:

"12232"

payeeAccountReference.paymentInstructionAccount.involvedAccountType

enum<string>

Type of the account.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT

payeeAccountReference.paymentInstructionAccount.numberType

string

Describes the type of data held in the account identifier field.

Example:

"IBAN"

payeeAccountReference.paymentInstructionAccount.accountType

enum<string>

Type of the payment instruction account.

Available options:

LOAN,

DEPOSIT

payeeAccountReference.paymentInstructionAccount.accountSubType

enum<string>

Sub-type of the payment instruction account.

Available options:

CURRENT_ACCOUNT,

FIXED_DEPOSIT,

SAVINGS_PLAN,

DEBIT_ACCOUNT,

CREDIT_ACCOUNT,

PAYMENT_ACCOUNT,

SETTLEMENT_ACCOUNT,

SAVINGS_ACCOUNT

Example:

{
  "accountId": "12232",
  "numberType": "IBAN",
  "accountSubType": "CURRENT_ACCOUNT",
  "accountType": "LOAN",
  "involvedAccountType": "DEBTOR"
}

Example:

{
  "paymentInstructionAccount": {
    "accountId": "12232",
    "numberType": "IBAN",
    "accountSubType": "CURRENT_ACCOUNT",
    "accountType": "LOAN",
    "involvedAccountType": "DEBTOR"
  }
}

paymentInstruction

Payment instruction. · object

Show child attributes

paymentInstruction.amount

Amount. · object

The amount in the specified currency.

Show child attributes

paymentInstruction.amount.instructedAmount

number

required

The value of the amount being transferred in the currency specified. The value has to be positive.

Example:

10.25

paymentInstruction.amount.amountType

enum<string>

The type of payment amount.

Available options:

PRINCIPAL,

ACTUAL,

ESTIMATED,

MAXIMUM,

DEFAULT,

REPLACEMENT,

INCREMENTAL,

DECREMENTAL,

RESERVED,

AVAILABLE,

USED

paymentInstruction.amount.instructedCurrency

string

The number of fractional digits (or minor unit of currency). It must comply with ISO 4217.

Example:

"2"

paymentInstruction.amount.transferCurrency

string

Specifies the currency of the transferred amount, which is different from the currency of the debtor's account.

Example:

"USD"

paymentInstruction.amount.transferAmount

number<float>

The value of the amount being transferred in the currency specified. The value has to be positive.

Example:

100.25

Example:

{
  "amountType": "PRINCIPAL",
  "instructedCurrency": "2",
  "transferCurrency": "USD",
  "transferAmount": 100.25,
  "instructedAmount": 10.25
}

paymentInstruction.appliedFee

Fees applied. · object[]

Show child attributes

paymentInstruction.appliedFee.type

string

Type of fee.

Example:

"InterchangeFee"

paymentInstruction.appliedFee.amount

number

Indicates the amount of the applied fee.

Example:

10.12

paymentInstruction.appliedFee.currency

string

The three-letter currency code in the ISO4217 format.

Example:

"USD"

paymentInstruction.instructionNextAgent

string

Instruction to pay an amount of money to an ultimate beneficiary, on behalf of an originator.

paymentInstruction.directionType

enum<string>

A classification of an instance of a payment instruction as an inbound or outbound payment.

Available options:

INBOUND,

OUTBOUND

paymentInstruction.instructionType

enum<string>

Classification of a payment instruction according to the arrangement type that made it possible.

Available options:

CSH,

DPS,

DPH,

DPP,

CBS,

CBP,

CBH,

TCS,

TCH,

TCP,

COR,

FEX,

EQA,

LOA,

LOR,

SEC,

LBX,

DIV,

CSQ,

OCQ,

ODC,

CCQ,

TCK,

BKD,

CLR,

DCR,

BOE,

COL,

CMT,

CSW,

CTO,

CZB,

STF,

PAY,

PRI,

STD,

LIQ,

ADV,

VDA,

DPG,

DPN,

NET,

LMT,

BCK,

EXP,

CTR,

CLS,

EUP,

AGT,

AMY,

BAL,

BON,

BRF,

CBF,

CHR,

BEC,

COC,

COM,

CDT,

COS,

CPY,

GVT,

IHP,

INS,

INC,

INT,

LCF,

MET,

PEN,

GDS,

REF,

REN,

ROY,

SCV,

SAL,

SSB,

STO,

SBS,

TRP,

BEN,

VAT,

WHT,

TAX,

MSC,

OND,

MGL,

OTHR,

UFRO,

UWIN,

PEXH

paymentInstruction.requestedMechanism

string

The payment system requested to be used in a payment instruction.

Example:

"ACH Payment"

paymentInstruction.paymentDates

Payment dates. · object

Show child attributes

paymentInstruction.paymentDates.requestedExecutionDate

string<date-time>

Date when the transaction is scheduled to be executed.

paymentInstruction.paymentDates.acceptanceDate

string<date-time>

Date when the instruction is accepted by the bank or payment processor.

paymentInstruction.paymentDates.deliveryDate

string<date-time>

Date when the instruction is created or delivered to bank or payment processor.

paymentInstruction.paymentDates.valueDate

string<date-time>

Actual value date of the instruction.

paymentInstruction.paymentDates.expiryDate

string<date-time>

Expiry date of the payment instruction.

Example:

{
  "acceptanceDate": "2000-01-23T04:56:07.000Z",
  "expiryDate": "2000-01-23T04:56:07.000Z",
  "requestedExecutionDate": "2000-01-23T04:56:07.000Z",
  "valueDate": "2000-01-23T04:56:07.000Z",
  "deliveryDate": "2000-01-23T04:56:07.000Z"
}

paymentInstruction.processingValidityTime

Date Time · object

Show child attributes

paymentInstruction.processingValidityTime.startDateTime

string<date-time>

Indicates the start date and time.

paymentInstruction.processingValidityTime.endDateTime

string<date-time>

Indicates the end date and time.

Example:

{
  "startDateTime": "2000-01-23T04:56:07.000Z",
  "endDateTime": "2000-01-23T04:56:07.000Z"
}

paymentInstruction.chargeBearer

enum<string>

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Available options:

DEBT,

CRED,

SHAR,

SLEV

paymentInstruction.exchangeRate

Exchange Rate · object

Show child attributes

paymentInstruction.exchangeRate.currency

string

Currency in which the rate of exchange is expressed in a currency exchange.

Example:

"GBP"

paymentInstruction.exchangeRate.rate

number

The factor used for conversion of an amount from one currency to another.

Example:

1.23

paymentInstruction.exchangeRate.rateType

enum<string>

Specifies the type used to complete the currency exchange.

Available options:

ACTUAL,

INDICATIVE,

AGREED

Example:

{
  "rateType": "ACTUAL",
  "rate": 1.23,
  "currency": "GBP"
}

paymentInstruction.priority

enum<string>

Available options:

NORM,

HIGH

paymentInstruction.clearingChannel

enum<string>

Specifies the clearing channel to be used to process the payment instruction.

Available options:

RTGS,

RTNS,

MPNS,

BOOK

paymentInstruction.creditDebtIndicator

enum<string>

Indicates the payment is a debit or a credit.

Available options:

CREDIT,

DEBIT

paymentInstruction.schedule

Schedule · object

Show child attributes

paymentInstruction.schedule.startDate

string<date>

When to start executing the schedule. First transfer will be executed on first calculated date by schedule after this date.

paymentInstruction.schedule.frequency

enum<string>

Denotes how frequently the transfer should be made.

Available options:

ONCE,

DAILY,

WEEKLY,

BIWEEKLY,

MONTHLY,

QUARTERLY,

YEARLY

paymentInstruction.schedule.endDate

string<date>

When to stop transfers. Transfers will not be executed after this date. Only one of endDate and repeat is possible.

paymentInstruction.schedule.noOfRepetition

integer

Number of transfer to be executed.

paymentInstruction.schedule.executeOn

string<date>

Denotes day on which transfer should be executed.

paymentInstruction.schedule.skipInterval

enum<integer>

Indicates skip interval of transfer. 1 would mean execute every time, 2 - every other time.

Available options:

1,

2

Example:

{
  "endDate": "2000-01-23T00:00:00.000Z",
  "noOfRepetition": 0,
  "skipInterval": 6,
  "executeOn": "2000-01-23T00:00:00.000Z",
  "startDate": "2000-01-23T00:00:00.000Z",
  "frequency": "ONCE"
}

Example:

{
  "chargeBearer": "DEBT",
  "amount": {
    "amountType": "PRINCIPAL",
    "instructedCurrency": "2",
    "transferCurrency": "USD",
    "transferAmount": 100.25,
    "instructedAmount": 10.25
  },
  "paymentDates": {
    "acceptanceDate": "2000-01-23T04:56:07.000Z",
    "expiryDate": "2000-01-23T04:56:07.000Z",
    "requestedExecutionDate": "2000-01-23T04:56:07.000Z",
    "valueDate": "2000-01-23T04:56:07.000Z",
    "deliveryDate": "2000-01-23T04:56:07.000Z"
  },
  "instructionNextAgent": "instructionNextAgent",
  "clearingChannel": "RTGS",
  "requestedMechanism": "ACH Payment",
  "processingValidityTime": {
    "startDateTime": "2000-01-23T04:56:07.000Z",
    "endDateTime": "2000-01-23T04:56:07.000Z"
  },
  "priority": "NORM",
  "schedule": {
    "endDate": "2000-01-23T00:00:00.000Z",
    "noOfRepetition": 0,
    "skipInterval": 6,
    "executeOn": "2000-01-23T00:00:00.000Z",
    "startDate": "2000-01-23T00:00:00.000Z",
    "frequency": "ONCE"
  },
  "creditDebtIndicator": "CREDIT",
  "directionType": "INBOUND",
  "instructionType": "CSH",
  "exchangeRate": {
    "rateType": "ACTUAL",
    "rate": 1.23,
    "currency": "GBP"
  },
  "appliedFee": [
    {
      "amount": 10.12,
      "currency": "USD",
      "type": "InterchangeFee"
    },
    {
      "amount": 10.12,
      "currency": "USD",
      "type": "InterchangeFee"
    }
  ]
}

paymentProcessingConfiguration

Payment processing configuration. · object

Show child attributes

paymentProcessingConfiguration.paymentArrangement

Payment arrangment. · object

Show child attributes

paymentProcessingConfiguration.paymentArrangement.serviceType

enum<string>

Specifies the type of the payment service.

Available options:

CREDIT_TRANSFER_SERVICE,

STANDING_ORDER_SERVICE,

DIRECT_DEBIT_SERVICE,

CARD_PAYMENT_SERVICE,

WITHDRAW_SERVICE,

DEPOSIT_SERVICE,

OVERDRAFT_SERVICE,

MONEY_REMITTANCE_SERVICE,

STATEMENT_SERVICE

paymentProcessingConfiguration.paymentArrangement.paymentType

enum<string>

The type or nature of the payment.

Available options:

CSH,

DPS,

DPH,

DPP,

CBS,

CBP,

CBH,

TCS,

TCH,

TCP,

COR,

FEX,

EQA,

LOA,

LOR,

SEC,

LBX,

DIV,

CSQ,

OCQ,

ODC,

CCQ,

TCK,

BKD,

CLR,

DCR,

BOE,

COL,

CMT,

CSW,

CTO,

CZB,

STF,

PAY,

PRI,

STD,

LIQ,

ADV,

VDA,

DPG,

DPN,

NET,

LMT,

BCK,

EXP,

CTR,

CLS,

EUP,

AGT,

AMY,

BAL,

BON,

BRF,

CBF,

CHR,

BEC,

COC,

COM,

CDT,

COS,

CPY,

GVT,

IHP,

INS,

INC,

INT,

LCF,

MET,

PEN,

GDS,

REF,

REN,

ROY,

SCV,

SAL,

SSB,

STO,

SBS,

TRP,

BEN,

VAT,

WHT,

TAX,

MSC,

OND,

MGL,

OTHR,

UFRO,

UWIN,

PEXH

paymentProcessingConfiguration.paymentArrangement.paymentMethod

enum<string>

Specifies the means of payment that will be used to move the amount. of money

Available options:

CHK,

TRF,

DD,

TRA,

DIRE,

CLAS

paymentProcessingConfiguration.paymentArrangement.categoryPurpose

enum<string>

Specifies the type of transaction that resulted in the payment.

Available options:

INTC,

CORT,

SALA,

TREA,

CASH,

DIVI,

GOVT,

INTE,

LOAN,

PENS,

SECU,

SSBE,

TAXS,

VATX,

SUPP,

HEDG,

TRAD,

WHLD

paymentProcessingConfiguration.paymentArrangement.purpose

string

The text input provided as purpose of payment.

paymentProcessingConfiguration.paymentArrangement.paymentSeq

enum<string>

Specifies the type of the current transaction that belongs to a sequence of transactions.

Available options:

FIRST,

RECURRING,

FINAL,

ONEOFF,

REPRESENTED

Example:

{
  "serviceType": "CREDIT_TRANSFER_SERVICE",
  "categoryPurpose": "INTC",
  "purpose": "purpose",
  "paymentMethod": "CHK",
  "paymentSeq": "FIRST",
  "paymentType": "CSH"
}

paymentProcessingConfiguration.remittanceInfo

Remittance information. · object

Show child attributes

paymentProcessingConfiguration.remittanceInfo.type

enum<string>

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in structured or unstructured form.

Available options:

STRUCTURED,

UNSTRUCTURED

paymentProcessingConfiguration.remittanceInfo.content

string

The content of the remittance information.

Example:

"Payment Amount - $500.00"

Example:

{
  "type": "STRUCTURED",
  "content": "Payment Amount - $500.00"
}

paymentProcessingConfiguration.localInstrument

enum<string>

User community specific instrument.

Available options:

DIRECT_DEBIT_CONFIRMED_ELECTRONIC_MANDATE,

DIRECT_DEBIT_PAPER_MANDATE_WITH_PAPER_AUTHORIZATION,

DIRECT_DEBIT_UNCONFIRMED_ELECTRONIC_MANDATE,

BATCH_PAYMENTS_ARUBA,

INSTANT_PAYMENTS_ARUBA,

CREDIT_TRANSFERS,

NON_PRE_AUTHORISED_DIRECT_DEBIT_AT,

PRE_AUTHORISED_DIRECT_DEBIT_AT,

CASH_PER_POST,

RETURNED_CREDIT_TRANSFERS,

TRUNCATED_CREDIT_TRANSFERS,

DIRECT_DEBITS,

RETURNED_DIRECT_DEBITS,

TRUNCATED_CHECKS,

REVOKED_CREDIT_TRANSFERS,

REVOKED_DIRECT_DEBITS,

REVOKED_RETURNED_CREDIT_TRANSFERS,

REVOKED_RETURNED_DIRECT_DEBITS,

REVOKED_TRUNCATED_CHECKS,

REVOKED_TRUNCATED_CREDIT_TRANSFERS,

CARD_CLEARING,

NON_PRE_AUTHORISED_DIRECT_DEBIT_DE,

PRE_AUTHORISED_DIRECT_DEBIT_DE,

IMAGE_BASED_CHEQUE_COLLECTION,

PAPERLESS_CHEQUE_COLLECTION,

BUSINESS_TO_BUSINESS_DIRECT_DEBIT,

BUSINESS_TO_CUSTOMER_DIRECT_DEBIT,

ANCILLARY_SYSTEM_TRANSFER_INITIATION,

BACKUP_PAYMENT,

MANDATED_PAYMENT,

SETTLEMENT_BANK_TRANSFER_INITIATION,

PRE_AUTHORISED_DIRECT_DEBIT_ACCELERATED_CLEARING_2_DAY_ORDINAIRE_NORMAL_CLEARING_4_DAY,

PRE_AUTHORISED_DIRECT_DEBIT_ORDINAIRE_NORMAL_CLEARING_4_DAY,

PRE_AUTHORISED_DIRECT_DEBIT_VERIFIED_CLEARING,

RECOVERED_BILL_OF_EXCHANGE_OR_PROMISSORY_NOTE,

NON_PRE_AUTHORISED_DIRECT_DEBIT_RIBA,

PRE_AUTHORISED_REVOCABLE_DIRECT_DEBIT,

PRE_AUTHORISED_REVOCABLE_URGENT_DIRECT_DEBIT,

PAYMENTS_VIA_INTERNET_OWNED_BY_CURRENCE,

INSTANT_CREDIT_TRANSFER_NOT_TIME_CRITICAL,

INSTANT_CREDIT_TRANSFER_TIME_CRITICAL,

PAYMENTS_VIA_INTERNET_OWNED_BY_CURRENCE_USING_INSTANT_CREDIT_TRANSFER,

PAYMENTS_VIA_INTERNET_OWNED_BY_CURRENCE_USING_INSTANT_CREDIT_TRANSFER_NOT_TIME_CRITICAL,

PAYMENTS_VIA_INTERNET_OWNED_BY_CURRENCE_USING_INSTANT_CREDIT_TRANSFER_TIME_CRITICAL,

DUTCH_DOMESTIC_BULK_PAYMENT,

DUTCH_URGENT_PAYMENT,

PAYMENT_VIA_ACCEPTGIRO_OWNED_BY_CURRENCE,

PAYMENTS_VIA_STANDAARD_DIGITALE_NOTA,

INCIDENT_MANAGEMENT_CORRECTION,

DIRECT_DEBIT_INITIATED_BY_THE_GOVERNMENT_WITH_SPECIAL_CONDITIONS,

MASS_PAYMENT_BENEFICIARY,

MASS_PAYMENT_OURS,

MASS_PAYMENT_SHARED,

STANDING_ORDER,

ONE_OFF_AUTHORISATION,

ONE_OFF_AUTHORISATION_CHARITIES,

ONE_OFF_AUTHORISATION_CONSTRUCTION_INDUSTRY,

ONE_OFF_AUTHORISATION_TUITION_FEES,

STANDING_AUTHORISATION_COMPANIES,

STANDING_AUTHORISATION_COMPANIES_WITHOUT_DEBTOR_REVOCATION_RIGHT,

STANDING_AUTHORISATION_GENERAL,

STANDING_AUTHORISATION_LOTTERIES,

CONVERTED_BANK_PAYMENT,

BUSINESS_PAYMENT,

CROSS_BORDER_CUSTOMER_CREDIT_TRANSFER,

OVERNIGHT,

PAYMENT_WITH_IRI,

SAME_DAY,

CORE_NO_REFUND,

DIRECT_DEBIT_FIXED_AMOUNT,

SEPA_DIRECT_DEBIT_CORE,

SEPA_B2B_DIRECT_DEBIT_AMI,

SEPA_BUSINESS_TO_BUSINESS_DIRECT_DEBIT,

SEPA_CORE_D1_DIRECT_DEBIT_AMI,

SEPA_CORE_DIRECT_DEBIT_AMI,

SEPA_DIRECT_DEBIT_1_DAY_SETTLEMENT,

SEPA_FA_DIRECT_DEBIT_AMI,

INSTANT_CREDIT_TRANSFER,

AUTHENTICATED_DIRECT_DEBIT,

UNAUTHENTICATED_DIRECT_DEBIT,

CASH_CONCENTRATION_INTRAGROUP,

BANK_TRANSFER,

CHECK_SAME_DAY_SETTLEMENT_WIRE,

CUSTOMER_TRANSFER,

CUSTOMER_TRANSFER_PLUS,

DEPOSIT_TO_SENDERS_ACCOUNT,

FED_FUNDS_RETURNED,

FED_FUNDS_SOLD,

NON_VALUE_SERVICE_MESSAGE,

DRAWDOWN_RESPONSE_VALUE_TO_HONOR_A_DRAWDOWN_REQUEST,

BANK_TO_BANK_DRAWDOWN_REQUEST_OR_RESPONSE_NON_VALUE,

CUSTOMER_OR_CORPORATE_DRAWDOWN_REQUEST_OR_RESPONSE_NON_VALUE,

INTERNATIONAL_ACH,

CASH_CONCENTRATION_OR_DISBURSEMENT_CORPORATE_COUNTERPARTY,

CORPORATE_TRADE_EXCHANGE,

PREARRANGED_PAYMENT_OR_DEPOSIT_CONSUMER_COUNTERPARTY,

CUSTOMER_INITIATED_ENTRY,

REPRESENTED_CHECK_ENTRY,

ACCOUNTS_RECEIVABLE_CHECK,

INTERNET_INITIATED_ENTRY,

POINT_OF_PURCHASE,

POINT_OF_SALE,

TELEPHONE_INITIATED_ENTRY

Example:

{
  "localInstrument": "DIRECT_DEBIT_CONFIRMED_ELECTRONIC_MANDATE",
  "paymentArrangement": {
    "serviceType": "CREDIT_TRANSFER_SERVICE",
    "categoryPurpose": "INTC",
    "purpose": "purpose",
    "paymentMethod": "CHK",
    "paymentSeq": "FIRST",
    "paymentType": "CSH"
  },
  "remittanceInfo": {
    "type": "STRUCTURED",
    "content": "Payment Amount - $500.00"
  }
}

interestedParties

involved Party · object[]

Show child attributes

interestedParties.partyInvolvementType

enum<string>

Role played by a party in the context of a payment.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT,

ULTIMATE_DEBTOR,

ULTIMATE_CREDITOR,

INITIATOR,

INTERMEDIARY_AGENT,

CORRESPONDEBT_AGNET

interestedParties.partyType

enum<string>

Unique and unambiguous way to identify a party.

Available options:

PERSON,

ORGANISATION

interestedParties.personIdentifications

Identification to support Know Your Customer (KYC) processes. · object[]

Identification to support Know Your Customer (KYC) processes.

Show child attributes

interestedParties.personIdentifications.type

enum<string>

Type of the person identifications.

Available options:

ALIEN_REGISTRATION_NUMBER,

CUSTOMER_IDENTIFICATION_NUMBER,

EMPLOYEE_IDENTIFICATION_NUMBER,

NATIONAL_IDENTITY_NUMBER,

TAX_IDENTIFICATION_NUMBER,

SOCIAL_SECURITY_NUMBER,

DRIVERS_LICENSE_NUMBER,

PASSPORT_NUMBER,

IDENTITY_CARD_NUMBER,

EMPLOYER_IDENTIFICATION_NUMBER

interestedParties.personIdentifications.id

string

Unique identifier of person identification.

Example:

"123456789"

interestedParties.organisationIdentification

Organization identification. · object

Show child attributes

interestedParties.organisationIdentification.type

enum<string>

type

Available options:

LEI,

ELF,

MICX,

BICFI,

DUNS,

BANK_PARTY_IDENTIFICATION,

CENTRAL_BANK_IDENTIFICATION_NUMBER,

CLEARING_IDENTIFICATION_NUMBER,

CERTIFICATE_OF_INCORPORATION_NUMBER,

COUNTRY_IDENTIFICATION_CODE,

CUSTOMER_NUMBER,

DATA_UNIVERSAL_NUMBERING_SYSTEM,

EMPLOYER_IDENTIFICATION_NUMBER,

GS1_GLN_IDENTIFIER,

SIREN,

SIRET,

TAX_IDENTIFICATION_NUMBER,

EAN_GLN,

BANK_BRANCH_CODE

interestedParties.organisationIdentification.identificationNo

string

Identification number.

Example:

"12345"

Example:

{
  "identificationNo": "12345",
  "type": "LEI"
}

interestedParties.partyName

string

Name of the payer account.

Example:

"David"

interestedParties.address

Address. · object

Show child attributes

interestedParties.address.type

enum<string>

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

interestedParties.address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

interestedParties.address.department

string

Identification of a division of a large organization or building.

Example:

"Department of Education"

interestedParties.address.subDepartment

string

Identification of a sub-division of a large organization or building.

Example:

"Institute of Education Sciences"

interestedParties.address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Example:

"John Smith 123 Main Street, Apt 4B Anytown, CA 12345"

interestedParties.address.buildingNumber

string

Number that identifies the position of a building on a street.

Example:

"123"

interestedParties.address.streetName

string

Name of a street or thoroughfare.

Example:

"Main Street"

interestedParties.address.townName

string

Name of a built-up area, with defined boundaries, and a local government.

Example:

"Anytown"

interestedParties.address.postalCode

string

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example:

"12345"

interestedParties.address.countrySubDivision

string

Identifies name of a country subdivision such as state, region, county.

Example:

"CA"

interestedParties.address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"US"

Example:

{
  "country": "US",
  "streetName": "Main Street",
  "townName": "Anytown",
  "countrySubDivision": "CA",
  "postalCode": "12345",
  "buildingNumber": "123",
  "subDepartment": "Institute of Education Sciences",
  "type": "POSTAL",
  "department": "Department of Education",
  "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
  "primary": true
}

interestedParties.reference

string

Reference of the payer account.

Example:

"Ref-1"

customFields

CustomField · object

Custom fields related to payments.

Show child attributes

customFields.{key}

object

Response

Created.

paymentInstructionReference

Payment instruction reference. · object

Show child attributes

paymentInstructionReference.identification

string

required

Unique identifier for the bank code of which the details are retreived.

Example:

"123456"

paymentInstructionReference.externalId

string

The external ID.

Example:

"123456"

paymentInstructionReference.reference

string

A tag/label issued by the initiator of the transaction in order to be able to refer to the respective transaction.

Example:

"reference"

paymentInstructionReference.description

string

Short description of the transaction.

Example:

"Bill payment."

paymentInstructionReference.usedMechanism

string

The payment mechanism the bank decides to use in the transaction to execute a payment instruction.

Example:

"US_DOMESTIC_WIRE_RET"

paymentInstructionReference.status

enum<string>

The status of the transaction.

Available options:

INITIATED,

CANCELLED,

CONFIRMED,

SUSPENDED,

PENDING,

COMPLETED,

RETURNED,

FAILED,

SCHEDULED

paymentInstructionReference.reason

string

Reason code that connecting system accepted/rejected the payment.

Example:

""

paymentInstructionReference.uetr

string

Universally unique identifier to provide an end-to-end reference of a payment transaction.

Example:

"UUIDv4"

paymentInstructionReference.etoeIdentification

string

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

Example:

""

Example:

{
  "reference": "reference",
  "reason": "",
  "identification": "123456",
  "uetr": "UUIDv4",
  "externalId": "123456",
  "description": "Bill payment.",
  "etoeIdentification": "",
  "usedMechanism": "US_DOMESTIC_WIRE_RET",
  "status": null
}

payerReference

Payer reference. · object

Show child attributes

payerReference.involvedParty

involved Party · object

Show child attributes

payerReference.involvedParty.partyInvolvementType

enum<string>

Role played by a party in the context of a payment.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT,

ULTIMATE_DEBTOR,

ULTIMATE_CREDITOR,

INITIATOR,

INTERMEDIARY_AGENT,

CORRESPONDEBT_AGNET

payerReference.involvedParty.partyType

enum<string>

Unique and unambiguous way to identify a party.

Available options:

PERSON,

ORGANISATION

payerReference.involvedParty.personIdentifications

Identification to support Know Your Customer (KYC) processes. · object[]

Identification to support Know Your Customer (KYC) processes.

Show child attributes

payerReference.involvedParty.personIdentifications.type

enum<string>

Type of the person identifications.

Available options:

ALIEN_REGISTRATION_NUMBER,

CUSTOMER_IDENTIFICATION_NUMBER,

EMPLOYEE_IDENTIFICATION_NUMBER,

NATIONAL_IDENTITY_NUMBER,

TAX_IDENTIFICATION_NUMBER,

SOCIAL_SECURITY_NUMBER,

DRIVERS_LICENSE_NUMBER,

PASSPORT_NUMBER,

IDENTITY_CARD_NUMBER,

EMPLOYER_IDENTIFICATION_NUMBER

payerReference.involvedParty.personIdentifications.id

string

Unique identifier of person identification.

Example:

"123456789"

payerReference.involvedParty.organisationIdentification

Organization identification. · object

Show child attributes

payerReference.involvedParty.organisationIdentification.type

enum<string>

type

Available options:

LEI,

ELF,

MICX,

BICFI,

DUNS,

BANK_PARTY_IDENTIFICATION,

CENTRAL_BANK_IDENTIFICATION_NUMBER,

CLEARING_IDENTIFICATION_NUMBER,

CERTIFICATE_OF_INCORPORATION_NUMBER,

COUNTRY_IDENTIFICATION_CODE,

CUSTOMER_NUMBER,

DATA_UNIVERSAL_NUMBERING_SYSTEM,

EMPLOYER_IDENTIFICATION_NUMBER,

GS1_GLN_IDENTIFIER,

SIREN,

SIRET,

TAX_IDENTIFICATION_NUMBER,

EAN_GLN,

BANK_BRANCH_CODE

payerReference.involvedParty.organisationIdentification.identificationNo

string

Identification number.

Example:

"12345"

Example:

{
  "identificationNo": "12345",
  "type": "LEI"
}

payerReference.involvedParty.partyName

string

Name of the payer account.

Example:

"David"

payerReference.involvedParty.address

Address. · object

Show child attributes

payerReference.involvedParty.address.type

enum<string>

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

payerReference.involvedParty.address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

payerReference.involvedParty.address.department

string

Identification of a division of a large organization or building.

Example:

"Department of Education"

payerReference.involvedParty.address.subDepartment

string

Identification of a sub-division of a large organization or building.

Example:

"Institute of Education Sciences"

payerReference.involvedParty.address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Example:

"John Smith 123 Main Street, Apt 4B Anytown, CA 12345"

payerReference.involvedParty.address.buildingNumber

string

Number that identifies the position of a building on a street.

Example:

"123"

payerReference.involvedParty.address.streetName

string

Name of a street or thoroughfare.

Example:

"Main Street"

payerReference.involvedParty.address.townName

string

Name of a built-up area, with defined boundaries, and a local government.

Example:

"Anytown"

payerReference.involvedParty.address.postalCode

string

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example:

"12345"

payerReference.involvedParty.address.countrySubDivision

string

Identifies name of a country subdivision such as state, region, county.

Example:

"CA"

payerReference.involvedParty.address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"US"

Example:

{
  "country": "US",
  "streetName": "Main Street",
  "townName": "Anytown",
  "countrySubDivision": "CA",
  "postalCode": "12345",
  "buildingNumber": "123",
  "subDepartment": "Institute of Education Sciences",
  "type": "POSTAL",
  "department": "Department of Education",
  "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
  "primary": true
}

payerReference.involvedParty.reference

string

Reference of the payer account.

Example:

"Ref-1"

Example:

{
  "reference": "Ref-1",
  "address": {
    "country": "US",
    "streetName": "Main Street",
    "townName": "Anytown",
    "countrySubDivision": "CA",
    "postalCode": "12345",
    "buildingNumber": "123",
    "subDepartment": "Institute of Education Sciences",
    "type": "POSTAL",
    "department": "Department of Education",
    "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
    "primary": true
  },
  "organisationIdentification": {
    "identificationNo": "12345",
    "type": "LEI"
  },
  "partyName": "David",
  "partyType": "PERSON",
  "partyInvolvementType": "DEBTOR",
  "personIdentifications": [
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    },
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    }
  ]
}

Example:

{
  "involvedParty": {
    "reference": "Ref-1",
    "address": {
      "country": "US",
      "streetName": "Main Street",
      "townName": "Anytown",
      "countrySubDivision": "CA",
      "postalCode": "12345",
      "buildingNumber": "123",
      "subDepartment": "Institute of Education Sciences",
      "type": "POSTAL",
      "department": "Department of Education",
      "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
      "primary": true
    },
    "organisationIdentification": {
      "identificationNo": "12345",
      "type": "LEI"
    },
    "partyName": "David",
    "partyType": "PERSON",
    "partyInvolvementType": "DEBTOR",
    "personIdentifications": [
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      },
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      }
    ]
  }
}

payerBankReference

Payer bank reference. · object

Show child attributes

payerBankReference.involvedParty

involved Party · object

Show child attributes

payerBankReference.involvedParty.partyInvolvementType

enum<string>

Role played by a party in the context of a payment.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT,

ULTIMATE_DEBTOR,

ULTIMATE_CREDITOR,

INITIATOR,

INTERMEDIARY_AGENT,

CORRESPONDEBT_AGNET

payerBankReference.involvedParty.partyType

enum<string>

Unique and unambiguous way to identify a party.

Available options:

PERSON,

ORGANISATION

payerBankReference.involvedParty.personIdentifications

Identification to support Know Your Customer (KYC) processes. · object[]

Identification to support Know Your Customer (KYC) processes.

Show child attributes

payerBankReference.involvedParty.personIdentifications.type

enum<string>

Type of the person identifications.

Available options:

ALIEN_REGISTRATION_NUMBER,

CUSTOMER_IDENTIFICATION_NUMBER,

EMPLOYEE_IDENTIFICATION_NUMBER,

NATIONAL_IDENTITY_NUMBER,

TAX_IDENTIFICATION_NUMBER,

SOCIAL_SECURITY_NUMBER,

DRIVERS_LICENSE_NUMBER,

PASSPORT_NUMBER,

IDENTITY_CARD_NUMBER,

EMPLOYER_IDENTIFICATION_NUMBER

payerBankReference.involvedParty.personIdentifications.id

string

Unique identifier of person identification.

Example:

"123456789"

payerBankReference.involvedParty.organisationIdentification

Organization identification. · object

Show child attributes

payerBankReference.involvedParty.organisationIdentification.type

enum<string>

type

Available options:

LEI,

ELF,

MICX,

BICFI,

DUNS,

BANK_PARTY_IDENTIFICATION,

CENTRAL_BANK_IDENTIFICATION_NUMBER,

CLEARING_IDENTIFICATION_NUMBER,

CERTIFICATE_OF_INCORPORATION_NUMBER,

COUNTRY_IDENTIFICATION_CODE,

CUSTOMER_NUMBER,

DATA_UNIVERSAL_NUMBERING_SYSTEM,

EMPLOYER_IDENTIFICATION_NUMBER,

GS1_GLN_IDENTIFIER,

SIREN,

SIRET,

TAX_IDENTIFICATION_NUMBER,

EAN_GLN,

BANK_BRANCH_CODE

payerBankReference.involvedParty.organisationIdentification.identificationNo

string

Identification number.

Example:

"12345"

Example:

{
  "identificationNo": "12345",
  "type": "LEI"
}

payerBankReference.involvedParty.partyName

string

Name of the payer account.

Example:

"David"

payerBankReference.involvedParty.address

Address. · object

Show child attributes

payerBankReference.involvedParty.address.type

enum<string>

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

payerBankReference.involvedParty.address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

payerBankReference.involvedParty.address.department

string

Identification of a division of a large organization or building.

Example:

"Department of Education"

payerBankReference.involvedParty.address.subDepartment

string

Identification of a sub-division of a large organization or building.

Example:

"Institute of Education Sciences"

payerBankReference.involvedParty.address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Example:

"John Smith 123 Main Street, Apt 4B Anytown, CA 12345"

payerBankReference.involvedParty.address.buildingNumber

string

Number that identifies the position of a building on a street.

Example:

"123"

payerBankReference.involvedParty.address.streetName

string

Name of a street or thoroughfare.

Example:

"Main Street"

payerBankReference.involvedParty.address.townName

string

Name of a built-up area, with defined boundaries, and a local government.

Example:

"Anytown"

payerBankReference.involvedParty.address.postalCode

string

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example:

"12345"

payerBankReference.involvedParty.address.countrySubDivision

string

Identifies name of a country subdivision such as state, region, county.

Example:

"CA"

payerBankReference.involvedParty.address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"US"

Example:

{
  "country": "US",
  "streetName": "Main Street",
  "townName": "Anytown",
  "countrySubDivision": "CA",
  "postalCode": "12345",
  "buildingNumber": "123",
  "subDepartment": "Institute of Education Sciences",
  "type": "POSTAL",
  "department": "Department of Education",
  "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
  "primary": true
}

payerBankReference.involvedParty.reference

string

Reference of the payer account.

Example:

"Ref-1"

Example:

{
  "reference": "Ref-1",
  "address": {
    "country": "US",
    "streetName": "Main Street",
    "townName": "Anytown",
    "countrySubDivision": "CA",
    "postalCode": "12345",
    "buildingNumber": "123",
    "subDepartment": "Institute of Education Sciences",
    "type": "POSTAL",
    "department": "Department of Education",
    "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
    "primary": true
  },
  "organisationIdentification": {
    "identificationNo": "12345",
    "type": "LEI"
  },
  "partyName": "David",
  "partyType": "PERSON",
  "partyInvolvementType": "DEBTOR",
  "personIdentifications": [
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    },
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    }
  ]
}

Example:

{
  "involvedParty": {
    "reference": "Ref-1",
    "address": {
      "country": "US",
      "streetName": "Main Street",
      "townName": "Anytown",
      "countrySubDivision": "CA",
      "postalCode": "12345",
      "buildingNumber": "123",
      "subDepartment": "Institute of Education Sciences",
      "type": "POSTAL",
      "department": "Department of Education",
      "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
      "primary": true
    },
    "organisationIdentification": {
      "identificationNo": "12345",
      "type": "LEI"
    },
    "partyName": "David",
    "partyType": "PERSON",
    "partyInvolvementType": "DEBTOR",
    "personIdentifications": [
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      },
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      }
    ]
  }
}

payerAccountReference

Payer account reference. · object

Show child attributes

payerAccountReference.paymentInstructionAccount

Payment instruction account. · object

Show child attributes

payerAccountReference.paymentInstructionAccount.accountId

string

required

Identification of the payer's account.

Example:

"12232"

payerAccountReference.paymentInstructionAccount.involvedAccountType

enum<string>

Type of the account.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT

payerAccountReference.paymentInstructionAccount.numberType

string

Describes the type of data held in the account identifier field.

Example:

"IBAN"

payerAccountReference.paymentInstructionAccount.accountType

enum<string>

Type of the payment instruction account.

Available options:

LOAN,

DEPOSIT

payerAccountReference.paymentInstructionAccount.accountSubType

enum<string>

Sub-type of the payment instruction account.

Available options:

CURRENT_ACCOUNT,

FIXED_DEPOSIT,

SAVINGS_PLAN,

DEBIT_ACCOUNT,

CREDIT_ACCOUNT,

PAYMENT_ACCOUNT,

SETTLEMENT_ACCOUNT,

SAVINGS_ACCOUNT

Example:

{
  "accountId": "12232",
  "numberType": "IBAN",
  "accountSubType": "CURRENT_ACCOUNT",
  "accountType": "LOAN",
  "involvedAccountType": "DEBTOR"
}

Example:

{
  "paymentInstructionAccount": {
    "accountId": "12232",
    "numberType": "IBAN",
    "accountSubType": "CURRENT_ACCOUNT",
    "accountType": "LOAN",
    "involvedAccountType": "DEBTOR"
  }
}

payeeReference

Payeee reference. · object

Show child attributes

payeeReference.involvedParty

involved Party · object

Show child attributes

payeeReference.involvedParty.partyInvolvementType

enum<string>

Role played by a party in the context of a payment.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT,

ULTIMATE_DEBTOR,

ULTIMATE_CREDITOR,

INITIATOR,

INTERMEDIARY_AGENT,

CORRESPONDEBT_AGNET

payeeReference.involvedParty.partyType

enum<string>

Unique and unambiguous way to identify a party.

Available options:

PERSON,

ORGANISATION

payeeReference.involvedParty.personIdentifications

Identification to support Know Your Customer (KYC) processes. · object[]

Identification to support Know Your Customer (KYC) processes.

Show child attributes

payeeReference.involvedParty.personIdentifications.type

enum<string>

Type of the person identifications.

Available options:

ALIEN_REGISTRATION_NUMBER,

CUSTOMER_IDENTIFICATION_NUMBER,

EMPLOYEE_IDENTIFICATION_NUMBER,

NATIONAL_IDENTITY_NUMBER,

TAX_IDENTIFICATION_NUMBER,

SOCIAL_SECURITY_NUMBER,

DRIVERS_LICENSE_NUMBER,

PASSPORT_NUMBER,

IDENTITY_CARD_NUMBER,

EMPLOYER_IDENTIFICATION_NUMBER

payeeReference.involvedParty.personIdentifications.id

string

Unique identifier of person identification.

Example:

"123456789"

payeeReference.involvedParty.organisationIdentification

Organization identification. · object

Show child attributes

payeeReference.involvedParty.organisationIdentification.type

enum<string>

type

Available options:

LEI,

ELF,

MICX,

BICFI,

DUNS,

BANK_PARTY_IDENTIFICATION,

CENTRAL_BANK_IDENTIFICATION_NUMBER,

CLEARING_IDENTIFICATION_NUMBER,

CERTIFICATE_OF_INCORPORATION_NUMBER,

COUNTRY_IDENTIFICATION_CODE,

CUSTOMER_NUMBER,

DATA_UNIVERSAL_NUMBERING_SYSTEM,

EMPLOYER_IDENTIFICATION_NUMBER,

GS1_GLN_IDENTIFIER,

SIREN,

SIRET,

TAX_IDENTIFICATION_NUMBER,

EAN_GLN,

BANK_BRANCH_CODE

payeeReference.involvedParty.organisationIdentification.identificationNo

string

Identification number.

Example:

"12345"

Example:

{
  "identificationNo": "12345",
  "type": "LEI"
}

payeeReference.involvedParty.partyName

string

Name of the payer account.

Example:

"David"

payeeReference.involvedParty.address

Address. · object

Show child attributes

payeeReference.involvedParty.address.type

enum<string>

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

payeeReference.involvedParty.address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

payeeReference.involvedParty.address.department

string

Identification of a division of a large organization or building.

Example:

"Department of Education"

payeeReference.involvedParty.address.subDepartment

string

Identification of a sub-division of a large organization or building.

Example:

"Institute of Education Sciences"

payeeReference.involvedParty.address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Example:

"John Smith 123 Main Street, Apt 4B Anytown, CA 12345"

payeeReference.involvedParty.address.buildingNumber

string

Number that identifies the position of a building on a street.

Example:

"123"

payeeReference.involvedParty.address.streetName

string

Name of a street or thoroughfare.

Example:

"Main Street"

payeeReference.involvedParty.address.townName

string

Name of a built-up area, with defined boundaries, and a local government.

Example:

"Anytown"

payeeReference.involvedParty.address.postalCode

string

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example:

"12345"

payeeReference.involvedParty.address.countrySubDivision

string

Identifies name of a country subdivision such as state, region, county.

Example:

"CA"

payeeReference.involvedParty.address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"US"

Example:

{
  "country": "US",
  "streetName": "Main Street",
  "townName": "Anytown",
  "countrySubDivision": "CA",
  "postalCode": "12345",
  "buildingNumber": "123",
  "subDepartment": "Institute of Education Sciences",
  "type": "POSTAL",
  "department": "Department of Education",
  "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
  "primary": true
}

payeeReference.involvedParty.reference

string

Reference of the payer account.

Example:

"Ref-1"

Example:

{
  "reference": "Ref-1",
  "address": {
    "country": "US",
    "streetName": "Main Street",
    "townName": "Anytown",
    "countrySubDivision": "CA",
    "postalCode": "12345",
    "buildingNumber": "123",
    "subDepartment": "Institute of Education Sciences",
    "type": "POSTAL",
    "department": "Department of Education",
    "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
    "primary": true
  },
  "organisationIdentification": {
    "identificationNo": "12345",
    "type": "LEI"
  },
  "partyName": "David",
  "partyType": "PERSON",
  "partyInvolvementType": "DEBTOR",
  "personIdentifications": [
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    },
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    }
  ]
}

Example:

{
  "involvedParty": {
    "reference": "Ref-1",
    "address": {
      "country": "US",
      "streetName": "Main Street",
      "townName": "Anytown",
      "countrySubDivision": "CA",
      "postalCode": "12345",
      "buildingNumber": "123",
      "subDepartment": "Institute of Education Sciences",
      "type": "POSTAL",
      "department": "Department of Education",
      "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
      "primary": true
    },
    "organisationIdentification": {
      "identificationNo": "12345",
      "type": "LEI"
    },
    "partyName": "David",
    "partyType": "PERSON",
    "partyInvolvementType": "DEBTOR",
    "personIdentifications": [
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      },
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      }
    ]
  }
}

payeeBankReference

Payeee bank reference. · object

Show child attributes

payeeBankReference.involvedParty

involved Party · object

Show child attributes

payeeBankReference.involvedParty.partyInvolvementType

enum<string>

Role played by a party in the context of a payment.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT,

ULTIMATE_DEBTOR,

ULTIMATE_CREDITOR,

INITIATOR,

INTERMEDIARY_AGENT,

CORRESPONDEBT_AGNET

payeeBankReference.involvedParty.partyType

enum<string>

Unique and unambiguous way to identify a party.

Available options:

PERSON,

ORGANISATION

payeeBankReference.involvedParty.personIdentifications

Identification to support Know Your Customer (KYC) processes. · object[]

Identification to support Know Your Customer (KYC) processes.

Show child attributes

payeeBankReference.involvedParty.personIdentifications.type

enum<string>

Type of the person identifications.

Available options:

ALIEN_REGISTRATION_NUMBER,

CUSTOMER_IDENTIFICATION_NUMBER,

EMPLOYEE_IDENTIFICATION_NUMBER,

NATIONAL_IDENTITY_NUMBER,

TAX_IDENTIFICATION_NUMBER,

SOCIAL_SECURITY_NUMBER,

DRIVERS_LICENSE_NUMBER,

PASSPORT_NUMBER,

IDENTITY_CARD_NUMBER,

EMPLOYER_IDENTIFICATION_NUMBER

payeeBankReference.involvedParty.personIdentifications.id

string

Unique identifier of person identification.

Example:

"123456789"

payeeBankReference.involvedParty.organisationIdentification

Organization identification. · object

Show child attributes

payeeBankReference.involvedParty.organisationIdentification.type

enum<string>

type

Available options:

LEI,

ELF,

MICX,

BICFI,

DUNS,

BANK_PARTY_IDENTIFICATION,

CENTRAL_BANK_IDENTIFICATION_NUMBER,

CLEARING_IDENTIFICATION_NUMBER,

CERTIFICATE_OF_INCORPORATION_NUMBER,

COUNTRY_IDENTIFICATION_CODE,

CUSTOMER_NUMBER,

DATA_UNIVERSAL_NUMBERING_SYSTEM,

EMPLOYER_IDENTIFICATION_NUMBER,

GS1_GLN_IDENTIFIER,

SIREN,

SIRET,

TAX_IDENTIFICATION_NUMBER,

EAN_GLN,

BANK_BRANCH_CODE

payeeBankReference.involvedParty.organisationIdentification.identificationNo

string

Identification number.

Example:

"12345"

Example:

{
  "identificationNo": "12345",
  "type": "LEI"
}

payeeBankReference.involvedParty.partyName

string

Name of the payer account.

Example:

"David"

payeeBankReference.involvedParty.address

Address. · object

Show child attributes

payeeBankReference.involvedParty.address.type

enum<string>

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

payeeBankReference.involvedParty.address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

payeeBankReference.involvedParty.address.department

string

Identification of a division of a large organization or building.

Example:

"Department of Education"

payeeBankReference.involvedParty.address.subDepartment

string

Identification of a sub-division of a large organization or building.

Example:

"Institute of Education Sciences"

payeeBankReference.involvedParty.address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Example:

"John Smith 123 Main Street, Apt 4B Anytown, CA 12345"

payeeBankReference.involvedParty.address.buildingNumber

string

Number that identifies the position of a building on a street.

Example:

"123"

payeeBankReference.involvedParty.address.streetName

string

Name of a street or thoroughfare.

Example:

"Main Street"

payeeBankReference.involvedParty.address.townName

string

Name of a built-up area, with defined boundaries, and a local government.

Example:

"Anytown"

payeeBankReference.involvedParty.address.postalCode

string

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example:

"12345"

payeeBankReference.involvedParty.address.countrySubDivision

string

Identifies name of a country subdivision such as state, region, county.

Example:

"CA"

payeeBankReference.involvedParty.address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"US"

Example:

{
  "country": "US",
  "streetName": "Main Street",
  "townName": "Anytown",
  "countrySubDivision": "CA",
  "postalCode": "12345",
  "buildingNumber": "123",
  "subDepartment": "Institute of Education Sciences",
  "type": "POSTAL",
  "department": "Department of Education",
  "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
  "primary": true
}

payeeBankReference.involvedParty.reference

string

Reference of the payer account.

Example:

"Ref-1"

Example:

{
  "reference": "Ref-1",
  "address": {
    "country": "US",
    "streetName": "Main Street",
    "townName": "Anytown",
    "countrySubDivision": "CA",
    "postalCode": "12345",
    "buildingNumber": "123",
    "subDepartment": "Institute of Education Sciences",
    "type": "POSTAL",
    "department": "Department of Education",
    "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
    "primary": true
  },
  "organisationIdentification": {
    "identificationNo": "12345",
    "type": "LEI"
  },
  "partyName": "David",
  "partyType": "PERSON",
  "partyInvolvementType": "DEBTOR",
  "personIdentifications": [
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    },
    {
      "id": "123456789",
      "type": "ALIEN_REGISTRATION_NUMBER"
    }
  ]
}

Example:

{
  "involvedParty": {
    "reference": "Ref-1",
    "address": {
      "country": "US",
      "streetName": "Main Street",
      "townName": "Anytown",
      "countrySubDivision": "CA",
      "postalCode": "12345",
      "buildingNumber": "123",
      "subDepartment": "Institute of Education Sciences",
      "type": "POSTAL",
      "department": "Department of Education",
      "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
      "primary": true
    },
    "organisationIdentification": {
      "identificationNo": "12345",
      "type": "LEI"
    },
    "partyName": "David",
    "partyType": "PERSON",
    "partyInvolvementType": "DEBTOR",
    "personIdentifications": [
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      },
      {
        "id": "123456789",
        "type": "ALIEN_REGISTRATION_NUMBER"
      }
    ]
  }
}

payeeAccountReference

Payee account reference. · object

Show child attributes

payeeAccountReference.paymentInstructionAccount

Payment instruction account. · object

Show child attributes

payeeAccountReference.paymentInstructionAccount.accountId

string

required

Identification of the payer's account.

Example:

"12232"

payeeAccountReference.paymentInstructionAccount.involvedAccountType

enum<string>

Type of the account.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT

payeeAccountReference.paymentInstructionAccount.numberType

string

Describes the type of data held in the account identifier field.

Example:

"IBAN"

payeeAccountReference.paymentInstructionAccount.accountType

enum<string>

Type of the payment instruction account.

Available options:

LOAN,

DEPOSIT

payeeAccountReference.paymentInstructionAccount.accountSubType

enum<string>

Sub-type of the payment instruction account.

Available options:

CURRENT_ACCOUNT,

FIXED_DEPOSIT,

SAVINGS_PLAN,

DEBIT_ACCOUNT,

CREDIT_ACCOUNT,

PAYMENT_ACCOUNT,

SETTLEMENT_ACCOUNT,

SAVINGS_ACCOUNT

Example:

{
  "accountId": "12232",
  "numberType": "IBAN",
  "accountSubType": "CURRENT_ACCOUNT",
  "accountType": "LOAN",
  "involvedAccountType": "DEBTOR"
}

Example:

{
  "paymentInstructionAccount": {
    "accountId": "12232",
    "numberType": "IBAN",
    "accountSubType": "CURRENT_ACCOUNT",
    "accountType": "LOAN",
    "involvedAccountType": "DEBTOR"
  }
}

paymentInstruction

Payment instruction. · object

Show child attributes

paymentInstruction.amount

Amount. · object

The amount in the specified currency.

Show child attributes

paymentInstruction.amount.instructedAmount

number

required

The value of the amount being transferred in the currency specified. The value has to be positive.

Example:

10.25

paymentInstruction.amount.amountType

enum<string>

The type of payment amount.

Available options:

PRINCIPAL,

ACTUAL,

ESTIMATED,

MAXIMUM,

DEFAULT,

REPLACEMENT,

INCREMENTAL,

DECREMENTAL,

RESERVED,

AVAILABLE,

USED

paymentInstruction.amount.instructedCurrency

string

The number of fractional digits (or minor unit of currency). It must comply with ISO 4217.

Example:

"2"

paymentInstruction.amount.transferCurrency

string

Specifies the currency of the transferred amount, which is different from the currency of the debtor's account.

Example:

"USD"

paymentInstruction.amount.transferAmount

number<float>

The value of the amount being transferred in the currency specified. The value has to be positive.

Example:

100.25

Example:

{
  "amountType": "PRINCIPAL",
  "instructedCurrency": "2",
  "transferCurrency": "USD",
  "transferAmount": 100.25,
  "instructedAmount": 10.25
}

paymentInstruction.appliedFee

Fees applied. · object[]

Show child attributes

paymentInstruction.appliedFee.type

string

Type of fee.

Example:

"InterchangeFee"

paymentInstruction.appliedFee.amount

number

Indicates the amount of the applied fee.

Example:

10.12

paymentInstruction.appliedFee.currency

string

The three-letter currency code in the ISO4217 format.

Example:

"USD"

paymentInstruction.instructionNextAgent

string

Instruction to pay an amount of money to an ultimate beneficiary, on behalf of an originator.

paymentInstruction.directionType

enum<string>

A classification of an instance of a payment instruction as an inbound or outbound payment.

Available options:

INBOUND,

OUTBOUND

paymentInstruction.instructionType

enum<string>

Classification of a payment instruction according to the arrangement type that made it possible.

Available options:

CSH,

DPS,

DPH,

DPP,

CBS,

CBP,

CBH,

TCS,

TCH,

TCP,

COR,

FEX,

EQA,

LOA,

LOR,

SEC,

LBX,

DIV,

CSQ,

OCQ,

ODC,

CCQ,

TCK,

BKD,

CLR,

DCR,

BOE,

COL,

CMT,

CSW,

CTO,

CZB,

STF,

PAY,

PRI,

STD,

LIQ,

ADV,

VDA,

DPG,

DPN,

NET,

LMT,

BCK,

EXP,

CTR,

CLS,

EUP,

AGT,

AMY,

BAL,

BON,

BRF,

CBF,

CHR,

BEC,

COC,

COM,

CDT,

COS,

CPY,

GVT,

IHP,

INS,

INC,

INT,

LCF,

MET,

PEN,

GDS,

REF,

REN,

ROY,

SCV,

SAL,

SSB,

STO,

SBS,

TRP,

BEN,

VAT,

WHT,

TAX,

MSC,

OND,

MGL,

OTHR,

UFRO,

UWIN,

PEXH

paymentInstruction.requestedMechanism

string

The payment system requested to be used in a payment instruction.

Example:

"ACH Payment"

paymentInstruction.paymentDates

Payment dates. · object

Show child attributes

paymentInstruction.paymentDates.requestedExecutionDate

string<date-time>

Date when the transaction is scheduled to be executed.

paymentInstruction.paymentDates.acceptanceDate

string<date-time>

Date when the instruction is accepted by the bank or payment processor.

paymentInstruction.paymentDates.deliveryDate

string<date-time>

Date when the instruction is created or delivered to bank or payment processor.

paymentInstruction.paymentDates.valueDate

string<date-time>

Actual value date of the instruction.

paymentInstruction.paymentDates.expiryDate

string<date-time>

Expiry date of the payment instruction.

Example:

{
  "acceptanceDate": "2000-01-23T04:56:07.000Z",
  "expiryDate": "2000-01-23T04:56:07.000Z",
  "requestedExecutionDate": "2000-01-23T04:56:07.000Z",
  "valueDate": "2000-01-23T04:56:07.000Z",
  "deliveryDate": "2000-01-23T04:56:07.000Z"
}

paymentInstruction.processingValidityTime

Date Time · object

Show child attributes

paymentInstruction.processingValidityTime.startDateTime

string<date-time>

Indicates the start date and time.

paymentInstruction.processingValidityTime.endDateTime

string<date-time>

Indicates the end date and time.

Example:

{
  "startDateTime": "2000-01-23T04:56:07.000Z",
  "endDateTime": "2000-01-23T04:56:07.000Z"
}

paymentInstruction.chargeBearer

enum<string>

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Available options:

DEBT,

CRED,

SHAR,

SLEV

paymentInstruction.exchangeRate

Exchange Rate · object

Show child attributes

paymentInstruction.exchangeRate.currency

string

Currency in which the rate of exchange is expressed in a currency exchange.

Example:

"GBP"

paymentInstruction.exchangeRate.rate

number

The factor used for conversion of an amount from one currency to another.

Example:

1.23

paymentInstruction.exchangeRate.rateType

enum<string>

Specifies the type used to complete the currency exchange.

Available options:

ACTUAL,

INDICATIVE,

AGREED

Example:

{
  "rateType": "ACTUAL",
  "rate": 1.23,
  "currency": "GBP"
}

paymentInstruction.priority

enum<string>

Available options:

NORM,

HIGH

paymentInstruction.clearingChannel

enum<string>

Specifies the clearing channel to be used to process the payment instruction.

Available options:

RTGS,

RTNS,

MPNS,

BOOK

paymentInstruction.creditDebtIndicator

enum<string>

Indicates the payment is a debit or a credit.

Available options:

CREDIT,

DEBIT

paymentInstruction.schedule

Schedule · object

Show child attributes

paymentInstruction.schedule.startDate

string<date>

When to start executing the schedule. First transfer will be executed on first calculated date by schedule after this date.

paymentInstruction.schedule.frequency

enum<string>

Denotes how frequently the transfer should be made.

Available options:

ONCE,

DAILY,

WEEKLY,

BIWEEKLY,

MONTHLY,

QUARTERLY,

YEARLY

paymentInstruction.schedule.endDate

string<date>

When to stop transfers. Transfers will not be executed after this date. Only one of endDate and repeat is possible.

paymentInstruction.schedule.noOfRepetition

integer

Number of transfer to be executed.

paymentInstruction.schedule.executeOn

string<date>

Denotes day on which transfer should be executed.

paymentInstruction.schedule.skipInterval

enum<integer>

Indicates skip interval of transfer. 1 would mean execute every time, 2 - every other time.

Available options:

1,

2

Example:

{
  "endDate": "2000-01-23T00:00:00.000Z",
  "noOfRepetition": 0,
  "skipInterval": 6,
  "executeOn": "2000-01-23T00:00:00.000Z",
  "startDate": "2000-01-23T00:00:00.000Z",
  "frequency": "ONCE"
}

Example:

{
  "chargeBearer": "DEBT",
  "amount": {
    "amountType": "PRINCIPAL",
    "instructedCurrency": "2",
    "transferCurrency": "USD",
    "transferAmount": 100.25,
    "instructedAmount": 10.25
  },
  "paymentDates": {
    "acceptanceDate": "2000-01-23T04:56:07.000Z",
    "expiryDate": "2000-01-23T04:56:07.000Z",
    "requestedExecutionDate": "2000-01-23T04:56:07.000Z",
    "valueDate": "2000-01-23T04:56:07.000Z",
    "deliveryDate": "2000-01-23T04:56:07.000Z"
  },
  "instructionNextAgent": "instructionNextAgent",
  "clearingChannel": "RTGS",
  "requestedMechanism": "ACH Payment",
  "processingValidityTime": {
    "startDateTime": "2000-01-23T04:56:07.000Z",
    "endDateTime": "2000-01-23T04:56:07.000Z"
  },
  "priority": "NORM",
  "schedule": {
    "endDate": "2000-01-23T00:00:00.000Z",
    "noOfRepetition": 0,
    "skipInterval": 6,
    "executeOn": "2000-01-23T00:00:00.000Z",
    "startDate": "2000-01-23T00:00:00.000Z",
    "frequency": "ONCE"
  },
  "creditDebtIndicator": "CREDIT",
  "directionType": "INBOUND",
  "instructionType": "CSH",
  "exchangeRate": {
    "rateType": "ACTUAL",
    "rate": 1.23,
    "currency": "GBP"
  },
  "appliedFee": [
    {
      "amount": 10.12,
      "currency": "USD",
      "type": "InterchangeFee"
    },
    {
      "amount": 10.12,
      "currency": "USD",
      "type": "InterchangeFee"
    }
  ]
}

paymentProcessingConfiguration

Payment processing configuration. · object

Show child attributes

paymentProcessingConfiguration.paymentArrangement

Payment arrangment. · object

Show child attributes

paymentProcessingConfiguration.paymentArrangement.serviceType

enum<string>

Specifies the type of the payment service.

Available options:

CREDIT_TRANSFER_SERVICE,

STANDING_ORDER_SERVICE,

DIRECT_DEBIT_SERVICE,

CARD_PAYMENT_SERVICE,

WITHDRAW_SERVICE,

DEPOSIT_SERVICE,

OVERDRAFT_SERVICE,

MONEY_REMITTANCE_SERVICE,

STATEMENT_SERVICE

paymentProcessingConfiguration.paymentArrangement.paymentType

enum<string>

The type or nature of the payment.

Available options:

CSH,

DPS,

DPH,

DPP,

CBS,

CBP,

CBH,

TCS,

TCH,

TCP,

COR,

FEX,

EQA,

LOA,

LOR,

SEC,

LBX,

DIV,

CSQ,

OCQ,

ODC,

CCQ,

TCK,

BKD,

CLR,

DCR,

BOE,

COL,

CMT,

CSW,

CTO,

CZB,

STF,

PAY,

PRI,

STD,

LIQ,

ADV,

VDA,

DPG,

DPN,

NET,

LMT,

BCK,

EXP,

CTR,

CLS,

EUP,

AGT,

AMY,

BAL,

BON,

BRF,

CBF,

CHR,

BEC,

COC,

COM,

CDT,

COS,

CPY,

GVT,

IHP,

INS,

INC,

INT,

LCF,

MET,

PEN,

GDS,

REF,

REN,

ROY,

SCV,

SAL,

SSB,

STO,

SBS,

TRP,

BEN,

VAT,

WHT,

TAX,

MSC,

OND,

MGL,

OTHR,

UFRO,

UWIN,

PEXH

paymentProcessingConfiguration.paymentArrangement.paymentMethod

enum<string>

Specifies the means of payment that will be used to move the amount. of money

Available options:

CHK,

TRF,

DD,

TRA,

DIRE,

CLAS

paymentProcessingConfiguration.paymentArrangement.categoryPurpose

enum<string>

Specifies the type of transaction that resulted in the payment.

Available options:

INTC,

CORT,

SALA,

TREA,

CASH,

DIVI,

GOVT,

INTE,

LOAN,

PENS,

SECU,

SSBE,

TAXS,

VATX,

SUPP,

HEDG,

TRAD,

WHLD

paymentProcessingConfiguration.paymentArrangement.purpose

string

The text input provided as purpose of payment.

paymentProcessingConfiguration.paymentArrangement.paymentSeq

enum<string>

Specifies the type of the current transaction that belongs to a sequence of transactions.

Available options:

FIRST,

RECURRING,

FINAL,

ONEOFF,

REPRESENTED

Example:

{
  "serviceType": "CREDIT_TRANSFER_SERVICE",
  "categoryPurpose": "INTC",
  "purpose": "purpose",
  "paymentMethod": "CHK",
  "paymentSeq": "FIRST",
  "paymentType": "CSH"
}

paymentProcessingConfiguration.remittanceInfo

Remittance information. · object

Show child attributes

paymentProcessingConfiguration.remittanceInfo.type

enum<string>

Available options:

STRUCTURED,

UNSTRUCTURED

paymentProcessingConfiguration.remittanceInfo.content

string

The content of the remittance information.

Example:

"Payment Amount - $500.00"

Example:

{
  "type": "STRUCTURED",
  "content": "Payment Amount - $500.00"
}

paymentProcessingConfiguration.localInstrument

enum<string>

User community specific instrument.

Available options:

DIRECT_DEBIT_CONFIRMED_ELECTRONIC_MANDATE,

DIRECT_DEBIT_PAPER_MANDATE_WITH_PAPER_AUTHORIZATION,

DIRECT_DEBIT_UNCONFIRMED_ELECTRONIC_MANDATE,

BATCH_PAYMENTS_ARUBA,

INSTANT_PAYMENTS_ARUBA,

CREDIT_TRANSFERS,

NON_PRE_AUTHORISED_DIRECT_DEBIT_AT,

PRE_AUTHORISED_DIRECT_DEBIT_AT,

CASH_PER_POST,

RETURNED_CREDIT_TRANSFERS,

TRUNCATED_CREDIT_TRANSFERS,

DIRECT_DEBITS,

RETURNED_DIRECT_DEBITS,

TRUNCATED_CHECKS,

REVOKED_CREDIT_TRANSFERS,

REVOKED_DIRECT_DEBITS,

REVOKED_RETURNED_CREDIT_TRANSFERS,

REVOKED_RETURNED_DIRECT_DEBITS,

REVOKED_TRUNCATED_CHECKS,

REVOKED_TRUNCATED_CREDIT_TRANSFERS,

CARD_CLEARING,

NON_PRE_AUTHORISED_DIRECT_DEBIT_DE,

PRE_AUTHORISED_DIRECT_DEBIT_DE,

IMAGE_BASED_CHEQUE_COLLECTION,

PAPERLESS_CHEQUE_COLLECTION,

BUSINESS_TO_BUSINESS_DIRECT_DEBIT,

BUSINESS_TO_CUSTOMER_DIRECT_DEBIT,

ANCILLARY_SYSTEM_TRANSFER_INITIATION,

BACKUP_PAYMENT,

MANDATED_PAYMENT,

SETTLEMENT_BANK_TRANSFER_INITIATION,

PRE_AUTHORISED_DIRECT_DEBIT_ACCELERATED_CLEARING_2_DAY_ORDINAIRE_NORMAL_CLEARING_4_DAY,

PRE_AUTHORISED_DIRECT_DEBIT_ORDINAIRE_NORMAL_CLEARING_4_DAY,

PRE_AUTHORISED_DIRECT_DEBIT_VERIFIED_CLEARING,

RECOVERED_BILL_OF_EXCHANGE_OR_PROMISSORY_NOTE,

NON_PRE_AUTHORISED_DIRECT_DEBIT_RIBA,

PRE_AUTHORISED_REVOCABLE_DIRECT_DEBIT,

PRE_AUTHORISED_REVOCABLE_URGENT_DIRECT_DEBIT,

PAYMENTS_VIA_INTERNET_OWNED_BY_CURRENCE,

INSTANT_CREDIT_TRANSFER_NOT_TIME_CRITICAL,

INSTANT_CREDIT_TRANSFER_TIME_CRITICAL,

PAYMENTS_VIA_INTERNET_OWNED_BY_CURRENCE_USING_INSTANT_CREDIT_TRANSFER,

PAYMENTS_VIA_INTERNET_OWNED_BY_CURRENCE_USING_INSTANT_CREDIT_TRANSFER_NOT_TIME_CRITICAL,

PAYMENTS_VIA_INTERNET_OWNED_BY_CURRENCE_USING_INSTANT_CREDIT_TRANSFER_TIME_CRITICAL,

DUTCH_DOMESTIC_BULK_PAYMENT,

DUTCH_URGENT_PAYMENT,

PAYMENT_VIA_ACCEPTGIRO_OWNED_BY_CURRENCE,

PAYMENTS_VIA_STANDAARD_DIGITALE_NOTA,

INCIDENT_MANAGEMENT_CORRECTION,

DIRECT_DEBIT_INITIATED_BY_THE_GOVERNMENT_WITH_SPECIAL_CONDITIONS,

MASS_PAYMENT_BENEFICIARY,

MASS_PAYMENT_OURS,

MASS_PAYMENT_SHARED,

STANDING_ORDER,

ONE_OFF_AUTHORISATION,

ONE_OFF_AUTHORISATION_CHARITIES,

ONE_OFF_AUTHORISATION_CONSTRUCTION_INDUSTRY,

ONE_OFF_AUTHORISATION_TUITION_FEES,

STANDING_AUTHORISATION_COMPANIES,

STANDING_AUTHORISATION_COMPANIES_WITHOUT_DEBTOR_REVOCATION_RIGHT,

STANDING_AUTHORISATION_GENERAL,

STANDING_AUTHORISATION_LOTTERIES,

CONVERTED_BANK_PAYMENT,

BUSINESS_PAYMENT,

CROSS_BORDER_CUSTOMER_CREDIT_TRANSFER,

OVERNIGHT,

PAYMENT_WITH_IRI,

SAME_DAY,

CORE_NO_REFUND,

DIRECT_DEBIT_FIXED_AMOUNT,

SEPA_DIRECT_DEBIT_CORE,

SEPA_B2B_DIRECT_DEBIT_AMI,

SEPA_BUSINESS_TO_BUSINESS_DIRECT_DEBIT,

SEPA_CORE_D1_DIRECT_DEBIT_AMI,

SEPA_CORE_DIRECT_DEBIT_AMI,

SEPA_DIRECT_DEBIT_1_DAY_SETTLEMENT,

SEPA_FA_DIRECT_DEBIT_AMI,

INSTANT_CREDIT_TRANSFER,

AUTHENTICATED_DIRECT_DEBIT,

UNAUTHENTICATED_DIRECT_DEBIT,

CASH_CONCENTRATION_INTRAGROUP,

BANK_TRANSFER,

CHECK_SAME_DAY_SETTLEMENT_WIRE,

CUSTOMER_TRANSFER,

CUSTOMER_TRANSFER_PLUS,

DEPOSIT_TO_SENDERS_ACCOUNT,

FED_FUNDS_RETURNED,

FED_FUNDS_SOLD,

NON_VALUE_SERVICE_MESSAGE,

DRAWDOWN_RESPONSE_VALUE_TO_HONOR_A_DRAWDOWN_REQUEST,

BANK_TO_BANK_DRAWDOWN_REQUEST_OR_RESPONSE_NON_VALUE,

CUSTOMER_OR_CORPORATE_DRAWDOWN_REQUEST_OR_RESPONSE_NON_VALUE,

INTERNATIONAL_ACH,

CASH_CONCENTRATION_OR_DISBURSEMENT_CORPORATE_COUNTERPARTY,

CORPORATE_TRADE_EXCHANGE,

PREARRANGED_PAYMENT_OR_DEPOSIT_CONSUMER_COUNTERPARTY,

CUSTOMER_INITIATED_ENTRY,

REPRESENTED_CHECK_ENTRY,

ACCOUNTS_RECEIVABLE_CHECK,

INTERNET_INITIATED_ENTRY,

POINT_OF_PURCHASE,

POINT_OF_SALE,

TELEPHONE_INITIATED_ENTRY

Example:

{
  "localInstrument": "DIRECT_DEBIT_CONFIRMED_ELECTRONIC_MANDATE",
  "paymentArrangement": {
    "serviceType": "CREDIT_TRANSFER_SERVICE",
    "categoryPurpose": "INTC",
    "purpose": "purpose",
    "paymentMethod": "CHK",
    "paymentSeq": "FIRST",
    "paymentType": "CSH"
  },
  "remittanceInfo": {
    "type": "STRUCTURED",
    "content": "Payment Amount - $500.00"
  }
}

interestedParties

involved Party · object[]

Show child attributes

interestedParties.partyInvolvementType

enum<string>

Role played by a party in the context of a payment.

Available options:

DEBTOR,

CREDITOR,

DEBTOR_AGENT,

CREDITOR_AGENT,

ULTIMATE_DEBTOR,

ULTIMATE_CREDITOR,

INITIATOR,

INTERMEDIARY_AGENT,

CORRESPONDEBT_AGNET

interestedParties.partyType

enum<string>

Unique and unambiguous way to identify a party.

Available options:

PERSON,

ORGANISATION

interestedParties.personIdentifications

Identification to support Know Your Customer (KYC) processes. · object[]

Identification to support Know Your Customer (KYC) processes.

Show child attributes

interestedParties.personIdentifications.type

enum<string>

Type of the person identifications.

Available options:

ALIEN_REGISTRATION_NUMBER,

CUSTOMER_IDENTIFICATION_NUMBER,

EMPLOYEE_IDENTIFICATION_NUMBER,

NATIONAL_IDENTITY_NUMBER,

TAX_IDENTIFICATION_NUMBER,

SOCIAL_SECURITY_NUMBER,

DRIVERS_LICENSE_NUMBER,

PASSPORT_NUMBER,

IDENTITY_CARD_NUMBER,

EMPLOYER_IDENTIFICATION_NUMBER

interestedParties.personIdentifications.id

string

Unique identifier of person identification.

Example:

"123456789"

interestedParties.organisationIdentification

Organization identification. · object

Show child attributes

interestedParties.organisationIdentification.type

enum<string>

type

Available options:

LEI,

ELF,

MICX,

BICFI,

DUNS,

BANK_PARTY_IDENTIFICATION,

CENTRAL_BANK_IDENTIFICATION_NUMBER,

CLEARING_IDENTIFICATION_NUMBER,

CERTIFICATE_OF_INCORPORATION_NUMBER,

COUNTRY_IDENTIFICATION_CODE,

CUSTOMER_NUMBER,

DATA_UNIVERSAL_NUMBERING_SYSTEM,

EMPLOYER_IDENTIFICATION_NUMBER,

GS1_GLN_IDENTIFIER,

SIREN,

SIRET,

TAX_IDENTIFICATION_NUMBER,

EAN_GLN,

BANK_BRANCH_CODE

interestedParties.organisationIdentification.identificationNo

string

Identification number.

Example:

"12345"

Example:

{
  "identificationNo": "12345",
  "type": "LEI"
}

interestedParties.partyName

string

Name of the payer account.

Example:

"David"

interestedParties.address

Address. · object

Show child attributes

interestedParties.address.type

enum<string>

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

interestedParties.address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

interestedParties.address.department

string

Identification of a division of a large organization or building.

Example:

"Department of Education"

interestedParties.address.subDepartment

string

Identification of a sub-division of a large organization or building.

Example:

"Institute of Education Sciences"

interestedParties.address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Example:

"John Smith 123 Main Street, Apt 4B Anytown, CA 12345"

interestedParties.address.buildingNumber

string

Number that identifies the position of a building on a street.

Example:

"123"

interestedParties.address.streetName

string

Name of a street or thoroughfare.

Example:

"Main Street"

interestedParties.address.townName

string

Name of a built-up area, with defined boundaries, and a local government.

Example:

"Anytown"

interestedParties.address.postalCode

string

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example:

"12345"

interestedParties.address.countrySubDivision

string

Identifies name of a country subdivision such as state, region, county.

Example:

"CA"

interestedParties.address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"US"

Example:

{
  "country": "US",
  "streetName": "Main Street",
  "townName": "Anytown",
  "countrySubDivision": "CA",
  "postalCode": "12345",
  "buildingNumber": "123",
  "subDepartment": "Institute of Education Sciences",
  "type": "POSTAL",
  "department": "Department of Education",
  "addressLine": "John Smith 123 Main Street, Apt 4B Anytown, CA 12345",
  "primary": true
}

interestedParties.reference

string

Reference of the payer account.

Example:

"Ref-1"

customFields

CustomField · object

Custom fields related to payments.

Show child attributes

customFields.{key}

object

Payment APIs V2

Fraud APIs V1

Headers

Body

Response