| paymentRequest (required) | PaymentRequestResource body {
"resourceId (string)": "API: Identifier assigned by the ASPSP for further use of the created resource through API calls\n",
"paymentInformationId (string)": "ISO20022 : Reference assigned by a sending party to unambiguously identify the payment information block within the message.\n",
"creationDateTime (string)": "ISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party.\n",
"numberOfTransactions (integer)": "ISO20022: Number of individual transactions contained in the message.\nAPI: Each ASPSP will specify a maximum value for this field taking into accounts its specificities about payment request handling\n",
"initiatingParty": {
"name (string)": "ISO20022: Name by which a party is known and which is usually used to identify that party.\n",
"postalAddress": {
"country (string)": "ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n",
"addressLine (array)": "Unstructured address. The two lines must embed zip code and town name"
},
"organisationId": "Unique and unambiguous way to identify an organisation.",
"privateId": "Unique and unambiguous identification of a person."
},
"paymentTypeInformation": {
"instructionPriority (string)": "ISO20022: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n",
"serviceLevel (string)": "ISO20022: Agreement under which or rules under which the transaction should be processed. Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\nAPI: Only \"SEPA\" (SEPA Credit Transfer) or \"NURG\" (Other Credit Transfer) values are allowed\n",
"localInstrument (string)": "ISO20022: User community specific instrument. \nUsage: This element is used to specify a local instrument, local clearing option and\/or further qualify the service or service level.\nAPI: Only \"INST\" value is allowed in order to ask for an SEPA instant Payment. Can only be used if ServiceLevel is equal to \"SEPA\"\n",
"categoryPurpose (string)": "ISO20022: Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.\nAPI: The following values are allowed:\n - CASH (CashManagementTransfer): Transaction is a general cash management instruction.\n - DVPM (DeliverAgainstPayment): Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction. \n"
},
"debtor": {
"name (string)": "ISO20022: Name by which a party is known and which is usually used to identify that party.\n",
"postalAddress": {
"country (string)": "ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n",
"addressLine (array)": "Unstructured address. The two lines must embed zip code and town name"
},
"organisationId": "Unique and unambiguous way to identify an organisation.",
"privateId": "Unique and unambiguous identification of a person."
},
"debtorAccount": {
"iban (string)": "ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer. \n\nFurther specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n",
"other": {
"identification (string)": "API: Identifier\n",
"schemeName (string)": "Name of the identification scheme.\nPossible values for the scheme name, partially based on ISO20022 external code list, are the following: \n- BANK (BankPartyIdentification): Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. \n- COID (CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)\n- SREN (SIREN): The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.\n- SRET (SIRET): The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity.\n- NIDN (NationalIdentityNumber): Number assigned by an authority to identify the national identity number of a person.\nOther values are also permitted, for instance:\n- OAUT (OAUTH2): OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU\n- CPAN (CardPan): Card PAN\n",
"issuer (string)": "ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties\n"
}
},
"debtorAgent": {
"bicFi (string)": "ISO20022: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identification code (BIC)\".\n",
"clearingSystemMemberId": {
"clearingSystemId (string)": "ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
"memberId (string)": "ISO20022: Identification of a member of a clearing system.\n"
},
"name (string)": "Name of the financial institution",
"postalAddress": {
"country (string)": "ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n",
"addressLine (array)": "Unstructured address. The two lines must embed zip code and town name"
}
},
"beneficiary": {
"id (string)": "Id of the beneficiary",
"isTrusted (boolean)": "The ASPSP having not implemented the trusted beneficiaries list must not set this flag.\nOtherwise, the ASPSP indicates whether or not the beneficiary has been registered by the PSU within the trusted beneficiaries list.\n- true: the beneficiary is actually a trusted beneficiary (when set by ASPSP)\n- false: the beneficiary is not a trusted beneficiary \nThe PISP may set this flag to \"true\" to indicate that the PSU considers the beneficiary as trusted and to be inserted within the trusted beneficiaries list, as far as this feature was implemented by the ASPSP. \n- true: the beneficiary should be registered as a trusted beneficiary (when set by PISP)\n",
"creditorAgent": {
"bicFi (string)": "ISO20022: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identification code (BIC)\".\n",
"clearingSystemMemberId": {
"clearingSystemId (string)": "ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
"memberId (string)": "ISO20022: Identification of a member of a clearing system.\n"
},
"name (string)": "Name of the financial institution",
"postalAddress": {
"country (string)": "ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n",
"addressLine (array)": "Unstructured address. The two lines must embed zip code and town name"
}
},
"creditor": {
"name (string)": "ISO20022: Name by which a party is known and which is usually used to identify that party.\n",
"postalAddress": {
"country (string)": "ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n",
"addressLine (array)": "Unstructured address. The two lines must embed zip code and town name"
},
"organisationId": "Unique and unambiguous way to identify an organisation.",
"privateId": "Unique and unambiguous identification of a person."
},
"creditorAccount": {
"iban (string)": "ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer. \n\nFurther specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions.\n",
"other": {
"identification (string)": "API: Identifier\n",
"schemeName (string)": "Name of the identification scheme.\nPossible values for the scheme name, partially based on ISO20022 external code list, are the following: \n- BANK (BankPartyIdentification): Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. \n- COID (CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)\n- SREN (SIREN): The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.\n- SRET (SIRET): The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity.\n- NIDN (NationalIdentityNumber): Number assigned by an authority to identify the national identity number of a person.\nOther values are also permitted, for instance:\n- OAUT (OAUTH2): OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU\n- CPAN (CardPan): Card PAN\n",
"issuer (string)": "ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties\n"
}
}
},
"ultimateCreditor": {
"name (string)": "ISO20022: Name by which a party is known and which is usually used to identify that party.\n",
"postalAddress": {
"country (string)": "ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.\n",
"addressLine (array)": "Unstructured address. The two lines must embed zip code and town name"
},
"organisationId": "Unique and unambiguous way to identify an organisation.",
"privateId": "Unique and unambiguous identification of a person."
},
"purpose (string)": "ISO20022: Underlying reason for the payment transaction, as published in an external purpose code list. \nAPI: The following values are allowed for Payment Request\n - ACCT (Funds moved between 2 accounts of same account holder at the same bank) \n - CASH (general cash management instruction) may be used for Transfer Initiation\n - COMC Transaction is related to a payment of commercial credit or debit.\n - CPKC General Carpark Charges Transaction is related to carpark charges.\n - TRPT Transport RoadPricing Transaction is for the payment to top-up pre-paid card and electronic road pricing for the purpose of transportation\n",
"chargeBearer (string)": "ISO20022: Specifies which party\/parties will bear the charges associated with the processing of the payment transaction. \nAPI: The following values are allowed for Payment Request\n - SLEV: Charges are to be applied following the rules agreed in the service level and\/or scheme.\n",
"paymentInformationStatus (string)": "ISO20022: Specifies the status of the payment information.\nAPI: Mandatory. The following values are allowed to provide the status of the Payment Request \n - ACCP (AcceptedCustomerProfile): Preceding check of technical validation was successful. Customer profile check was also successful. \n - ACSC (AcceptedSettlementCompleted): Settlement on the debtor's account has been completed.\n - ACSP (AcceptedSettlementInProcess): All preceding checks such as technical validation and customer profile were successful. Dynamic risk assessment is now also successful and therefore the Payment Request has been accepted for execution.\n - ACTC (AcceptedTechnicalValidation): Authentication and syntactical and semantical validation are successful.\n - ACWC (AcceptedWithChange): Instruction is accepted but a change will be made, such as date or remittance not sent. \n - ACWP (AcceptedWithoutPosting): Payment instruction included in the credit transfer is accepted without being posted to the creditor customer\u2019s account.\n - PART (PartiallyAccepted): A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. \n - RCVD (Received): Payment initiation has been received by the receiving agent.\n - PDNG (Pending): Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed.\n - RJCT (Rejected): Payment request has been rejected.\n \n",
"statusReasonInformation (string)": "ISO20022: Provides detailed information on the status reason.\n\nAPI: Can only be used in status equal to \"RJCT\". Only the following values are allowed:\n- AC01 (IncorectAccountNumber): the account number is either invalid or does not exist\n- AC04 (ClosedAccountNumber): the account is closed and cannot be used\n- AC06 (BlockedAccount): the account is blocked and cannot be used\n- AG01 (Transaction forbidden): Transaction forbidden on this type of account\n- AM18 (InvalidNumberOfTransactions): the number of transactions exceeds the ASPSP acceptance limit\n- CH03 (RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture): The requested execution date is too far in the future\n- CUST (RequestedByCustomer): The reject is due to the debtor: refusal or lack of liquidity\n- DS02 (OrderCancelled): An authorized user has cancelled the order\n- FF01 (InvalidFileFormat): The reject is due to the original Payment Request which is invalid (syntax, structure or values)\n- FRAD (FraudulentOriginated): the Payment Request is considered as fraudulent\n- MS03 (NotSpecifiedReasonAgentGenerated): No reason specified by the ASPSP\n- NOAS (NoAnswerFromCustomer): The PSU has neither accepted nor rejected the Payment Request and a time-out has occurred\n- RR01 (MissingDebtorAccountOrIdentification): The Debtor account and\/or Identification are missing or inconsistent \n- RR03 (MissingCreditorNameOrAddress): Specification of the creditor\u2019s name and\/or address needed for regulatory requirements is insufficient or missing.\n- RR04 (RegulatoryReason): Reject from regulatory reason\n- RR12 (InvalidPartyID): Invalid or missing identification required within a particular country or payment type.\n \n",
"fundsAvailability (boolean)": "indicator that the payment can be covered or not by the funds available on the relevant account\n- true: payment is covered\n- false: payment is not covered\n",
"booking (boolean)": "indicator that the payment can be immediately booked or not\n- true: payment is booked\n- false: payment is not booked\n",
"requestedExecutionDate (string)": "ISO20022: Date at which the initiating party requests the clearing agent to process the payment. \n",
"creditTransferTransaction (array)": "ISO20022: Payment processes required to transfer cash from the debtor to the creditor.\nAPI: Each ASPSP will specify a maxItems value for this field taking into accounts its specificities about payment request handling\n",
"supplementaryData": {
"acceptedAuthenticationApproach (array)": "can only be set by the PISP\nauthentication approaches that are supported by the PISP. The PISP can provide several choices separated by commas. \nREDIRECT: the PSU is redirected by the TPP to the ASPSP which processes identification and authentication\nDECOUPLED: the TPP identifies the PSU and forwards the identification to the ASPSP which processes the authentication through a decoupled device\nEMBEDDED: the TPP identifies the PSU and forwards the identification to the ASPSP which starts the authentication. The TPP forwards one authentication factor of the PSU (e.g. OTP or response to a challenge) \n",
"appliedAuthenticationApproach (string)": "The ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints of the PSU and indicates in this field which approach has been chosen\n",
"scaHint (string)": "can only be set by the PISP\nHint given by the merchant and\/or the PISP about an SCA exemption context\n",
"successfulReportUrl (string)": "URL to be used by the ASPSP in order to notify the PISP of the finalisation of the authentication and consent process in REDIRECT and DECOUPLED approach\n",
"unsuccessfulReportUrl (string)": "URL to be used by the ASPSP in order to notify the PISP of the failure of the authentication and consent process in REDIRECT and DECOUPLED approach \nIf this URL is not provided by the PISP, the ASPSP will use the \"successfulReportUrl\" even in case of failure of the Payment Request processing\n"
}
}
{
"paymentInformationId": "MyPmtInfId",
"creationDateTime": "2018-03-31T13:25:22.527+02:00",
"numberOfTransactions": 1,
"initiatingParty": {
"name": "MyPreferedPisp",
"postalAddress": {
"country": "FR",
"addressLine": [
"18 rue de la DSP2",
"75008 PARIS"
]
},
"organisationId": {
"identification": "12FR5",
"schemeName": "COID",
"issuer": "ACPR"
}
},
"paymentTypeInformation": {
"serviceLevel": "SEPA",
"localInstrument": "INST",
"categoryPurpose": "DVPM"
},
"debtor": {
"name": "MyCustomer",
"postalAddress": {
"country": "FR",
"addressLine": [
"18 rue de la DSP2",
"75008 PARIS"
]
},
"privateId": {
"identification": "FD37G",
"schemeName": "BANK",
"issuer": "BICXYYTTZZZ"
}
},
"creditor": {
"name": "myMerchant",
"postalAddress": {
"country": "FR",
"addressLine": [
"18 rue de la DSP2",
"75008 PARIS"
]
},
"organisationId": {
"identification": "852126789",
"schemeName": "SIREN",
"issuer": "FR"
}
},
"creditorAccount": {
"iban": "YY64COJH41059545330222956960771321"
},
"ultimateCreditor": {
"name": "myPreferedUltimateMerchant",
"postalAddress": {
"country": "FR",
"addressLine": [
"18 rue de la DSP2",
"75008 PARIS"
]
},
"organisationId": {
"identification": "85212678900025",
"schemeName": "SIRET",
"issuer": "FR"
}
},
"purpose": "COMC",
"chargeBearer": "SLEV",
"creditTransferTransaction": [
{
"paymentId": {
"instructionId": "MyInstrId",
"endToEndId": "MyEndToEndId"
},
"requestedExecutionDate": "2016-12-31T00:00:00.000+01:00",
"instructedAmount": {
"currency": "EUR",
"amount": "124.35"
},
"remittanceInformation": [
"MyRemittanceInformation"
]
}
],
"supplementaryData": {
"acceptedAuthenticationApproach": [
"REDIRECT",
"DECOUPLED"
],
"successfulReportUrl": "http:\/\/myPisp\/PaymentSuccess",
"unsuccessfulReportUrl": "http:\/\/myPisp\/PaymentFailure"
}
}
Click to set as parameter value ISO20022 based payment Initiation Request |
