Skip to content

account_id

Provides information about the account to be used for sending and/or receiving the payment.

  • Is optional
  • Type: object

With the following properties:

PropertyTypeRequiredDescription
IBANStringOptionalHolds the IBAN for the account. Defined in #/definitions/iban
OthrObjectOptionalHolds the alternative account identifier details.

Othr

Holds the alternative account identifier details.

With the following properties:

PropertyTypeRequiredDescription
IdStringOptionalIdentification assigned by an institution. Maximum Length: 34 characters
SchmeNmObjectOptionalName of the account identification scheme.
IssrStringOptionalEntity that assigns the identification. Maximum Length 35 characters

SchmeNm

Name of the account identification scheme.

With the following properties:

PropertyTypeRequiredDescription
CdStringOptionalType of account number, list based on a combination of ExternalAccountIdentification1Code and AccountIdentification30Choice ISO 20022 Lists 27-Aug-2021. Defined in #/definitions/external_account_id
PrtryStringOptionalField to support proprietary value. Maximum Length 35 characters

JSON schema extract

"account_id": {
	"type": "object",
	"description": "Specifies the unique identification of an account as assigned by the account servicer.",
	"properties": {
	    "IBAN": {
	        "$ref": "#/definitions/iban"
	    },
	    "Othr": {
	        "type": "object",
	        "properties": {
	            "Id": {
	                "description": "Identification assigned by an institution.",
	                "type": "string",
	                "maxLength": 34
	            },
	            "SchmeNm": {
	                "type": "object",
	                "description": "Name of the account identification scheme.",
	                "properties": {
	                    "Cd": {
	                        "$ref": "#/definitions/external_account_id"
	                    },
	                    "Prtry": {
	                        "type": "string",
	                        "description": "Field to support proprietary value",
	                        "maxLength": 35
	                    }
	                }
	            },
	            "Issr": {
	                "type": "string",
	                "description": "Entity that assigns the identification.",
	                "maxLength": 35
	            }
	        }
	    }
	}
}