Confirm funds

POST /api/v1/funds-confirmations

oauth

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

User params

account_id Elixir.OpenBanking.Accounts.AccountIdentification

Account identification
instructed_amount Elixir.OpenBanking.Accounts.AmountType

Amount
payee string

The merchant where the card is accepted as information to the PSU
payment_coverage_request_id string

Identification of the payment Coverage Request

Responses

200

Transactions
Hide response attributes Show response attributes object
- request Elixir.OpenBanking.Accounts.PaymentCoverageRequestResource Required
  
  Original request
- result boolean Required
  
  Result of the coverage check

POST /api/v1/funds-confirmations

curl \
 -X POST https://iban.nash.io/api/v1/funds-confirmations \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -H "X-Request-ID: string" \
 -H "Idempotency-Key: string" \
 -d '{"account_id":{"currency":"EUR","iban":"YY64COJH41059545330222956960771321"},"instructed_amount":{"amount":10.35,"currency":"EUR"},"payee":"Payee","payment_coverage_request_id":"MyCoverage123456"}'

Request example

# Headers
X-Request-ID: string
Idempotency-Key: string

# Payload
{
  "account_id": {
    "currency": "EUR",
    "iban": "YY64COJH41059545330222956960771321"
  },
  "instructed_amount": {
    "amount": 10.35,
    "currency": "EUR"
  },
  "payee": "Payee",
  "payment_coverage_request_id": "MyCoverage123456"
}

Request examples

# Headers
X-Request-ID: string
Idempotency-Key: string

# Payload
{
  "payee": "Payee",
  "account_id": {
    "iban": "YY64COJH41059545330222956960771321",
    "currency": "EUR"
  },
  "instructed_amount": {
    "amount": 10.35,
    "currency": "EUR"
  },
  "payment_coverage_request_id": "MyCoverage123456"
}

Response examples (200)

{
  "request": {
    "account_id": {
      "currency": "EUR",
      "iban": "YY64COJH41059545330222956960771321"
    },
    "instructed_amount": {
      "amount": 10.35,
      "currency": "EUR"
    },
    "payee": "Payee",
    "payment_coverage_request_id": "MyCoverage123456"
  },
  "result": true
}

Response examples (200)

{
  "result": true,
  "request": {
    "payee": "Payee",
    "account_id": {
      "iban": "YY64COJH41059545330222956960771321",
      "currency": "EUR"
    },
    "instructed_amount": {
      "amount": 10.35,
      "currency": "EUR"
    },
    "payment_coverage_request_id": "MyCoverage123456"
  }
}