Retrieval of an account overdraft

GET /api/v1/accounts/{account_resource_id}/overdrafts
oauth

Headers

  • X-Request-ID string Required

    Correlation header to be set in a request and retrieved in the relevant response

Path parameters

Responses

  • 200

    HalOverdrafts

    Hide response attributes Show response attributes object
    • _links Elixir.OpenBankingWeb.Schemas.HalLinks Required

      HAL Links

    • overdrafts Elixir.OpenBanking.Accounts.Overdraft Required

      Overdrafts
GET /api/v1/accounts/{account_resource_id}/overdrafts 
curl \
 -X GET https://iban.nash.io/api/v1/accounts/212f9431-f1f0-4808-b3bc-3303d8db91d3/overdrafts \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "X-Request-ID: string"
Response examples (200) 
{
  "_links": {
    "balances": {
      "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/balances"
    },
    "self": {
      "href": "/v1/accounts"
    },
    "transactions": {
      "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/transactions"
    }
  },
  "overdrafts": {
    "allowed_amount": {
      "amount": 10.35,
      "currency": "EUR"
    }
  }
}
Response examples (200) 
{
  "_links": {
    "self": {
      "href": "/v1/accounts"
    },
    "balances": {
      "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/balances"
    },
    "transactions": {
      "href": "/v1/accounts/3e16aaee-eddf-4161-a9ef-b2c2e697ce40/transactions"
    }
  },
  "overdrafts": {
    "allowed_amount": {
      "amount": 10.35,
      "currency": "EUR"
    }
  }
}