Headers
-
X-Request-ID
string Required Correlation header to be set in a request and retrieved in the relevant response
-
Idempotency-Key
string Required Key provided by the API client to ensure idempotency in case of retry of a given request
Body
Required
Payment Initiation Request
-
creation_date_time
string Required Date and time at which a (group of) payment instruction(s) was created by the instructing party.
-
credit_transfer_transaction
Elixir.OpenBanking.Accounts.CreditTransferTransactions Required Credit Transfer Transactions
-
initiating_party
Elixir.OpenBanking.Accounts.PartyIdentification Required Initiating party
-
number_of_transactions
integer Required Number of transactions
-
payment_information_id
string Required Reference assigned by a sending party to unambiguously identify the payment information block within the message.
Format should match the following pattern:
^([a-zA-Z0-9 /-?:().,']{1,36})$. -
payment_type_information
string Required Payment type information
-
supplementary_data
Elixir.OpenBanking.Accounts.SupplementaryData Required Supplementary data
POST
/api/v1/payment-requests
curl \
-X POST https://iban.nash.io/api/v1/payment-requests \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-H "X-Request-ID: string" \
-H "Idempotency-Key: string" \
-d '{"creation_date_time":"2020-02-19T13:56:54.877+01:00","credit_transfer_transaction":[{"beneficiary":{"creditor":{"currency":"EUR","iban":"YY64COJH41059545330222956960771321"},"creditor_account":{"currency":"EUR","iban":"YY64COJH41059545330222956960771321"},"id":"69581b46-bcc4-4361-b471-69205f24bc56","is_trusted":true},"instructed_amount":{"amount":10.35,"currency":"EUR"},"payment_id":{"instruction_id":"MyInstrId3"}}],"initiating_party":{"currency":"EUR","iban":"YY64COJH41059545330222956960771321"},"number_of_transactions":1,"payment_information_id":"MyPmtInfId","payment_type_information":null,"supplementary_data":{"accepted_authentication_approach":["REDIRECT","DECOUPLED"],"successful_report_url":"http://myPisp/PaymentSuccess","unsuccessful_report_url":"http://myPisp/PaymentFailure"}}'
Request example
# Headers
X-Request-ID: string
Idempotency-Key: string
# Payload
{
"creation_date_time": "2020-02-19T13:56:54.877+01:00",
"credit_transfer_transaction": [
{
"beneficiary": {
"creditor": {
"currency": "EUR",
"iban": "YY64COJH41059545330222956960771321"
},
"creditor_account": {
"currency": "EUR",
"iban": "YY64COJH41059545330222956960771321"
},
"id": "69581b46-bcc4-4361-b471-69205f24bc56",
"is_trusted": true
},
"instructed_amount": {
"amount": 10.35,
"currency": "EUR"
},
"payment_id": {
"instruction_id": "MyInstrId3"
}
}
],
"initiating_party": {
"currency": "EUR",
"iban": "YY64COJH41059545330222956960771321"
},
"number_of_transactions": 1,
"payment_information_id": "MyPmtInfId",
"payment_type_information": null,
"supplementary_data": {
"accepted_authentication_approach": [
"REDIRECT",
"DECOUPLED"
],
"successful_report_url": "http://myPisp/PaymentSuccess",
"unsuccessful_report_url": "http://myPisp/PaymentFailure"
}
}
Request examples
# Headers
X-Request-ID: string
Idempotency-Key: string
# Payload
{
"initiating_party": {
"iban": "YY64COJH41059545330222956960771321",
"currency": "EUR"
},
"creation_date_time": "2020-02-19T13:56:54.877+01:00",
"supplementary_data": {
"successful_report_url": "http://myPisp/PaymentSuccess",
"unsuccessful_report_url": "http://myPisp/PaymentFailure",
"accepted_authentication_approach": [
"REDIRECT",
"DECOUPLED"
]
},
"number_of_transactions": 1,
"payment_information_id": "MyPmtInfId",
"payment_type_information": null,
"credit_transfer_transaction": [
{
"payment_id": {
"instruction_id": "MyInstrId3"
},
"beneficiary": {
"id": "69581b46-bcc4-4361-b471-69205f24bc56",
"creditor": {
"iban": "YY64COJH41059545330222956960771321",
"currency": "EUR"
},
"is_trusted": true,
"creditor_account": {
"iban": "YY64COJH41059545330222956960771321",
"currency": "EUR"
}
},
"instructed_amount": {
"amount": 10.35,
"currency": "EUR"
}
}
]
}
Response examples (200)
{
"applied_authentication_approach": "REDIRECT",
"consent_approval": "https://app.nash.io/iban/authorize_payment",
"nonce": "GH6HGH5CGH763"
}
Response examples (200)
{
"nonce": "GH6HGH5CGH763",
"consent_approval": "https://app.nash.io/iban/authorize_payment",
"applied_authentication_approach": "REDIRECT"
}