Post paymentsfetch fees

Headers

Idempotent-Request-Key

string

Idempotent Request Key.

Timestamp

string<date-time>

Timestamp.

Used-Mechanism

string

Type of the payment.

Body

application/json

identification

string

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

Example:

"123456"

usedMechanism

string

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

Example:

"US_DOMESTIC_WIRE_RET"

businessFunction

string

The payment type business function

Example:

"CCD"

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

priority

enum<string>

Available options:

NORM,

HIGH

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

amount

Amount. · object

The amount in the specified currency.

Show child attributes

amount.instructedAmount

number

required

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

Example:

10.25

amount.amountType

enum<string>

The type of payment amount.

Available options:

PRINCIPAL,

ACTUAL,

ESTIMATED,

MAXIMUM,

DEFAULT,

REPLACEMENT,

INCREMENTAL,

DECREMENTAL,

RESERVED,

AVAILABLE,

USED

amount.instructedCurrency

string

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

Example:

"2"

amount.transferCurrency

string

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

Example:

"USD"

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
}

appliedFee

Fees applied. · object[]

Show child attributes

appliedFee.type

string

Type of fee.

Example:

"InterchangeFee"

appliedFee.amount

number

Indicates the amount of the applied fee.

Example:

10.12

appliedFee.currency

string

The three-letter currency code in the ISO4217 format.

Example:

"USD"

dates

Transaction date. · object[]

Show child attributes

dates.dateType

enum<string>

Key dates associated with the transaction.

Available options:

REQUESTED_EXECUTION_DATE,

ACCEPTANCE_DATE,

CREATION_DATE,

VALUE_DATE,

DUE_DATE,

EXPIRY_DATE

dates.dateTime

string<date-time>

Indicates the date and time.

customFields

CustomField · object

Custom fields related to payments.

Show child attributes

customFields.{key}

object

Response

Created.

identification

string

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

Example:

"123456"

usedMechanism

string

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

Example:

"US_DOMESTIC_WIRE_RET"

businessFunction

string

The payment type business function

Example:

"CCD"

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

priority

enum<string>

Available options:

NORM,

HIGH

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

amount

Amount. · object

The amount in the specified currency.

Show child attributes

amount.instructedAmount

number

required

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

Example:

10.25

amount.amountType

enum<string>

The type of payment amount.

Available options:

PRINCIPAL,

ACTUAL,

ESTIMATED,

MAXIMUM,

DEFAULT,

REPLACEMENT,

INCREMENTAL,

DECREMENTAL,

RESERVED,

AVAILABLE,

USED

amount.instructedCurrency

string

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

Example:

"2"

amount.transferCurrency

string

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

Example:

"USD"

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
}

appliedFee

Fees applied. · object[]

Show child attributes

appliedFee.type

string

Type of fee.

Example:

"InterchangeFee"

appliedFee.amount

number

Indicates the amount of the applied fee.

Example:

10.12

appliedFee.currency

string

The three-letter currency code in the ISO4217 format.

Example:

"USD"

dates

Transaction date. · object[]

Show child attributes

dates.dateType

enum<string>

Key dates associated with the transaction.

Available options:

REQUESTED_EXECUTION_DATE,

ACCEPTANCE_DATE,

CREATION_DATE,

VALUE_DATE,

DUE_DATE,

EXPIRY_DATE

dates.dateTime

string<date-time>

Indicates the date and time.

customFields

CustomField · object

Custom fields related to payments.

Show child attributes

customFields.{key}

object

Payment APIs V2

Fraud APIs V1

Headers

Body

Response